Skip to main content

UpdateWithUrl

base_version_uuiduuid
Required

Minimum and maximum values for the i column in the file

Maximum value for the column

Minimum value for the column

Minimum and maximum values for the j column in the file

Maximum value for the column

Minimum value for the column

Minimum and maximum values for the k column in the file

Maximum value for the column

Minimum value for the column

Minimum and maximum values for the x column in the file

Maximum value for the column

Minimum value for the column

Minimum and maximum values for the y column in the file

Maximum value for the column

Minimum value for the column

Minimum and maximum values for the z column in the file

Maximum value for the column

Minimum value for the column

null

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

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_metadataarray | null
commentstring | null
<= 250 chars

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.

Lineage of the block model update

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.

The list of column titles for deletion

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

The human-readable label used to identify the column

The ID of the column's unit

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

The original human-readable label used to identify the column

The list of column titles for update

update_metadataarray | null
commentstring | null
<= 250 chars

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.
column_name_mappingarray | null
Default: []
file_format"parquet"
Default: "parquet"
column_name_mappingarray | array | null
Default: []
decimal_charstring | null
1 char
Default: "."
delimiterstring | null
1 char
Default: ","
file_format"csv"
Default: "csv"
quote_charstring | null
1 char
Default: '"'
skip_rowsinteger | null

Range: >= 0

skip_rows_after_headersinteger | null

Range: >= 0

null

Lineage of the block model update

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.
job_urluri
>= 1 char
job_uuiduuid
upload_urlstring | null
>= 1 char
version_uuiduuid