fix(skills): update --description to --name in databases commands#123
Conversation
Align `databases run` with `databases create`, which already uses --name for the catalog alias of the auto-created database.
Align skill docs with the CLI change in #122: databases create and databases run both use --name, not --description.
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
| hotdata databases <id_or_description> [--workspace-id <workspace_id>] [--output table|json|yaml] | ||
| hotdata databases delete <id_or_description> [--workspace-id <workspace_id>] | ||
| hotdata databases run [--database <id>] [--description <label>] [--schema public] [--table <table> ...] [--expires-at <duration|timestamp>] [--workspace-id <workspace_id>] <cmd> [args...] | ||
| hotdata databases run [--database <id>] [--name <catalog_name>] [--schema public] [--table <table> ...] [--expires-at <duration|timestamp>] [--workspace-id <workspace_id>] <cmd> [args...] |
There was a problem hiding this comment.
nit: this rename was applied here but README.md still documents the old flag for the same command and was missed — README.md:140 shows hotdata databases run [--database <id>] [--description <label>] ... and README.md:151 says "auto-create a scratch one using --description / --schema / ...". Since databases run no longer accepts --description, the README now documents a flag that errors. Update both for consistency. (not blocking)
| - `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. | ||
| - `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. | ||
| - `set` — saves `<id_or_description>` as the active database. Subsequent `databases tables` and `context` commands use it automatically. | ||
| - `<id_or_description>` — inspect one database (id, description, expires_at). |
There was a problem hiding this comment.
super nit: while you're aligning terminology with the --name rename, the surrounding placeholders here still use <id_or_description> (lines 186, 191, 192, 193, 207) and this line lists the output field as description — but databases get prints name:, not description: (src/databases.rs:417). Consider <id_or_name> and (id, name, expires_at) for consistency. (not blocking)
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
1 participant
Summary
hotdata/SKILL.mdandhotdata-analytics/SKILL.mdto reflect the--description→--namerename from fix(databases): rename --description to --name in databases run #122databases createanddatabases runRelated
Follows #122.