Skip to main content
POST
Update a dataset's partition spec

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

dataset_id
integer
required

Unique identifier for a dataset.

Body

application/json
updates
object[]
required

Response

200 - application/json

OK

id
integer
required

Unique identifier for the dataset.

company_id
integer
required

The ID of the company owning the dataset.

created_at
string
required

ISO-8601 timestamp indicating when the dataset was created

name
string
required

The Dataset's name. Should be unique, contain only alpanum chars and underscores. Max length is 256.

display_name
string
required

The Dataset's name to display at UI.

retention_policy
object
required

Backwards-compatible legacy payloads. Interpreted as snapshot-level retention on Iceberg. Returned response will be unified v1 shape with compat.mode=legacy.

Example:
schema
object
required

Schema describing a dataset's input file type and the kind of data the file contains. Note: when the file type is "flat" then the order of the properties describing the must be given in the order they appear in the input file.

status
enum<string>
required

The dataset status.

  • active means that data can be added to the dataset but the schema is locked in place
  • pending means the dataset has been created, but the schema can still be altered and no data can be added to the dataset
Available options:
active,
pending
tags
string[]
required

Tags that describe the dataset.

write_mode
enum<string>
required

How Narrative will treat new data uploaded for the dataset.

  • append means data will be added to the dataset, this is what to choose if you incrementally update your dataset over time.
  • overwrite means that all existing data will be overwritten with new data.
Available options:
append,
overwrite
updated_at
string
required

ISO-8601 timestamp indicating when the dataset was last updated.

compute_pool_config
object

Compute pool configuration for the dataset.

description
string

A description of the data contained with the dataset.

subscription_id
string

Id of a subscription which writes output to the dataset

last_snapshot_created_at
string

ISO-8601 timestamp indicating when the last snapshot was created.

materialized_view_config
object

Materialized-view configuration. Present only for materialized-view datasets.

stats
object
table
object

Metadata of Iceberg table backing the given Dataset encoded in spec-compliant JSON.

See: