SIsigmacomputing
Datasets

Migrate a dataset to a data model (Beta)

Migrate a dataset (deprecated) to a data model. The response always includes the dataset's link details and its link and reference counts. For more information on how datasets are migrated to data models, see Migrate a dataset to a data model.

Beta: This documentation describes a public beta feature and is subject to the Beta features disclaimer.

Usage notes

  • Retrieve the datasetId by calling the /v2/datasets endpoint.
  • To skip the migration and return only the dataset's link details and its link and reference counts, pass dryRun: true.

Usage scenarios

  • Plan dataset migration: Pass dryRun: true to review the datasets and connection tables linked to the dataset, and how many documents reference it, before you migrate.
  • Migrate datasets in bulk: If you want to migrate several datasets, you can use this endpoint to programmatically migrate the datasets returned by /v2/datasets with a migrationStatus of not-migrated.
post/v2/datasets/{datasetId}/migrate

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

datasetIdstring required

Request body

shouldUpdateReferencesboolean required

Whether to update references in workbooks that use this dataset to point to the new data model.

destFolderIdstring

Optional destination folder ID where the data model should be created. If not provided, the data model will be created in the same folder as the dataset.

dryRunboolean

If true, do not perform the migration. Only return the link details and the link and reference counts. Defaults to false.

Response

The response body.

dataModelIdstring nullable required

ID of the newly-created data model. Null when dryRun is true.

linkCountnumber double required

Number of links the dataset has to other datasets.

referenceCountnumber double required

Number of documents that reference this dataset.

Changes

No recorded changes to this operation across all 1 revision of this API.