Notebooks and dashboards
Both are saved per connection and reopen with your tabs. They live on your Mac and are not synced.
Notebooks
A notebook is a page of SQL cells and Markdown cells, good for an investigation you want to keep or a set of queries you run together.
Create one from the + menu in the tab bar: New notebook, or pick an existing one under Open notebook.
- Add cells with SQL cell and Markdown cell at the bottom, or Add SQL below and Add Markdown below from a cell's … menu. The same menu moves and deletes cells.
- Run a SQL cell with its play button. With several statements in a cell, you see the last result.
- Show chart turns a SQL cell's result into a chart; Show table goes back.
- Double-click a Markdown cell to edit it; ⌘ S or Done renders it.
- Run all starts every SQL cell. They run at the same time, not one after another, so do not rely on one cell's changes in the next.
Cells follow the connection's rules: read-only blocks writes, and the timeout and row cap apply. The notebook saves itself as you type; the result of each cell is not saved, only the query.
Dashboards
A dashboard is a grid of tiles. Each tile is a query shown as a chart, a single stat or a table.
Open one from the + menu in the tab bar, from Dashboards in the sidebar, or from Your dashboards in the connection manager.
Tiles
Add a tile opens the tile editor: give it a title, write the SQL, click Run to preview, then pick how to show it:
- Table: the rows.
- Stat: one value, from the first row of the column you pick.
- Chart: bar, line, area, scatter or pie, with a label column and a value column.
Each tile has Run, Edit tile and Remove tile.
Parameters
A :name in any tile's SQL adds a field to the bar at the top. Fill it in and click Apply; every tile that uses it runs again.
Refreshing
- Run on open runs every tile when you open the dashboard.
- The refresh menu reruns everything every 10s, 30s, 1m or 5m. Refreshing pauses while the tab is in the background and never starts a tile that is still running.
- Refresh all tiles reruns them now.
Dashboards only read
A tile can only run reads; a write is refused. On a Production connection the dashboard waits for you to click Run all the first time, and each tile is stopped after 30 seconds.
