Skip to content

Dataset commands: update, delete

The Dataset Verbs update, delete as CLI commands, with inputs, result, refusals and an example.

Reference for Dataset, one group of Dataset commands.

Dataset.update

Changes the given properties of a Dataset. Verb page.

Text
npx startup-builder do Dataset.update --json '<input>' [--try | --send | --do]

Emits Dataset.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Dataset.
namestringThe name of the Product.
promisetextWhat the Customer can rely on.
recordsintegerHow many Things it holds.
refreshedAtdatetimeWhen its Sources were last read.

Returns

OutputTypeRequiredDescription
datasetDatasetrequiredThe Dataset.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
npx startup-builder do Dataset.update --json '{"id":"dataset_UDQXk0KsJB","records":1}'

Dataset.delete

Deletes a Dataset: a soft delete that keeps its history, undone by Thing.restore. Verb page.

Text
npx startup-builder do Dataset.delete --json '<input>' [--try | --send | --do]

Emits Dataset.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Dataset.

Returns

OutputTypeRequiredDescription
datasetDatasetrequiredThe Dataset.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
npx startup-builder do Dataset.delete --json '{"id":"dataset_UDQXk0KsJB"}'