perpetual dataset
Manage datasets.
perpetual dataset create
Create a new dataset (table).
perpetual dataset create [flags]
Changes: Stages its writes into a changeset.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--name | string | Required | Dataset (table) name. |
--space-id | string | Required | Space ID the table belongs to. |
--query | string | Required | Hamelin query that defines the table. |
--deploy | boolean | Optional | Whether to deploy the table (default: false). |
--max-latency | string | Optional | Maximum latency (MAX_1H, MAX_1D). |
--partitioning-column | string | Optional | Column to partition the table by. |
--sorted-by-column | string | Optional | Column to sort the table by. |
--retention-days | string | Optional | Data retention in days. |
--starts-at | string | Optional | Start timestamp (ISO 8601). |
--archived | boolean | Optional | Whether the table is archived. |
--changeset | string | Optional | Changeset (CHG_*) to stage this create into — REQUIRED (the CLI makes no live changes). |
Also accepts the global flags, including the sign-in flags.
perpetual dataset get
Get dataset details including schema and columns.
perpetual dataset get <id>
Changes: Stages nothing.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Arguments
| Argument | Required | Description |
|---|---|---|
id | Required | Dataset (table) ID. |
Also accepts the global flags, including the sign-in flags.
perpetual dataset list
List datasets (tables, views, unions, connectors).
perpetual dataset list [flags]
Changes: Stages nothing.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--top | string | Optional | Items per page (server default 100). |
--skip | string | Optional | Number of items to skip. |
--all | boolean | Optional | Fetch every page (1000 items per request). |
Also accepts the global flags, including the sign-in flags.
perpetual dataset status
Show deployment status (every dataset, or the given ids).
perpetual dataset status [ids] [flags]
Changes: Stages nothing.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Arguments
| Argument | Required | Description |
|---|---|---|
ids | Optional | Dataset ids. |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--status | string, repeatable | Optional | Only these deployment statuses, comma-separated or repeated: UNDEPLOYED, DEPLOYED, FAILED, DEGRADED, DEPLOY_PENDING, DEPLOY_IN_PROGRESS, UPDATE_PENDING, UPDATE_IN_PROGRESS, REFRESH_IN_PROGRESS, ARCHIVED, CLEANUP_PENDING, CLEANUP_IN_PROGRESS. |
--space | string, repeatable | Optional | Only these spaces: SPC_* ids, comma-separated or repeated (a filter; PERPETUAL_SPACE_ID does not apply). |
--top | string | Optional | Items per page (server default 100). |
--skip | string | Optional | Number of items to skip. |
--all | boolean | Optional | Fetch every page (1000 items per request). |
Also accepts the global flags, including the sign-in flags.
perpetual dataset update
Update a dataset (table).
perpetual dataset update <id> [flags]
Changes: Stages its writes into a changeset.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Arguments
| Argument | Required | Description |
|---|---|---|
id | Required | Dataset (table) ID. |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--name | string | Optional | New table name. |
--query | string | Optional | New Hamelin query. |
--deploy | boolean | Optional | Whether to deploy the table. |
--max-latency | string | Optional | New maximum latency (MAX_1H, MAX_1D). |
--partitioning-column | string | Optional | New partitioning column. |
--sorted-by-column | string | Optional | New sorted-by column. |
--retention-days | string | Optional | New data retention in days. |
--starts-at | string | Optional | New start timestamp (ISO 8601). |
--archived | boolean | Optional | Whether the table is archived. |
--base-version | string | Optional | Expected current version for optimistic concurrency. |
--changeset | string | Optional | Changeset (CHG_*) to stage this update into — REQUIRED (the CLI makes no live changes). |
Also accepts the global flags, including the sign-in flags.
perpetual dataset wait
Wait until a dataset reaches a deployment status (requires --timeout).
perpetual dataset wait <id> [flags]
Changes: Stages nothing.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Arguments
| Argument | Required | Description |
|---|---|---|
id | Required | Dataset id. |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--timeout | string | Optional | Give up after this long, e.g. 90s, 10m, 1h (required; at most 24h). |
--until | string | Optional | Status to wait for (default DEPLOYED): DEPLOYED, FAILED, DEGRADED, UNDEPLOYED, ARCHIVED. One of DEPLOYED, FAILED, DEGRADED, UNDEPLOYED, ARCHIVED. |
--version | string | Optional | Wait for this committed version (default: the version committed when the wait starts). |
Also accepts the global flags, including the sign-in flags.
Perpetual CLI 0.5.0