Datasets.Update

func (datasetClient) Update(
    ctx context.Context,
    id uuid.UUID,
    kind datasets.DatasetKind,
    codeName string,
    name string,
    fields []datasets.Field,
    options ...datasets.DatasetOption,
) (*datasets.Dataset, error)

Update an existing dataset by ID with the given code name, display name, schema kind, custom fields, and metadata.

New non-queryable fields can be added to a non-empty dataset. Changing whether an existing field is queryable or adding a new queryable field is only supported while the dataset is empty.

Parameters

id · uuid.UUID · required

The ID of the dataset to update.

kind · datasets.DatasetKind · required

The dataset kind.

codeName · string · required

The stable code identifier for the dataset.

name · string · required

The display name of the dataset.

fields · []datasets.Field · required

The full custom field list for the dataset schema.

options · []datasets.DatasetOption

Options for dataset metadata.

Options

datasets.WithSummary(summary string)

Set a short dataset summary.

datasets.WithDescription(description string)

Set the dataset’s markdown description.

Field options

Queryable()

Make a non-repeated String, Bool, Int32, Int64, Uint64, or Float64 field available for server-side custom field filters. A dataset can contain at most two queryable string fields.

Returns

The updated dataset object.

Go

dataset, err := client.Datasets.Update(ctx,
    datasetID,
    datasets.KindSpatiotemporal,
    "my_catalog",
    "My catalog",
    []datasets.Field{
        field.String("source").Description("Source system").Queryable(),
        field.Float64("cloud_cover").Queryable(),
        field.Timestamp("processed_at"),
    },
    datasets.WithDescription("Catalog of scenes prepared for analysis."),
)

See Queryable fields for schema constraints and Filter by custom fields for query syntax.