UpdateDataWithVersion

base_version_uuiduuid

bboxBBox | BBoxXYZ | null

Any of:

One of:

BBoxobject

i_minmaxIntRange

Required

Minimum and maximum values for the i column in the file

maxinteger

Required

Maximum value for the column

mininteger

Required

Minimum value for the column

j_minmaxIntRange

Required

Minimum and maximum values for the j column in the file

maxinteger

Required

Maximum value for the column

mininteger

Required

Minimum value for the column

k_minmaxIntRange

Required

Minimum and maximum values for the k column in the file

maxinteger

Required

Maximum value for the column

mininteger

Required

Minimum value for the column

BBoxXYZobject

x_minmaxFloatRange

Required

Minimum and maximum values for the x column in the file

maxnumber

Required

Maximum value for the column

minnumber

Required

Minimum value for the column

y_minmaxFloatRange

Required

Minimum and maximum values for the y column in the file

maxnumber

Required

Maximum value for the column

minnumber

Required

Minimum value for the column

z_minmaxFloatRange

Required

Minimum and maximum values for the z column in the file

maxnumber

Required

Maximum value for the column

minnumber

Required

Minimum value for the column

null

columnsUpdateColumns

deletestring[]

Required

The list of column IDs for deletion

newobject[]

Required

col_idstring

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

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

data_type"Boolean" | "Int8" | "Int16" | "Int32" | "Int64" | "UInt8" | "UInt16" | "UInt32" | "UInt64" | "Float16" | "Float32" | "Float64" | "Utf8" | "Date32" | "Timestamp"

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")

titlestring

The human-readable label used to identify the column

unit_idstring | null

The ID of the column's unit

renameobject[]

Required

col_idstring

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

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

new_titlestring

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

updatestring[]

Required

The list of column IDs for update

update_metadataarray | null

commentstring | null

geometry_changeboolean | null

Whether the update will create or destroy sub-blocks.

• If set to false, no sub-blocks can be created nor destroyed, only sub-blocks that exist in the latest version can be updated.
• If set to true:
  • New sub-blocks can be created and/or existing sub-blocks can be destroyed, but all columns must be provided.
  • Only new, update, and delete column operations are allowed as standalone operations.
  • update_metadata is allowed, but only when the target columns are being updated as part of the update operation, and only when there are no columns being renamed.
  • If update_type is set to merge, then all sub-blocks within a parent block must be provided.

update_type"merge" | "replace"

Default: "merge"

Behaviour of the update, for blocks that are omitted from the update file.

• If set to replace, the values for blocks that are omitted will be set to null, for the selected columns. If geometry_change is true, the geometry of any parent block that has no blocks in the update file will be reset to an un-subdivided state.
• If set to merge, blocks that are omitted will be left unchanged, the values within those blocks will be the same as within the previous version.