From a2499e3a53a3591a7e91cfcd2736fc2846c8d5e1 Mon Sep 17 00:00:00 2001 From: Eddie A Tejeda Date: Thu, 2 Apr 2026 19:56:48 -0700 Subject: [PATCH] docs(skill): document results list, connections refresh, queries update flags - Add connections refresh for stale catalog after source DDL changes. - Expand query results: list stored results (paginated) and get by ID. - Document queries update --category and --table-size (empty string clears). Made-with: Cursor --- skills/hotdata-cli/SKILL.md | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/skills/hotdata-cli/SKILL.md b/skills/hotdata-cli/SKILL.md index 78936e2..152bef0 100644 --- a/skills/hotdata-cli/SKILL.md +++ b/skills/hotdata-cli/SKILL.md @@ -45,6 +45,13 @@ hotdata connections [-w ] [-o table|json|yaml] - `list` returns `id`, `name`, `source_type` for each connection. - Pass a connection ID to view details (id, name, source type, table counts). +### Refresh connection schema +``` +hotdata connections refresh [-w ] +``` +- Refreshes the connection’s catalog so new or changed tables and columns appear in `hotdata tables list` and queries. +- Use after DDL or other changes in the source database when the workspace view is stale. + ### Create a Connection #### Step 1 — Discover available connection types @@ -177,26 +184,36 @@ hotdata query status [-o table|json|csv] - Exit codes for `query status`: `0` = succeeded, `1` = failed, `2` = still running (poll again). - **When a query returns a `query_run_id`, use `query status` to poll rather than re-running the query.** -### Get Query Result +### Query results +#### List stored results +``` +hotdata results list [-w ] [--limit ] [--offset ] [-o table|json|yaml] +``` +- Lists recent stored query results with `id`, `status`, and `created_at`. +- Results are paginated; when more are available, the CLI prints a hint with the next `--offset`. +- Use a row’s `id` with `hotdata results ` below. + +#### Get result by ID ``` hotdata results [-w ] [-o table|json|csv] ``` - Retrieves a previously executed query result by its result ID. -- Query results include a `result-id` in the footer (e.g. `[result-id: rslt...]`). -- **Always use this command to retrieve past query results rather than re-running the same query.** Re-running queries wastes resources and may return different results. +- Query output also includes a `result-id` in the footer (e.g. `[result-id: rslt...]`). +- **Always use `results list` / `results ` to retrieve past query results rather than re-running the same query.** Re-running queries wastes resources and may return different results. ### Saved Queries ``` hotdata queries list [--limit ] [--offset ] [--format table|json|yaml] hotdata queries [--format table|json|yaml] hotdata queries create --name "My Query" --sql "SELECT ..." [--description "..."] [--tags "tag1,tag2"] [--format table|json|yaml] -hotdata queries update [--name "New Name"] [--sql "SELECT ..."] [--description "..."] [--tags "tag1,tag2"] [--format table|json|yaml] +hotdata queries update [--name "New Name"] [--sql "SELECT ..."] [--description "..."] [--tags "tag1,tag2"] [--category "..."] [--table-size "..."] [--format table|json|yaml] hotdata queries run [--format table|json|csv] ``` - `list` shows saved queries with name, description, tags, and version. - View a query by ID to see its formatted and syntax-highlighted SQL. - `create` requires `--name` and `--sql`. Tags are comma-separated. -- `update` accepts any combination of fields to change. +- `update` accepts any combination of `--name`, `--sql`, `--description`, and `--tags` to change those fields. +- `update` also supports `--category` and `--table-size` for metadata; pass an **empty string** for either flag to clear its value. - `run` executes a saved query and displays results like the `query` command. - **Use `queries run` instead of re-typing SQL when a saved query exists.**