Skip to content

Commit 0d7e04d

Browse files
authored
fix(skills): update --description to --name in databases commands (#123)
* fix(databases): rename --description to --name in databases run Align `databases run` with `databases create`, which already uses --name for the catalog alias of the auto-created database. * fix(skills): update --description to --name in databases commands Align skill docs with the CLI change in #122: databases create and databases run both use --name, not --description. --------- Co-authored-by: Eddie A Tejeda <669988+eddietejeda@users.noreply.github.com>
1 parent 66ca52a commit 0d7e04d

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

skills/hotdata-analytics/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ hotdata results <result_id> [--workspace-id <workspace_id>] [--output table|json
8989
Or managed parquet:
9090

9191
```bash
92-
hotdata databases create --description "analytics" --table slice
92+
hotdata databases create --name analytics --table slice
9393
hotdata databases set <returned-id>
9494
hotdata databases tables load slice --file ./slice.parquet
9595
```

skills/hotdata/SKILL.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -187,11 +187,11 @@ hotdata connections create \
187187

188188
```
189189
hotdata databases list [--workspace-id <workspace_id>] [--output table|json|yaml]
190-
hotdata databases create [--description <label>] [--table <table> ...] [--schema public] [--expires-at <duration|timestamp>] [--workspace-id <workspace_id>] [--output table|json|yaml]
190+
hotdata databases create [--name <catalog_name>] [--table <table> ...] [--schema public] [--expires-at <duration|timestamp>] [--workspace-id <workspace_id>] [--output table|json|yaml]
191191
hotdata databases set <id_or_description>
192192
hotdata databases <id_or_description> [--workspace-id <workspace_id>] [--output table|json|yaml]
193193
hotdata databases delete <id_or_description> [--workspace-id <workspace_id>]
194-
hotdata databases run [--database <id>] [--description <label>] [--schema public] [--table <table> ...] [--expires-at <duration|timestamp>] [--workspace-id <workspace_id>] <cmd> [args...]
194+
hotdata databases run [--database <id>] [--name <catalog_name>] [--schema public] [--table <table> ...] [--expires-at <duration|timestamp>] [--workspace-id <workspace_id>] <cmd> [args...]
195195
hotdata databases <id> run <cmd> [args...]
196196
197197
# Dot-notation shorthand for load: database.table or database.schema.table
@@ -203,20 +203,20 @@ hotdata databases tables delete <table> [--database <id_or_desc>] [--schema publ
203203
```
204204

205205
- `list` — all managed databases in the workspace.
206-
- `create` — creates a new managed database. `--description` is an optional human-readable label (databases are addressed by id, not description). `--expires-at` accepts relative durations (`24h`, `7d`, `90m`) or an RFC 3339 timestamp; defaults to `24h` when omitted. Repeat `--table` to declare tables up front.
206+
- `create` — creates a new managed database. `--name` is an optional catalog alias used in queries (`SELECT … FROM <name>.public.<table>`); must be `[a-z_][a-z0-9_]*`. `--expires-at` accepts relative durations (`24h`, `7d`, `90m`) or an RFC 3339 timestamp; defaults to `24h` when omitted. Repeat `--table` to declare tables up front.
207207
- `set` — saves `<id_or_description>` as the active database. Subsequent `databases tables` and `context` commands use it automatically.
208208
- `<id_or_description>` — inspect one database (id, description, expires_at).
209209
- `delete` — removes the managed database; clears the active-database config if it matched.
210210
- `load` — shorthand with dot notation (`database.table` or `database.schema.table`). Schema defaults to `public`.
211211
- `tables list` — lists tables with `TABLE` (`<database_id>.<schema>.<table>`), `SYNCED`, `LAST_SYNC`. Uses active database when `--database` is omitted.
212212
- `tables load` — uploads a local parquet file (`--file`), a remote parquet URL (`--url`), or a pre-staged upload (`--upload-id`) and publishes with **replace** mode.
213213
- `tables delete` — drops a table from the managed database.
214-
- `run` — mints a database-scoped JWT (via `POST /v1/auth/database`) and execs `<cmd>` with `HOTDATA_DATABASE_TOKEN`, `HOTDATA_DATABASE_REFRESH_TOKEN`, `HOTDATA_DATABASE`, `HOTDATA_WORKSPACE`, and `HOTDATA_API_URL` injected. Pass a database id as a group positional (`hotdata databases <id> run ...`, sandbox-style) or via `--database <id>`; omit both to auto-create a scratch database using `--description` / `--schema` / `--table` / `--expires-at`. Use this to launch an agent or child process whose API access is scoped to a single database. The minted JWT carries `database`, `workspaces`, `permissions:["read","write"]`, `source:"database_token"`. The session is persisted at `~/.hotdata/database_session.json` (mode `0600`); the child's exit code is propagated.
214+
- `run` — mints a database-scoped JWT (via `POST /v1/auth/database`) and execs `<cmd>` with `HOTDATA_DATABASE_TOKEN`, `HOTDATA_DATABASE_REFRESH_TOKEN`, `HOTDATA_DATABASE`, `HOTDATA_WORKSPACE`, and `HOTDATA_API_URL` injected. Pass a database id as a group positional (`hotdata databases <id> run ...`, sandbox-style) or via `--database <id>`; omit both to auto-create a scratch database using `--name` / `--schema` / `--table` / `--expires-at`. Use this to launch an agent or child process whose API access is scoped to a single database. The minted JWT carries `database`, `workspaces`, `permissions:["read","write"]`, `source:"database_token"`. The session is persisted at `~/.hotdata/database_session.json` (mode `0600`); the child's exit code is propagated.
215215

216216
Example:
217217

218218
```
219-
hotdata databases create --description "sales" --table orders
219+
hotdata databases create --name sales --table orders
220220
hotdata databases set <returned-id>
221221
hotdata databases tables load orders --file ./orders.parquet
222222
hotdata query "SELECT count(*) FROM <database_id>.public.orders"

0 commit comments

Comments
 (0)