Datasets.CreateOrUpdate

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

Create a dataset or update an existing dataset if a dataset with the given codeName already exists. If the dataset already exists, Tilebox applies the same schema update rules as a direct update. New fields can be added to non-empty datasets. Breaking schema changes are only allowed for empty datasets. New queryable fields and changes to an existing field’s queryable annotation are also only allowed for empty datasets.

Parameters

datasets.DatasetKind

required

The dataset kind.

string

required

The stable code identifier for the dataset.

string

required

The display name of the dataset.

[]datasets.Field

required

The custom fields in the dataset schema.

[]datasets.DatasetOption

Options for dataset metadata.

Options

Set a short dataset summary.

Set the dataset’s markdown description.

Dataset kinds

datasets.DatasetKind

A dataset that contains timestamp, ID, and ingestion time fields.

datasets.DatasetKind

A dataset that contains timestamp, ID, ingestion time, and geometry fields.

Field types

Field

A string field

Field

A bytes field

Field

A boolean field

Field

A 32-bit signed integer field

Field

A 64-bit signed integer field

Field

A 64-bit unsigned integer field

Field

A 64-bit floating-point number field

Field

A duration field

Field

A timestamp field

Field

A UUID field

Field

A geometry field

Field options

Indicate that the field is an array

Set the description of the field to provide more context and details about the data

Set the example value of the field for documentation purposes

Optional. Set the RFC 6901 path to this field in the source JSON, such as /properties/eo:cloud_cover. This is useful when transforming datapoints to JSON because Tilebox can reconstruct nested source objects from flattened dataset fields.

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.

Optional. Set a JSON Schema reference URI or URI fragment for the field. Use this when the field follows a well-known schema, such as a STAC extension. Tilebox emits the reference as $ref when advertising the field in STAC queryables.

Set semantic display roles for the field. The only currently supported role is field.RolePrimaryTitle.

Queryable string values can contain at most 1,024 Unicode code points. See Queryable fields for schema constraints and Filter by custom fields for query syntax.

Returns

The created or updated dataset object.

dataset, err := client.Datasets.CreateOrUpdate(ctx,
    datasets.KindSpatiotemporal,
    "my_catalog",
    "My catalog",
    []datasets.Field{
        field.String("platform").Queryable(),
        field.Float64("cloud_cover").Queryable(),
        field.Int64("shape").Repeated(),
        field.Geometry("footprint").Description("Source product footprint"),
    },
    datasets.WithSummary("Scenes prepared for analysis"),
)

Python

Go

Datasets.CreateOrUpdate

Parameters

Options

Dataset kinds

Field types

Field options

Returns

​Parameters

​Options

​Dataset kinds

​Field types

​Field options

​Returns

Parameters

Options

Dataset kinds

Field types

Field options

Returns