Class DatasetsClient

Client for managing datasets in a Sanity project. Provides methods for creating, deleting, and managing datasets.

Example

// List all datasets
const datasets = await client.datasets.list()

// Create a new dataset
await client.datasets.create('staging', {
  aclMode: 'private'
})

// Delete a dataset
await client.datasets.delete('staging')

Constructors

constructor

Methods

create delete edit list

Constructors

constructor

Methods

create

  • create(
        name: string,
        options?: { aclMode?: DatasetAclMode },
    ): Promise<DatasetResponse>

    Create a new dataset with the given name

    Parameters

    • name: string

      Name of the dataset to create

    • Optionaloptions: { aclMode?: DatasetAclMode }

      Options for the dataset

    Returns Promise<DatasetResponse>

delete

  • delete(name: string): Promise<{ deleted: true }>

    Delete a dataset with the given name

    Parameters

    • name: string

      Name of the dataset to delete

    Returns Promise<{ deleted: true }>

edit

  • edit(
        name: string,
        options?: { aclMode?: DatasetAclMode },
    ): Promise<DatasetResponse>

    Edit a dataset with the given name

    Parameters

    • name: string

      Name of the dataset to edit

    • Optionaloptions: { aclMode?: DatasetAclMode }

      New options for the dataset

    Returns Promise<DatasetResponse>

list

  • list(): Promise<DatasetsResponse>

    Fetch a list of datasets for the configured project

    Returns Promise<DatasetsResponse>

Settings

Member Visibility

On This Page

Constructors
Methods