SaveDatabaseQuery
Save a read-only SELECT as a live question and get back the block that shows its answer.
Starter documentation. Features and account details may differ from this deployment.
SaveDatabaseQuery
Save a read-only SELECT as a live question and get back the block that shows its answer. Paste the returned markdown verbatim into your reply or a CreateDocument document, or quote it verbatim in EditDocument's instructions, and it renders as a live number, table, or chart that re-runs for whoever views it, with their permissions, so it stays current as the data changes.
Use it whenever the user asks a question about their data or asks for a chart. Run the SELECT with QueryDatabase first to check it returns what you expect, then save exactly that SQL. The SQL is QueryDatabase's dialect, described there, limited to one SELECT.
displayMode:scalarfor one number (a single COUNT/SUM/AVG),tablefor rows,barto compare categories,linefor a trend over an ordered column,areafor a trend whose series add up to a whole,scatterto plot one numeric column against another,piefor shares of a whole.chart(bar/line/area/scatter/pie):xis the label column andythe numeric result columns, named exactly as the result columns are; alias aggregates (COUNT(*) AS invites) so they have stable names.colornames a result column whose values split oneyseries into one series per value (e.g. invites per party colored by status);stackstacks bar or area series instead of setting them side by side.- Pass
databaseIdso the question resolves against that database's tables.
Saved questions never change, and a block you write or edit yourself does not work. To change one, save a new one and use its new block. EditDocument can restyle a block already in a document (chart type, title, height) and switch an embedded database to another table or view by its tableId/viewId.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
databaseId | string | No | Id of the database the question is about, from ListDatabases. Its tables win when another database has a table of the same name. |
sql | string | Yes | The SELECT to save, exactly as it ran with QueryDatabase. |
title | string | Yes | Short heading shown with the answer, e.g. "Invites per party". |
displayMode | "table" | "scalar" | "bar" | "line" | "area" | "scatter" | "pie" | Yes | Presentation hint for a query result; it does not affect SQL execution. |
chart | ToolChart | No | Chart configuration for bar, line, area, scatter and pie. |
prompt | string | No | The question as the user asked it. Defaults to the title; shown when someone edits the question. |