Client.create_or_update_dataset

def Client.create_or_update_dataset(
    kind: DatasetKind,
    code_name: str,
    fields: list[FieldDict] | None = None,
    *,
    name: str | None = None,
) -> DatasetClient

Create a dataset, or update the existing dataset with the same code name.

Parameters

DatasetKind

The kind of the dataset.

str

The code name of the dataset.

list[FieldDict] | None

The custom fields of the dataset. Defaults to an empty field list.

str | None

The display name of the dataset. Defaults to the code name when creating a dataset, and to the existing name when updating a dataset.

Dataset kinds

DatasetKind

A dataset that contains a timestamp field

DatasetKind

A dataset that contains a timestamp field and a geometry field

Field types

type

A string field

type

A bytes field

type

A boolean field

type

A 64-bit signed integer field

type

A 64-bit unsigned integer field

type

A 64-bit floating-point number field

type

A duration field

type

A timestamp field

type

A UUID field

type

A geometry field

Note that the type can also be a list of one of the types, indicating that the field is an array, e.g. list[str].

Field options

str

required

Set the name of the field

type

required

Set the type of the field

str

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

str

Set the example value of the field for documentation purposes

Returns

A DatasetClient for the created or updated dataset.

from shapely import Geometry
from tilebox.datasets import Client
from tilebox.datasets.data.datasets import DatasetKind

client = Client()

dataset = client.create_or_update_dataset(
    kind=DatasetKind.SPATIOTEMPORAL,
    code_name="my_catalog",
    fields=[
        {
            "name": "field1",
            "type": str,
        },
        {
            "name": "field2",
            "type": list[int],
        },
        {
            "name": "field3",
            "type": Geometry,
            "description": "Field 3",
            "example_value": "Value 3",
        },
    ],
    name="My personal catalog",
)

Python

Go

Client.create_or_update_dataset

Parameters

Dataset kinds

Field types

Field options

Returns

​Parameters

​Dataset kinds

​Field types

​Field options

​Returns

Parameters

Dataset kinds

Field types

Field options

Returns