Dashboards
Table of contents
Dashboards tool allows DBAs and programmers to quickly identify performance, disk space issues, the number of connections and other important KPIs associated with a single database connection. To learn more about database connections, see Database Connections.
By default, DBeaver is delivered with a number of predefined sets of dashboards for such databases as PostgreSQL, MySQL, Oracle and Exasol. Custom dashboards are also supported. To learn more about custom dashboards, see the Managing Dashboards section below.
Managing Dashboards Panel
Dashboards panel is a collection of real-time dashboards, which are dashboards that are updated continuously. Dashboards displayed on the dashboards panel are actually a combination of continuously run SQL SELECT queries and charts continuously built on the data fetched.
Opening Dashboard Panel
To open the dashboards panel press the Open Dashboard button 
on the main toolbar. The default configuration of the dashboards panel for the current database connection will appear. To learn more about database connections, see Database Connections article.
You can also right-click a connection name in the Database Navigator editor and select the Open Dashboard menu option or use the keyboard shortcut Ctrl+Alt+Shift+B and the dashboards panel will be opened.
The following controls are available on the dashboards panel toolbar:
| Icon | Name | Description |
|---|---|---|
 | Settings | Opens dashboard's configuration. |
 | Add dashboard | Adds dashboard to the dashboard panel. |
 | Remove dashboard | Removes dashboard from the dashboard panel. |
 | Reset dashboards | Restarts dashboard's calculation. |
Adding Dashboards
To add a dashboard to the dashboards panel, press Add dashboard button on the dashboards panel's toolbar, choose one of the dashboards from the list of available dashboards and press the Add button.
Note: Different databases have different sets of predefined dashboards. DBeaver is delivered with sets of predefined dashboards for such databases as PostgreSQL SQL, MySQL, Oracle, and Exasol. It is also possible to create new custom dashboards, for more details see Managing Dashboards.
You can also add a dashboard by right-click in any place of the dashboards panel and then select the Add dashboard menu option.
Removing Dashboards
To remove a dashboard from the dashboards panel, click on the dashboard you want to remove and press button Remove dashboard in the dashboards panel toolbar or select Remove dashboard option in the dashboard's context menu.
Resetting Dashboards
If you want to restart the dashboard's calculation you can reset it.
You can reset all the dashboards displayed on the dashboards panel by a single click on Reset dashboards button on the dashboard panel's toolbar.
To reset a particular dashboard right-click on it and select Reset dashboards menu option or left click a dashboard and press Reset dashboards button on the dashboards panel's toolbar.
Changing Dashboard Representation
To adjust dashboard representation settings, right click on a dashboard and select the Settings menu option, then, in the opened dialog change the parameters you want.
The following dashboard representation parameters can be adjusted:
| Parameter | Description |
|---|---|
| Name | Defines a name of a dashboard. |
| Description | Defines dashboard's description. Use this field to make it easy to understand what kind of information the dashboard represents. |
| Update periods(ms) | Defines how often dashboard's rendering should be updated. The default value is 1000 ms. |
| Maximum items | Defines maximum number of fetched items. The default value is 300. |
| View | Defines visual representation of the dashboard. The following options are available: Bar, Pie, Time series. |
| Show legend | If this check-box is selected, the legend will be displayed on the dashboard. |
| Show grid | If this check-box is selected, the grid will be displayed on the dashboard. |
| Show domain axis | If this check-box is selected, the domain axis will be displayed on the dashboard. |
| Show range axis | If this check-box is selected, the range axis will be displayed on the dashboard. |
Adjusting Dashboard Configuration
To adjust dashboard's configuration settings right-click on a dashboard, select the Settings menu option, then, in the opened dialog box press the Configuration menu option.
The following dashboard parameters can be configured:
| Parameter | Description |
|---|---|
| ID | Defines dashboard's ID. Make sure that ID has numeric values in it. |
| Name | Defines dashboard name. |
| Database | Defines the database driver. To learn more about database drivers, see Database Drivers. |
| Data type | Defines the data type. The following options are available: timeseries (the default option) and statistics. Select timeseries type if you want to track the actual value returned by the server. Select the statistics type if your dashboard will show historical data. |
| Calc type | Defines how the data should be calculated. The following options are available: value (the default option) and delta. Select value if you are interested in the current value. Select delta if you want to track the difference between the current value and the previous one. This may be very useful when you work with statistics data, for example. |
| Value type | Defines the value to be shown on the range domain. The following options are available: decimal (the default option), integer, percent, bytes. Choose the value type in accordance with your data, for example, memory usage is convenient to be tracked in KBytes. |
| Interval | Defines time interval to be shown on the domain axis. The following time intervals are available: millisecond(the default option), second, minute, hour, day, week, month, year. |
| Fetch type | Defines whether the query should fetch data from rows or columns. |
| Description | Defines the description of a dashboard. Use this field to make it easy to understand what kind of information the dashboard represents. |
| Queries | Defines an SQL query whose fetched data will be used to build the chart displayed on the dashboard. |
| Default view | Defines the default visual representation of a dashboard on the dashboard panel. The following options are available: Bar, Pie, Time series(the default option). |
| Update period(ms) | Defines how often the dashboard's rendering should be updated. |
| Maximum items | Defines the maximum number of items to be fetched for the dashboard. |
Note: Predefined dashboards are read-only and cannot be re-configured, but you can copy them and use them templates to create new dashboards with any query and other settings. To learn about creating new dashboards, see the Managing Dashboards section.
Setting Connection Preferences
By default, if there is no active connection to the database and you open its dashboards panel, all the dashboards on the panel will be empty.
You can force a database connection on the dashboard panel's activation by pressing the Settings button on the dashboards panel's toolbar and then selecting the Connect on activation check-box.
Detaching Dashboards
If you have several monitors and would like to place a dashboard into a separate screen, you can either detach the whole dashboards panel or a single dashboard, and drag-and-drop them to any place you want.
To detach the whole dashboard panel, right click on the dashboard's tab name and select the Detachmenu option.
To detach a single dashboard, double left click over it. You can also right click the dashboard and then, select the View Dashboard menu option, the dashboard will be detached from the panel and you will be able to move it to any place on your screen.
Changing Dashboard View
You can change the representation of a dashboard and view it as a Pie, Bar or Time series. To change the dashboard view, right click on it and select the View as menu option.
Copying Dashboards to Clipboard
To copy a dashboard onto the clipboard, right click on the dashboard and use the Copy to Clipboard menu option. The screenshot of the dashboard will be placed onto the clipboard.
Saving Dashboards
If you want to save a screenshot of a dashboard locally in PNG format, right click on it and select the Save as ... option in the context menu displayed.
Printing Dashboards
If you want to print out a screenshot of a dashboard, right-click the dashboard to be printed and select the Print… option.
Zooming
For Time series and Bar dashboard representations the following zooming options are available on the dashboard's context menu:
- Zoom In
- Zoom Out
- Zoom Reset
Managing Dashboards
You can extend the list of predefined default dashboards by creating your own custom dashboards. This section describes dashboards' list management.
Creating Dashboards
You can create a new custom dashboard either from scratch or from any existing dashboards.
To create a dashboard from scratch
- Press the Settings button on the dashboards panel toolbar.
- In the opened dialog box click the Manage... button.
- In the Manage dashboards window click the New dashboard... button.
- Set up all configuration parameters as required and press OK. To learn more about the dashboard's configuration parameters, see Adjusting Dashboard Configuration.
To create a dashboard from a template
- Press the Settings button on the dashboards panel toolbar.
- In the opened dialog box click the Manage... button.
- In the Manage dashboards window select any of the existing dashboards from the list and click Copy.
- Adjust all configuration parameters as required and press OK. To learn more about the dashboard's configuration parameters, see Adjusting Dashboard Configuration.
Editing Dashboards
If you need to change the dashboard's name , ID or any other configuration setting, you can edit a dashboard.
Note: Only custom dashboards can be edited, predefined dashboards are read-only, but you can use them as templates and create a custom dashboard whose parameters will be editable. To learn how to create dashboards from templates, see Creating Dashboards.
To edit dashboard's configuration
- Press the Settings button on the dashboards panel toolbar.
- In the opened dialog box click the Manage... button.
- In the Manage dashboards window select any of the custom dashboards from the list and click Edit....
- Adjust all configuration parameters as required and press OK. To learn more about the dashboard's configuration parameters, see Adjusting Dashboard Configuration.
Deleting Dashboards
Note: Predefined dashboards cannot be deleted, but any custom dashboards can be deleted.
If you want to delete a dashboard, follow the steps described below.
To delete a dashboard
- Press the Settings button on the dashboards panel toolbar.
- In the opened dialog box click Manage... dashboards.
- In the Manage dashboards window select any of the custom dashboards from the list and click Delete.
