Save Query
Save a SQL query to a Draxlr database.
Tool: draxlr_save_query
Saves a SQL query to a database so it appears under the database's saved queries. You can either pass the sql directly (it will be executed and then saved) or pass a queryId returned by Run Query.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
databaseId | string | Yes | The database id the query belongs to |
name | string | Yes | Name for the saved query |
sql | string | No | The SQL to save. Provide either this or queryId |
queryId | string | No | A queryId from Run Query. Provide either this or sql |
description | string | No | Optional description for the saved query |
allowDuplicateName | boolean | No | Allow saving even if a query with the same name already exists |
Provide sql or queryId:
You must supply at least one of sql or queryId. If both are omitted, the command returns an error.
Example
"Save this query as Orders by status on my Sales DB."
Arguments:
{
"databaseId": "665f1c2a9b1e4a0012ab34cd",
"name": "Orders by status",
"sql": "SELECT status, COUNT(*) AS orders FROM orders GROUP BY status",
"description": "Order counts grouped by status"
}
Response
{
"message": "Saved query \"Orders by status\".",
"query": {
"_id": "6690aa11bc2e4a0012cd77ee",
"name": "Orders by status",
"description": "Order counts grouped by status"
},
"url": "https://app.draxlr.com/explore/665f1c2a9b1e4a0012ab34cd/6690aa11bc2e4a0012cd77ee"
}
| Field | Description |
|---|---|
message | Confirmation message |
query | The saved query, including its _id |
url | A link to view the saved query in Draxlr |