Skip to main content

DeltaResponseData

Details about changes that occurred between two versions, within the specified bounding box.

List of versions that deleted specified columns

List of versions that added new columns

List of versions that contain updates within the specified bounding box, to the specified columns

Details about the changes per version

Bounding box of the search area as integer indexes

List of internal column names to be included into the result

Example: "618d6339-2fa7-4dfd-9c7f-c0b12016639e"

The ID of the column, a UUID for non-system columns

Capitalized list of supported PyArrow datatypes outlined in https://arrow.apache.org/docs/python/api/datatypes.html.

Timestamp datatype is expected to be used with unit measured in "us" and timezone set to "UTC" inside of parquet column header schema or it won't be accepted; an example for PyArrow binding would look like this: pa.timestamp("us", tz="UTC")

Publisher-supplied free-form metadata for the column, as a JSON object. Keys must be non-empty strings (≤ 256 chars) with no leading whitespace or dot and none of the characters / \ : > < | ? " *; keys are unique case-insensitively. Values may be any JSON-compatible type. A single column's tags object serialised as UTF-8 JSON must be at most 10 KiB.

The human-readable label used to identify the column

The ID of the column's unit

Columns added, updated, or deleted in this version

The list of column IDs for deletion

Example: "618d6339-2fa7-4dfd-9c7f-c0b12016639e"

The ID of the column, a UUID for non-system columns

Capitalized list of supported PyArrow datatypes outlined in https://arrow.apache.org/docs/python/api/datatypes.html.

Timestamp datatype is expected to be used with unit measured in "us" and timezone set to "UTC" inside of parquet column header schema or it won't be accepted; an example for PyArrow binding would look like this: pa.timestamp("us", tz="UTC")

Publisher-supplied free-form metadata for the column, as a JSON object. Keys must be non-empty strings (≤ 256 chars) with no leading whitespace or dot and none of the characters / \ : > < | ? " *; keys are unique case-insensitively. Values may be any JSON-compatible type. A single column's tags object serialised as UTF-8 JSON must be at most 10 KiB.

The human-readable label used to identify the column

The ID of the column's unit

Example: "618d6339-2fa7-4dfd-9c7f-c0b12016639e"

The ID of the column, a UUID for non-system columns

The new human-readable label for the column identified by col_id

The list of column IDs for update

update_metadataUpdateMetadata[] | null

Example: 5

Identifier for the version within a block model as a monotonically increasing integer, where 1 is the version_id for the version created upon creation of the block model.

Example: "3e9ce8de-f6ba-4920-8c6e-0882e90f0ed7"

A universally unique identifier for the version

Was this page helpful?