Datasets

Apply an upload to a dataset

Step two of the upload flow. Reads the file you uploaded and folds it into the dataset's current parquet.

  • append — concatenate the new rows onto the existing data. Columns are unioned, so a schema mismatch produces nulls rather than an error.
  • replace — discard the existing data and use the upload as the new dataset.
  • delete — deletes the entire dataset: every S3 object under its prefix, the DynamoDB record and the team link. mutation_data_url is ignored. DELETE /dataset/{dataset_id} does exactly the same thing and says so in its name; prefer it.

mutation_data_url is the presigned URL with its query string removed (or any s3:// or https://<bucket>.s3.amazonaws.com/<key> URL). .csv, .tsv and .parquet are recognised by extension.

On success a dataset_update trigger is posted so workflows consuming this dataset can react.

post/dataset/{dataset_id}/mutation

Request

  • Base URL: https://api.indexone.io
  • URL: https://api.indexone.io/dataset/{dataset_id}/mutation
  • Auth: API key in header x-api-key and API key in header Authorization

Path parameters

dataset_idstring required

Dataset id.

Request body

mutation'append' | 'replace' | 'delete' required
mutation_data_urlstring

URL of the uploaded file. Required for append and replace.

Response

The updated dataset plus the trigger result. For delete, a deletion summary instead.

datasetobject
trigger_notificationobject
deletionobject

Only for mutation: delete.

Changes

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