Dashboard
The Dashboard provides a visual overview of your database through customizable widgets. Each connection can have its own dashboard with real-time metrics and charts.
Accessing the Dashboard
- Right-click a connected database in the sidebar and select "Dashboard"
- A new Dashboard tab opens for that specific connection
- Use the Command Palette and search for "Dashboard"
Dashboard Features
Connection-Specific
Each dashboard is tied to a specific database connection. The widgets display data relevant to that connection's database.
Plugin-Powered Widgets
Dashboard widgets are powered by the plugin system:
- Install dashboard plugins to add new widgets
- Built-in plugins provide essential monitoring widgets
- Create custom widgets for your specific needs
Chart Types
| Chart Type | Description | Best For |
|---|---|---|
| Number | Single large number display | KPIs, row counts, connection counts |
| Bar | Vertical bar chart | Comparing categories, table sizes |
| Line | Line chart with data points | Trends over time, query rates |
| Table | Tabular data display | Detailed breakdowns, top-N lists |
Auto-Refresh
- Widgets can be configured to auto-refresh at a set interval
- Each widget can have its own refresh rate
- Manual refresh is also available
Database Type Filter
- Widgets can be filtered by database type
- A PostgreSQL monitoring widget won't appear for MySQL connections
- Ensures relevant metrics for each database engine
Built-In Dashboard Widgets
PostgreSQL Monitor Plugin
The built-in "PostgreSQL Monitor" plugin provides:
- Active connections count
- Database size
- Table sizes (top N)
- Active queries
- Cache hit ratio
- Transaction rates
Creating Custom Widgets
Create your own dashboard widgets through the plugin system:
- Go to Settings > Plugins
- Create a new Dashboard plugin
- Define widget configuration:
- Name: Widget display name
- SQL Query: The query that powers the widget
- Chart Type: number, bar, line, or table
- Refresh Interval: How often to refresh (in seconds)
- Database Type Filter: Which database types this widget applies to
Widget SQL Queries
Widget queries should return data in the expected format for the chart type:
- Number: Return a single row with a single numeric column
- Bar: Return rows with a label column and a value column
- Line: Return rows with a date/time column and a value column
- Table: Return any result set to display as a table
Dashboard Layout
- Widgets are arranged in a responsive grid
- Each widget shows its title, chart, and last refresh time
- Error states are displayed inline if a widget query fails