Skip to main content

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​

FlagTypeRequiredDescription
--namestringRequiredDataset (table) name.
--space-idstringRequiredSpace ID the table belongs to.
--querystringRequiredHamelin query that defines the table.
--deploybooleanOptionalWhether to deploy the table (default: false).
--max-latencystringOptionalMaximum latency (MAX_1H, MAX_1D).
--partitioning-columnstringOptionalColumn to partition the table by.
--sorted-by-columnstringOptionalColumn to sort the table by.
--retention-daysstringOptionalData retention in days.
--starts-atstringOptionalStart timestamp (ISO 8601).
--archivedbooleanOptionalWhether the table is archived.
--changesetstringOptionalChangeset (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​

ArgumentRequiredDescription
idRequiredDataset (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​

FlagTypeRequiredDescription
--topstringOptionalItems per page (server default 100).
--skipstringOptionalNumber of items to skip.
--allbooleanOptionalFetch 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​

ArgumentRequiredDescription
idsOptionalDataset ids.

Flags​

FlagTypeRequiredDescription
--statusstring, repeatableOptionalOnly 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.
--spacestring, repeatableOptionalOnly these spaces: SPC_* ids, comma-separated or repeated (a filter; PERPETUAL_SPACE_ID does not apply).
--topstringOptionalItems per page (server default 100).
--skipstringOptionalNumber of items to skip.
--allbooleanOptionalFetch 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​

ArgumentRequiredDescription
idRequiredDataset (table) ID.

Flags​

FlagTypeRequiredDescription
--namestringOptionalNew table name.
--querystringOptionalNew Hamelin query.
--deploybooleanOptionalWhether to deploy the table.
--max-latencystringOptionalNew maximum latency (MAX_1H, MAX_1D).
--partitioning-columnstringOptionalNew partitioning column.
--sorted-by-columnstringOptionalNew sorted-by column.
--retention-daysstringOptionalNew data retention in days.
--starts-atstringOptionalNew start timestamp (ISO 8601).
--archivedbooleanOptionalWhether the table is archived.
--base-versionstringOptionalExpected current version for optimistic concurrency.
--changesetstringOptionalChangeset (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​

ArgumentRequiredDescription
idRequiredDataset id.

Flags​

FlagTypeRequiredDescription
--timeoutstringOptionalGive up after this long, e.g. 90s, 10m, 1h (required; at most 24h).
--untilstringOptionalStatus to wait for (default DEPLOYED): DEPLOYED, FAILED, DEGRADED, UNDEPLOYED, ARCHIVED. One of DEPLOYED, FAILED, DEGRADED, UNDEPLOYED, ARCHIVED.
--versionstringOptionalWait 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