Commit updates to a table

POST /v1/:prefix/namespaces/:namespace/tables/:table

Commit updates to a table.

Commits have two parts, requirements and updates. Requirements are assertions that will be validated before attempting to make and commit changes. For example, assert-ref-snapshot-id will check that a named ref's snapshot ID has a certain value. Server implementations are required to fail with a 400 status code if any unknown updates or requirements are received.

Updates are changes to make to table metadata. For example, after asserting that the current main ref is at the expected snapshot, a commit may add a new child snapshot and set the ref to the new snapshot id.

Create table transactions that are started by createTable with stage-create set to true are committed using this route. Transactions should include all changes to the table, including table initialization, like AddSchemaUpdate and SetCurrentSchemaUpdate. The assert-create requirement is used to ensure that the table was not created concurrently.

Request

Path Parameters

prefix stringrequired

The catalog name in Gravitino, as returned in defaults.prefix by GET /v1/config

namespace stringrequired

A namespace identifier as a single string. Multipart namespace parts must be separated by the namespace separator as indicated via the /config override namespace-separator, which defaults to the unit separator 0x1F byte (url encoded %1F). To be compatible with older clients, servers must use both the advertised separator and 0x1F as valid separators when decoding namespaces. The namespace-separator should be provided in a url encoded form.

Examples:

singlepart_namespace
multipart_namespace

Example: accounting

Example: accounting%1Ftax

table stringrequired

A table name

Example: sales

Header Parameters

Idempotency-Key uuid

Possible values: >= 36 characters and <= 36 characters

Optional client-provided idempotency key for safe request retries.

When present, the server ensures no additional effects for requests that carry the same Idempotency-Key. If a prior request with this key has been finalized, the server returns an equivalent final response without re-running the operation. The response body may reflect a newer state of the catalog than existed at the time of the commit.

Finalization rules:

Finalize & replay: 200, 201, 204, and deterministic terminal 4xx (including 409 such as AlreadyExists, NamespaceNotEmpty, etc.)
Do not finalize (not stored/replayed): 5xx

Key Requirements:

Key format: UUIDv7 in string form (RFC 9562).
The idempotency key must be globally unique (no reuse across different operations).
Catalogs SHOULD NOT expire keys before the end of the advertised token lifetime.
If Idempotency-Key is used, clients MUST reuse the same key when retrying the same logical operation and MUST generate a new key for a different operation.

application/json

Body

required

identifier

object

Table identifier to update; must be present for CommitTransactionRequest

namespace string[]required

Reference to one or more levels of a namespace

name stringrequired

requirements

object[]

required

Array [

type

string

required

Possible values: [assert-create, assert-table-uuid, assert-ref-snapshot-id, assert-last-assigned-field-id, assert-current-schema-id, assert-last-assigned-partition-id, assert-default-spec-id, assert-default-sort-order-id]

type stringrequired

]

updates

object[]

required

Array [

anyOf

Assigning a UUID to a table/view should only be done when creating the table/view. It is not safe to re-assign the UUID if a table/view already has a UUID assigned

action string

uuid stringrequired

action

string

required

Possible values: [assign-uuid, upgrade-format-version, add-schema, set-current-schema, add-spec, set-default-spec, add-sort-order, set-default-sort-order, add-snapshot, set-snapshot-ref, remove-snapshots, remove-snapshot-ref, set-location, set-properties, remove-properties, add-view-version, set-current-view-version, set-statistics, remove-statistics, set-partition-statistics, remove-partition-statistics, remove-partition-specs, remove-schemas, add-encryption-key, remove-encryption-key]

circular(AssignUUIDUpdate)

action string

schema

object

required

type stringrequired

fields

object[]

required

Array [

id integerrequired

name stringrequired

type

object

required

oneOf

PrimitiveType
ListType
MapType

string

required booleanrequired

doc string

initial-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

write-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

]

identifier-field-ids integer[]

last-column-id integerdeprecated

This optional field is DEPRECATED for REMOVAL since it more safe to handle this internally, and shouldn't be exposed to the clients. The highest assigned column ID for the table. This is used to ensure columns are always assigned an unused ID when evolving schemas. When omitted, it will be computed on the server side.

action string

sort-order

object

required

fields

object[]

required

Array [

source-id integerrequired

transform Transform (string)required

direction SortDirection (string)required

Possible values: [asc, desc]

null-order NullOrder (string)required

Possible values: [nulls-first, nulls-last]

]

action string

snapshot

object

required

snapshot-id int64required

parent-snapshot-id int64

sequence-number int64

timestamp-ms int64required

manifest-list stringrequired

Location of the snapshot's manifest list file

first-row-id int64

The first _row_id assigned to the first row in the first data file in the first manifest

added-rows int64

The upper bound of the number of rows with assigned row IDs

summary

object

required

operation stringrequired

Possible values: [append, replace, overwrite, delete]

property name* string

schema-id integer

action string

ref-name stringrequired

type stringrequired

Possible values: [tag, branch]

snapshot-id int64required

max-ref-age-ms int64

max-snapshot-age-ms int64

min-snapshots-to-keep integer

action string

snapshot-id int64deprecated

This optional field is DEPRECATED for REMOVAL since it contains redundant information. Clients should use the statistics.snapshot-id field instead.

statistics

object

required

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

file-footer-size-in-bytes int64required

blob-metadata

object[]

required

Array [

type stringrequired

snapshot-id int64required

sequence-number int64required

fields integer[]required

properties

object

property name* string

]

action string

format-version integerrequired

action

string

required

action string

uuid stringrequired

action string

schema

object

required

type stringrequired

fields

object[]

required

Array [

id integerrequired

name stringrequired

type

object

required

oneOf

PrimitiveType
ListType
MapType

string

required booleanrequired

doc string

initial-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

write-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

]

identifier-field-ids integer[]

last-column-id integerdeprecated

action string

sort-order

object

required

fields

object[]

required

Array [

source-id integerrequired

transform Transform (string)required

direction SortDirection (string)required

Possible values: [asc, desc]

null-order NullOrder (string)required

Possible values: [nulls-first, nulls-last]

]

action string

snapshot

object

required

snapshot-id int64required

parent-snapshot-id int64

sequence-number int64

timestamp-ms int64required

manifest-list stringrequired

Location of the snapshot's manifest list file

first-row-id int64

The first _row_id assigned to the first row in the first data file in the first manifest

added-rows int64

The upper bound of the number of rows with assigned row IDs

summary

object

required

operation stringrequired

Possible values: [append, replace, overwrite, delete]

property name* string

schema-id integer

action string

ref-name stringrequired

type stringrequired

Possible values: [tag, branch]

snapshot-id int64required

max-ref-age-ms int64

max-snapshot-age-ms int64

min-snapshots-to-keep integer

action string

snapshot-id int64deprecated

This optional field is DEPRECATED for REMOVAL since it contains redundant information. Clients should use the statistics.snapshot-id field instead.

statistics

object

required

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

file-footer-size-in-bytes int64required

blob-metadata

object[]

required

Array [

type stringrequired

snapshot-id int64required

sequence-number int64required

fields integer[]required

properties

object

property name* string

]

action string

schema

object

required

type stringrequired

fields

object[]

required

Array [

id integerrequired

name stringrequired

type

object

required

oneOf

PrimitiveType
ListType
MapType

string

required booleanrequired

doc string

initial-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

write-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

]

identifier-field-ids integer[]

last-column-id integerdeprecated

action

string

required

action string

uuid stringrequired

action string

sort-order

object

required

fields

object[]

required

Array [

source-id integerrequired

transform Transform (string)required

direction SortDirection (string)required

Possible values: [asc, desc]

null-order NullOrder (string)required

Possible values: [nulls-first, nulls-last]

]

action string

snapshot

object

required

snapshot-id int64required

parent-snapshot-id int64

sequence-number int64

timestamp-ms int64required

manifest-list stringrequired

Location of the snapshot's manifest list file

first-row-id int64

The first _row_id assigned to the first row in the first data file in the first manifest

added-rows int64

The upper bound of the number of rows with assigned row IDs

summary

object

required

operation stringrequired

Possible values: [append, replace, overwrite, delete]

property name* string

schema-id integer

action string

ref-name stringrequired

type stringrequired

Possible values: [tag, branch]

snapshot-id int64required

max-ref-age-ms int64

max-snapshot-age-ms int64

min-snapshots-to-keep integer

action string

snapshot-id int64deprecated

This optional field is DEPRECATED for REMOVAL since it contains redundant information. Clients should use the statistics.snapshot-id field instead.

statistics

object

required

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

file-footer-size-in-bytes int64required

blob-metadata

object[]

required

Array [

type stringrequired

snapshot-id int64required

sequence-number int64required

fields integer[]required

properties

object

property name* string

]

action string

schema-id integerrequired

Schema ID to set as current, or -1 to set last added schema

action

string

required

action string

uuid stringrequired

action string

schema

object

required

type stringrequired

fields

object[]

required

Array [

id integerrequired

name stringrequired

type

object

required

oneOf

PrimitiveType
ListType
MapType

string

required booleanrequired

doc string

initial-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

write-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

]

identifier-field-ids integer[]

last-column-id integerdeprecated

action string

sort-order

object

required

fields

object[]

required

Array [

source-id integerrequired

transform Transform (string)required

direction SortDirection (string)required

Possible values: [asc, desc]

null-order NullOrder (string)required

Possible values: [nulls-first, nulls-last]

]

action string

snapshot

object

required

snapshot-id int64required

parent-snapshot-id int64

sequence-number int64

timestamp-ms int64required

manifest-list stringrequired

Location of the snapshot's manifest list file

first-row-id int64

The first _row_id assigned to the first row in the first data file in the first manifest

added-rows int64

The upper bound of the number of rows with assigned row IDs

summary

object

required

operation stringrequired

Possible values: [append, replace, overwrite, delete]

property name* string

schema-id integer

action string

ref-name stringrequired

type stringrequired

Possible values: [tag, branch]

snapshot-id int64required

max-ref-age-ms int64

max-snapshot-age-ms int64

min-snapshots-to-keep integer

action string

snapshot-id int64deprecated

This optional field is DEPRECATED for REMOVAL since it contains redundant information. Clients should use the statistics.snapshot-id field instead.

statistics

object

required

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

file-footer-size-in-bytes int64required

blob-metadata

object[]

required

Array [

type stringrequired

snapshot-id int64required

sequence-number int64required

fields integer[]required

properties

object

property name* string

]

action string

spec

object

required

fields

object[]

required

Array [

field-id integer

source-id integerrequired

name stringrequired

transform Transform (string)required

]

action

string

required

action string

uuid stringrequired

action string

schema

object

required

type stringrequired

fields

object[]

required

Array [

id integerrequired

name stringrequired

type

object

required

oneOf

PrimitiveType
ListType
MapType

string

required booleanrequired

doc string

initial-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

write-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

]

identifier-field-ids integer[]

last-column-id integerdeprecated

action string

sort-order

object

required

fields

object[]

required

Array [

source-id integerrequired

transform Transform (string)required

direction SortDirection (string)required

Possible values: [asc, desc]

null-order NullOrder (string)required

Possible values: [nulls-first, nulls-last]

]

action string

snapshot

object

required

snapshot-id int64required

parent-snapshot-id int64

sequence-number int64

timestamp-ms int64required

manifest-list stringrequired

Location of the snapshot's manifest list file

first-row-id int64

The first _row_id assigned to the first row in the first data file in the first manifest

added-rows int64

The upper bound of the number of rows with assigned row IDs

summary

object

required

operation stringrequired

Possible values: [append, replace, overwrite, delete]

property name* string

schema-id integer

action string

ref-name stringrequired

type stringrequired

Possible values: [tag, branch]

snapshot-id int64required

max-ref-age-ms int64

max-snapshot-age-ms int64

min-snapshots-to-keep integer

action string

snapshot-id int64deprecated

This optional field is DEPRECATED for REMOVAL since it contains redundant information. Clients should use the statistics.snapshot-id field instead.

statistics

object

required

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

file-footer-size-in-bytes int64required

blob-metadata

object[]

required

Array [

type stringrequired

snapshot-id int64required

sequence-number int64required

fields integer[]required

properties

object

property name* string

]

action string

spec-id integerrequired

Partition spec ID to set as the default, or -1 to set last added spec

action

string

required

action string

uuid stringrequired

action string

schema

object

required

type stringrequired

fields

object[]

required

Array [

id integerrequired

name stringrequired

type

object

required

oneOf

PrimitiveType
ListType
MapType

string

required booleanrequired

doc string

initial-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

write-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

]

identifier-field-ids integer[]

last-column-id integerdeprecated

action string

sort-order

object

required

fields

object[]

required

Array [

source-id integerrequired

transform Transform (string)required

direction SortDirection (string)required

Possible values: [asc, desc]

null-order NullOrder (string)required

Possible values: [nulls-first, nulls-last]

]

action string

snapshot

object

required

snapshot-id int64required

parent-snapshot-id int64

sequence-number int64

timestamp-ms int64required

manifest-list stringrequired

Location of the snapshot's manifest list file

first-row-id int64

The first _row_id assigned to the first row in the first data file in the first manifest

added-rows int64

The upper bound of the number of rows with assigned row IDs

summary

object

required

operation stringrequired

Possible values: [append, replace, overwrite, delete]

property name* string

schema-id integer

action string

ref-name stringrequired

type stringrequired

Possible values: [tag, branch]

snapshot-id int64required

max-ref-age-ms int64

max-snapshot-age-ms int64

min-snapshots-to-keep integer

action string

snapshot-id int64deprecated

This optional field is DEPRECATED for REMOVAL since it contains redundant information. Clients should use the statistics.snapshot-id field instead.

statistics

object

required

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

file-footer-size-in-bytes int64required

blob-metadata

object[]

required

Array [

type stringrequired

snapshot-id int64required

sequence-number int64required

fields integer[]required

properties

object

property name* string

]

action string

sort-order

object

required

fields

object[]

required

Array [

source-id integerrequired

transform Transform (string)required

direction SortDirection (string)required

Possible values: [asc, desc]

null-order NullOrder (string)required

Possible values: [nulls-first, nulls-last]

]

action

string

required

action string

uuid stringrequired

action string

schema

object

required

type stringrequired

fields

object[]

required

Array [

id integerrequired

name stringrequired

type

object

required

oneOf

PrimitiveType
ListType
MapType

string

required booleanrequired

doc string

initial-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

write-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

]

identifier-field-ids integer[]

last-column-id integerdeprecated

action string

snapshot

object

required

snapshot-id int64required

parent-snapshot-id int64

sequence-number int64

timestamp-ms int64required

manifest-list stringrequired

Location of the snapshot's manifest list file

first-row-id int64

The first _row_id assigned to the first row in the first data file in the first manifest

added-rows int64

The upper bound of the number of rows with assigned row IDs

summary

object

required

operation stringrequired

Possible values: [append, replace, overwrite, delete]

property name* string

schema-id integer

action string

ref-name stringrequired

type stringrequired

Possible values: [tag, branch]

snapshot-id int64required

max-ref-age-ms int64

max-snapshot-age-ms int64

min-snapshots-to-keep integer

action string

snapshot-id int64deprecated

This optional field is DEPRECATED for REMOVAL since it contains redundant information. Clients should use the statistics.snapshot-id field instead.

statistics

object

required

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

file-footer-size-in-bytes int64required

blob-metadata

object[]

required

Array [

type stringrequired

snapshot-id int64required

sequence-number int64required

fields integer[]required

properties

object

property name* string

]

action string

sort-order-id integerrequired

Sort order ID to set as the default, or -1 to set last added sort order

action

string

required

action string

uuid stringrequired

action string

schema

object

required

type stringrequired

fields

object[]

required

Array [

id integerrequired

name stringrequired

type

object

required

oneOf

PrimitiveType
ListType
MapType

string

required booleanrequired

doc string

initial-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

write-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

]

identifier-field-ids integer[]

last-column-id integerdeprecated

action string

sort-order

object

required

fields

object[]

required

Array [

source-id integerrequired

transform Transform (string)required

direction SortDirection (string)required

Possible values: [asc, desc]

null-order NullOrder (string)required

Possible values: [nulls-first, nulls-last]

]

action string

snapshot

object

required

snapshot-id int64required

parent-snapshot-id int64

sequence-number int64

timestamp-ms int64required

manifest-list stringrequired

Location of the snapshot's manifest list file

first-row-id int64

The first _row_id assigned to the first row in the first data file in the first manifest

added-rows int64

The upper bound of the number of rows with assigned row IDs

summary

object

required

operation stringrequired

Possible values: [append, replace, overwrite, delete]

property name* string

schema-id integer

action string

ref-name stringrequired

type stringrequired

Possible values: [tag, branch]

snapshot-id int64required

max-ref-age-ms int64

max-snapshot-age-ms int64

min-snapshots-to-keep integer

action string

snapshot-id int64deprecated

This optional field is DEPRECATED for REMOVAL since it contains redundant information. Clients should use the statistics.snapshot-id field instead.

statistics

object

required

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

file-footer-size-in-bytes int64required

blob-metadata

object[]

required

Array [

type stringrequired

snapshot-id int64required

sequence-number int64required

fields integer[]required

properties

object

property name* string

]

action string

snapshot

object

required

snapshot-id int64required

parent-snapshot-id int64

sequence-number int64

timestamp-ms int64required

manifest-list stringrequired

Location of the snapshot's manifest list file

first-row-id int64

The first _row_id assigned to the first row in the first data file in the first manifest

added-rows int64

The upper bound of the number of rows with assigned row IDs

summary

object

required

operation stringrequired

Possible values: [append, replace, overwrite, delete]

property name* string

schema-id integer

action

string

required

action string

uuid stringrequired

action string

schema

object

required

type stringrequired

fields

object[]

required

Array [

id integerrequired

name stringrequired

type

object

required

oneOf

PrimitiveType
ListType
MapType

string

required booleanrequired

doc string

initial-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

write-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

]

identifier-field-ids integer[]

last-column-id integerdeprecated

action string

sort-order

object

required

fields

object[]

required

Array [

source-id integerrequired

transform Transform (string)required

direction SortDirection (string)required

Possible values: [asc, desc]

null-order NullOrder (string)required

Possible values: [nulls-first, nulls-last]

]

action string

ref-name stringrequired

type stringrequired

Possible values: [tag, branch]

snapshot-id int64required

max-ref-age-ms int64

max-snapshot-age-ms int64

min-snapshots-to-keep integer

action string

snapshot-id int64deprecated

This optional field is DEPRECATED for REMOVAL since it contains redundant information. Clients should use the statistics.snapshot-id field instead.

statistics

object

required

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

file-footer-size-in-bytes int64required

blob-metadata

object[]

required

Array [

type stringrequired

snapshot-id int64required

sequence-number int64required

fields integer[]required

properties

object

property name* string

]

action string

ref-name stringrequired

action

string

required

action string

uuid stringrequired

action string

schema

object

required

type stringrequired

fields

object[]

required

Array [

id integerrequired

name stringrequired

type

object

required

oneOf

PrimitiveType
ListType
MapType

string

required booleanrequired

doc string

initial-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

write-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

]

identifier-field-ids integer[]

last-column-id integerdeprecated

action string

sort-order

object

required

fields

object[]

required

Array [

source-id integerrequired

transform Transform (string)required

direction SortDirection (string)required

Possible values: [asc, desc]

null-order NullOrder (string)required

Possible values: [nulls-first, nulls-last]

]

action string

snapshot

object

required

snapshot-id int64required

parent-snapshot-id int64

sequence-number int64

timestamp-ms int64required

manifest-list stringrequired

Location of the snapshot's manifest list file

first-row-id int64

The first _row_id assigned to the first row in the first data file in the first manifest

added-rows int64

The upper bound of the number of rows with assigned row IDs

summary

object

required

operation stringrequired

Possible values: [append, replace, overwrite, delete]

property name* string

schema-id integer

action string

snapshot-id int64deprecated

This optional field is DEPRECATED for REMOVAL since it contains redundant information. Clients should use the statistics.snapshot-id field instead.

statistics

object

required

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

file-footer-size-in-bytes int64required

blob-metadata

object[]

required

Array [

type stringrequired

snapshot-id int64required

sequence-number int64required

fields integer[]required

properties

object

property name* string

]

type stringrequired

Possible values: [tag, branch]

snapshot-id int64required

max-ref-age-ms int64

max-snapshot-age-ms int64

min-snapshots-to-keep integer

action string

snapshot-ids int64[]required

action

string

required

action string

uuid stringrequired

action string

schema

object

required

type stringrequired

fields

object[]

required

Array [

id integerrequired

name stringrequired

type

object

required

oneOf

PrimitiveType
ListType
MapType

string

required booleanrequired

doc string

initial-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

write-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

]

identifier-field-ids integer[]

last-column-id integerdeprecated

action string

sort-order

object

required

fields

object[]

required

Array [

source-id integerrequired

transform Transform (string)required

direction SortDirection (string)required

Possible values: [asc, desc]

null-order NullOrder (string)required

Possible values: [nulls-first, nulls-last]

]

action string

snapshot

object

required

snapshot-id int64required

parent-snapshot-id int64

sequence-number int64

timestamp-ms int64required

manifest-list stringrequired

Location of the snapshot's manifest list file

first-row-id int64

The first _row_id assigned to the first row in the first data file in the first manifest

added-rows int64

The upper bound of the number of rows with assigned row IDs

summary

object

required

operation stringrequired

Possible values: [append, replace, overwrite, delete]

property name* string

schema-id integer

action string

ref-name stringrequired

type stringrequired

Possible values: [tag, branch]

snapshot-id int64required

max-ref-age-ms int64

max-snapshot-age-ms int64

min-snapshots-to-keep integer

action string

snapshot-id int64deprecated

This optional field is DEPRECATED for REMOVAL since it contains redundant information. Clients should use the statistics.snapshot-id field instead.

statistics

object

required

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

file-footer-size-in-bytes int64required

blob-metadata

object[]

required

Array [

type stringrequired

snapshot-id int64required

sequence-number int64required

fields integer[]required

properties

object

property name* string

]

action string

ref-name stringrequired

action

string

required

action string

uuid stringrequired

action string

schema

object

required

type stringrequired

fields

object[]

required

Array [

id integerrequired

name stringrequired

type

object

required

oneOf

PrimitiveType
ListType
MapType

string

required booleanrequired

doc string

initial-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

write-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

]

identifier-field-ids integer[]

last-column-id integerdeprecated

action string

sort-order

object

required

fields

object[]

required

Array [

source-id integerrequired

transform Transform (string)required

direction SortDirection (string)required

Possible values: [asc, desc]

null-order NullOrder (string)required

Possible values: [nulls-first, nulls-last]

]

action string

snapshot

object

required

snapshot-id int64required

parent-snapshot-id int64

sequence-number int64

timestamp-ms int64required

manifest-list stringrequired

Location of the snapshot's manifest list file

first-row-id int64

The first _row_id assigned to the first row in the first data file in the first manifest

added-rows int64

The upper bound of the number of rows with assigned row IDs

summary

object

required

operation stringrequired

Possible values: [append, replace, overwrite, delete]

property name* string

schema-id integer

action string

ref-name stringrequired

type stringrequired

Possible values: [tag, branch]

snapshot-id int64required

max-ref-age-ms int64

max-snapshot-age-ms int64

min-snapshots-to-keep integer

action string

snapshot-id int64deprecated

This optional field is DEPRECATED for REMOVAL since it contains redundant information. Clients should use the statistics.snapshot-id field instead.

statistics

object

required

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

file-footer-size-in-bytes int64required

blob-metadata

object[]

required

Array [

type stringrequired

snapshot-id int64required

sequence-number int64required

fields integer[]required

properties

object

property name* string

]

action string

location stringrequired

action

string

required

action string

uuid stringrequired

action string

schema

object

required

type stringrequired

fields

object[]

required

Array [

id integerrequired

name stringrequired

type

object

required

oneOf

PrimitiveType
ListType
MapType

string

required booleanrequired

doc string

initial-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

write-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

]

identifier-field-ids integer[]

last-column-id integerdeprecated

action string

sort-order

object

required

fields

object[]

required

Array [

source-id integerrequired

transform Transform (string)required

direction SortDirection (string)required

Possible values: [asc, desc]

null-order NullOrder (string)required

Possible values: [nulls-first, nulls-last]

]

action string

snapshot

object

required

snapshot-id int64required

parent-snapshot-id int64

sequence-number int64

timestamp-ms int64required

manifest-list stringrequired

Location of the snapshot's manifest list file

first-row-id int64

The first _row_id assigned to the first row in the first data file in the first manifest

added-rows int64

The upper bound of the number of rows with assigned row IDs

summary

object

required

operation stringrequired

Possible values: [append, replace, overwrite, delete]

property name* string

schema-id integer

action string

ref-name stringrequired

type stringrequired

Possible values: [tag, branch]

snapshot-id int64required

max-ref-age-ms int64

max-snapshot-age-ms int64

min-snapshots-to-keep integer

action string

snapshot-id int64deprecated

This optional field is DEPRECATED for REMOVAL since it contains redundant information. Clients should use the statistics.snapshot-id field instead.

statistics

object

required

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

file-footer-size-in-bytes int64required

blob-metadata

object[]

required

Array [

type stringrequired

snapshot-id int64required

sequence-number int64required

fields integer[]required

properties

object

property name* string

]

action string

updates

object

required

property name* string

action

string

required

action string

uuid stringrequired

action string

schema

object

required

type stringrequired

fields

object[]

required

Array [

id integerrequired

name stringrequired

type

object

required

oneOf

PrimitiveType
ListType
MapType

string

required booleanrequired

doc string

initial-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

write-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

]

identifier-field-ids integer[]

last-column-id integerdeprecated

action string

sort-order

object

required

fields

object[]

required

Array [

source-id integerrequired

transform Transform (string)required

direction SortDirection (string)required

Possible values: [asc, desc]

null-order NullOrder (string)required

Possible values: [nulls-first, nulls-last]

]

action string

snapshot

object

required

snapshot-id int64required

parent-snapshot-id int64

sequence-number int64

timestamp-ms int64required

manifest-list stringrequired

Location of the snapshot's manifest list file

first-row-id int64

The first _row_id assigned to the first row in the first data file in the first manifest

added-rows int64

The upper bound of the number of rows with assigned row IDs

summary

object

required

operation stringrequired

Possible values: [append, replace, overwrite, delete]

property name* string

schema-id integer

action string

ref-name stringrequired

type stringrequired

Possible values: [tag, branch]

snapshot-id int64required

max-ref-age-ms int64

max-snapshot-age-ms int64

min-snapshots-to-keep integer

action string

snapshot-id int64deprecated

This optional field is DEPRECATED for REMOVAL since it contains redundant information. Clients should use the statistics.snapshot-id field instead.

statistics

object

required

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

file-footer-size-in-bytes int64required

blob-metadata

object[]

required

Array [

type stringrequired

snapshot-id int64required

sequence-number int64required

fields integer[]required

properties

object

property name* string

]

action string

removals string[]required

action

string

required

action string

uuid stringrequired

action string

schema

object

required

type stringrequired

fields

object[]

required

Array [

id integerrequired

name stringrequired

type

object

required

oneOf

PrimitiveType
ListType
MapType

string

required booleanrequired

doc string

initial-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

write-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

]

identifier-field-ids integer[]

last-column-id integerdeprecated

action string

sort-order

object

required

fields

object[]

required

Array [

source-id integerrequired

transform Transform (string)required

direction SortDirection (string)required

Possible values: [asc, desc]

null-order NullOrder (string)required

Possible values: [nulls-first, nulls-last]

]

action string

snapshot

object

required

snapshot-id int64required

parent-snapshot-id int64

sequence-number int64

timestamp-ms int64required

manifest-list stringrequired

Location of the snapshot's manifest list file

first-row-id int64

The first _row_id assigned to the first row in the first data file in the first manifest

added-rows int64

The upper bound of the number of rows with assigned row IDs

summary

object

required

operation stringrequired

Possible values: [append, replace, overwrite, delete]

property name* string

schema-id integer

action string

ref-name stringrequired

type stringrequired

Possible values: [tag, branch]

snapshot-id int64required

max-ref-age-ms int64

max-snapshot-age-ms int64

min-snapshots-to-keep integer

action string

snapshot-id int64deprecated

This optional field is DEPRECATED for REMOVAL since it contains redundant information. Clients should use the statistics.snapshot-id field instead.

statistics

object

required

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

file-footer-size-in-bytes int64required

blob-metadata

object[]

required

Array [

type stringrequired

snapshot-id int64required

sequence-number int64required

fields integer[]required

properties

object

property name* string

]

action string

snapshot-id int64deprecated

This optional field is DEPRECATED for REMOVAL since it contains redundant information. Clients should use the statistics.snapshot-id field instead.

statistics

object

required

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

file-footer-size-in-bytes int64required

blob-metadata

object[]

required

Array [

type stringrequired

snapshot-id int64required

sequence-number int64required

fields integer[]required

properties

object

property name* string

]

action

string

required

action string

uuid stringrequired

action string

schema

object

required

type stringrequired

fields

object[]

required

Array [

id integerrequired

name stringrequired

type

object

required

oneOf

PrimitiveType
ListType
MapType

string

required booleanrequired

doc string

initial-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

write-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

]

identifier-field-ids integer[]

last-column-id integerdeprecated

action string

sort-order

object

required

fields

object[]

required

Array [

source-id integerrequired

transform Transform (string)required

direction SortDirection (string)required

Possible values: [asc, desc]

null-order NullOrder (string)required

Possible values: [nulls-first, nulls-last]

]

action string

snapshot

object

required

snapshot-id int64required

parent-snapshot-id int64

sequence-number int64

timestamp-ms int64required

manifest-list stringrequired

Location of the snapshot's manifest list file

first-row-id int64

The first _row_id assigned to the first row in the first data file in the first manifest

added-rows int64

The upper bound of the number of rows with assigned row IDs

summary

object

required

operation stringrequired

Possible values: [append, replace, overwrite, delete]

property name* string

schema-id integer

action string

ref-name stringrequired

type stringrequired

Possible values: [tag, branch]

snapshot-id int64required

max-ref-age-ms int64

max-snapshot-age-ms int64

min-snapshots-to-keep integer

action string

snapshot-id int64required

action

string

required

action string

uuid stringrequired

action string

schema

object

required

type stringrequired

fields

object[]

required

Array [

id integerrequired

name stringrequired

type

object

required

oneOf

PrimitiveType
ListType
MapType

string

required booleanrequired

doc string

initial-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

write-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

]

identifier-field-ids integer[]

last-column-id integerdeprecated

action string

sort-order

object

required

fields

object[]

required

Array [

source-id integerrequired

transform Transform (string)required

direction SortDirection (string)required

Possible values: [asc, desc]

null-order NullOrder (string)required

Possible values: [nulls-first, nulls-last]

]

action string

snapshot

object

required

snapshot-id int64required

parent-snapshot-id int64

sequence-number int64

timestamp-ms int64required

manifest-list stringrequired

Location of the snapshot's manifest list file

first-row-id int64

The first _row_id assigned to the first row in the first data file in the first manifest

added-rows int64

The upper bound of the number of rows with assigned row IDs

summary

object

required

operation stringrequired

Possible values: [append, replace, overwrite, delete]

property name* string

schema-id integer

action string

ref-name stringrequired

type stringrequired

Possible values: [tag, branch]

snapshot-id int64required

max-ref-age-ms int64

max-snapshot-age-ms int64

min-snapshots-to-keep integer

action string

snapshot-id int64deprecated

This optional field is DEPRECATED for REMOVAL since it contains redundant information. Clients should use the statistics.snapshot-id field instead.

statistics

object

required

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

file-footer-size-in-bytes int64required

blob-metadata

object[]

required

Array [

type stringrequired

snapshot-id int64required

sequence-number int64required

fields integer[]required

properties

object

property name* string

]

action string

partition-statistics

object

required

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

action

string

required

action string

uuid stringrequired

action string

schema

object

required

type stringrequired

fields

object[]

required

Array [

id integerrequired

name stringrequired

type

object

required

oneOf

PrimitiveType
ListType
MapType

string

required booleanrequired

doc string

initial-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

write-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

]

identifier-field-ids integer[]

last-column-id integerdeprecated

action string

sort-order

object

required

fields

object[]

required

Array [

source-id integerrequired

transform Transform (string)required

direction SortDirection (string)required

Possible values: [asc, desc]

null-order NullOrder (string)required

Possible values: [nulls-first, nulls-last]

]

action string

snapshot

object

required

snapshot-id int64required

parent-snapshot-id int64

sequence-number int64

timestamp-ms int64required

manifest-list stringrequired

Location of the snapshot's manifest list file

first-row-id int64

The first _row_id assigned to the first row in the first data file in the first manifest

added-rows int64

The upper bound of the number of rows with assigned row IDs

summary

object

required

operation stringrequired

Possible values: [append, replace, overwrite, delete]

property name* string

schema-id integer

action string

ref-name stringrequired

type stringrequired

Possible values: [tag, branch]

snapshot-id int64required

max-ref-age-ms int64

max-snapshot-age-ms int64

min-snapshots-to-keep integer

action string

snapshot-id int64deprecated

This optional field is DEPRECATED for REMOVAL since it contains redundant information. Clients should use the statistics.snapshot-id field instead.

statistics

object

required

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

file-footer-size-in-bytes int64required

blob-metadata

object[]

required

Array [

type stringrequired

snapshot-id int64required

sequence-number int64required

fields integer[]required

properties

object

property name* string

]

action string

snapshot-id int64required

action

string

required

action string

uuid stringrequired

action string

schema

object

required

type stringrequired

fields

object[]

required

Array [

id integerrequired

name stringrequired

type

object

required

oneOf

PrimitiveType
ListType
MapType

string

required booleanrequired

doc string

initial-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

write-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

]

identifier-field-ids integer[]

last-column-id integerdeprecated

action string

sort-order

object

required

fields

object[]

required

Array [

source-id integerrequired

transform Transform (string)required

direction SortDirection (string)required

Possible values: [asc, desc]

null-order NullOrder (string)required

Possible values: [nulls-first, nulls-last]

]

action string

snapshot

object

required

snapshot-id int64required

parent-snapshot-id int64

sequence-number int64

timestamp-ms int64required

manifest-list stringrequired

Location of the snapshot's manifest list file

first-row-id int64

The first _row_id assigned to the first row in the first data file in the first manifest

added-rows int64

The upper bound of the number of rows with assigned row IDs

summary

object

required

operation stringrequired

Possible values: [append, replace, overwrite, delete]

property name* string

schema-id integer

action string

ref-name stringrequired

type stringrequired

Possible values: [tag, branch]

snapshot-id int64required

max-ref-age-ms int64

max-snapshot-age-ms int64

min-snapshots-to-keep integer

action string

snapshot-id int64deprecated

This optional field is DEPRECATED for REMOVAL since it contains redundant information. Clients should use the statistics.snapshot-id field instead.

statistics

object

required

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

file-footer-size-in-bytes int64required

blob-metadata

object[]

required

Array [

type stringrequired

snapshot-id int64required

sequence-number int64required

fields integer[]required

properties

object

property name* string

]

action string

spec-ids integer[]required

action

string

required

action string

uuid stringrequired

action string

schema

object

required

type stringrequired

fields

object[]

required

Array [

id integerrequired

name stringrequired

type

object

required

oneOf

PrimitiveType
ListType
MapType

string

required booleanrequired

doc string

initial-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

write-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

]

identifier-field-ids integer[]

last-column-id integerdeprecated

action string

sort-order

object

required

fields

object[]

required

Array [

source-id integerrequired

transform Transform (string)required

direction SortDirection (string)required

Possible values: [asc, desc]

null-order NullOrder (string)required

Possible values: [nulls-first, nulls-last]

]

action string

snapshot

object

required

snapshot-id int64required

parent-snapshot-id int64

sequence-number int64

timestamp-ms int64required

manifest-list stringrequired

Location of the snapshot's manifest list file

first-row-id int64

The first _row_id assigned to the first row in the first data file in the first manifest

added-rows int64

The upper bound of the number of rows with assigned row IDs

summary

object

required

operation stringrequired

Possible values: [append, replace, overwrite, delete]

property name* string

schema-id integer

action string

ref-name stringrequired

type stringrequired

Possible values: [tag, branch]

snapshot-id int64required

max-ref-age-ms int64

max-snapshot-age-ms int64

min-snapshots-to-keep integer

action string

snapshot-id int64deprecated

This optional field is DEPRECATED for REMOVAL since it contains redundant information. Clients should use the statistics.snapshot-id field instead.

statistics

object

required

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

file-footer-size-in-bytes int64required

blob-metadata

object[]

required

Array [

type stringrequired

snapshot-id int64required

sequence-number int64required

fields integer[]required

properties

object

property name* string

]

action string

schema-ids integer[]required

action

string

required

action string

uuid stringrequired

action string

schema

object

required

type stringrequired

fields

object[]

required

Array [

id integerrequired

name stringrequired

type

object

required

oneOf

PrimitiveType
ListType
MapType

string

required booleanrequired

doc string

initial-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

write-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

]

identifier-field-ids integer[]

last-column-id integerdeprecated

action string

sort-order

object

required

fields

object[]

required

Array [

source-id integerrequired

transform Transform (string)required

direction SortDirection (string)required

Possible values: [asc, desc]

null-order NullOrder (string)required

Possible values: [nulls-first, nulls-last]

]

action string

snapshot

object

required

snapshot-id int64required

parent-snapshot-id int64

sequence-number int64

timestamp-ms int64required

manifest-list stringrequired

Location of the snapshot's manifest list file

first-row-id int64

The first _row_id assigned to the first row in the first data file in the first manifest

added-rows int64

The upper bound of the number of rows with assigned row IDs

summary

object

required

operation stringrequired

Possible values: [append, replace, overwrite, delete]

property name* string

schema-id integer

action string

ref-name stringrequired

type stringrequired

Possible values: [tag, branch]

snapshot-id int64required

max-ref-age-ms int64

max-snapshot-age-ms int64

min-snapshots-to-keep integer

action string

snapshot-id int64deprecated

This optional field is DEPRECATED for REMOVAL since it contains redundant information. Clients should use the statistics.snapshot-id field instead.

statistics

object

required

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

file-footer-size-in-bytes int64required

blob-metadata

object[]

required

Array [

type stringrequired

snapshot-id int64required

sequence-number int64required

fields integer[]required

properties

object

property name* string

]

action string

encryption-key

object

required

key-id stringrequired

encrypted-key-metadata byterequired

encrypted-by-id string

properties

object

property name* string

action

string

required

action string

uuid stringrequired

action string

schema

object

required

type stringrequired

fields

object[]

required

Array [

id integerrequired

name stringrequired

type

object

required

oneOf

PrimitiveType
ListType
MapType

string

required booleanrequired

doc string

initial-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

write-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

]

identifier-field-ids integer[]

last-column-id integerdeprecated

action string

sort-order

object

required

fields

object[]

required

Array [

source-id integerrequired

transform Transform (string)required

direction SortDirection (string)required

Possible values: [asc, desc]

null-order NullOrder (string)required

Possible values: [nulls-first, nulls-last]

]

action string

snapshot

object

required

snapshot-id int64required

parent-snapshot-id int64

sequence-number int64

timestamp-ms int64required

manifest-list stringrequired

Location of the snapshot's manifest list file

first-row-id int64

The first _row_id assigned to the first row in the first data file in the first manifest

added-rows int64

The upper bound of the number of rows with assigned row IDs

summary

object

required

operation stringrequired

Possible values: [append, replace, overwrite, delete]

property name* string

schema-id integer

action string

ref-name stringrequired

type stringrequired

Possible values: [tag, branch]

snapshot-id int64required

max-ref-age-ms int64

max-snapshot-age-ms int64

min-snapshots-to-keep integer

action string

snapshot-id int64deprecated

This optional field is DEPRECATED for REMOVAL since it contains redundant information. Clients should use the statistics.snapshot-id field instead.

statistics

object

required

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

file-footer-size-in-bytes int64required

blob-metadata

object[]

required

Array [

type stringrequired

snapshot-id int64required

sequence-number int64required

fields integer[]required

properties

object

property name* string

]

action string

key-id stringrequired

action

string

required

action string

uuid stringrequired

action string

schema

object

required

type stringrequired

fields

object[]

required

Array [

id integerrequired

name stringrequired

type

object

required

oneOf

PrimitiveType
ListType
MapType

string

required booleanrequired

doc string

initial-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

write-default

object

oneOf

boolean

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

string

Possible values: >= 36 characters and <= 36 characters, Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

]

identifier-field-ids integer[]

last-column-id integerdeprecated

action string

sort-order

object

required

fields

object[]

required

Array [

source-id integerrequired

transform Transform (string)required

direction SortDirection (string)required

Possible values: [asc, desc]

null-order NullOrder (string)required

Possible values: [nulls-first, nulls-last]

]

action string

snapshot

object

required

snapshot-id int64required

parent-snapshot-id int64

sequence-number int64

timestamp-ms int64required

manifest-list stringrequired

Location of the snapshot's manifest list file

first-row-id int64

The first _row_id assigned to the first row in the first data file in the first manifest

added-rows int64

The upper bound of the number of rows with assigned row IDs

summary

object

required

operation stringrequired

Possible values: [append, replace, overwrite, delete]

property name* string

schema-id integer

action string

ref-name stringrequired

type stringrequired

Possible values: [tag, branch]

snapshot-id int64required

max-ref-age-ms int64

max-snapshot-age-ms int64

min-snapshots-to-keep integer

action string

snapshot-id int64deprecated

This optional field is DEPRECATED for REMOVAL since it contains redundant information. Clients should use the statistics.snapshot-id field instead.

statistics

object

required

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

file-footer-size-in-bytes int64required

blob-metadata

object[]

required

Array [

type stringrequired

snapshot-id int64required

sequence-number int64required

fields integer[]required

properties

object

property name* string

]

Responses

Response used when a table is successfully updated. The table metadata JSON is returned in the metadata field. The corresponding file location of table metadata must be returned in the metadata-location field. Clients can check whether metadata has changed by comparing metadata locations.

Response Headers

etag
string
Identifies a unique version of the table metadata. Implementations that support ETags should produce unique tags for responses that return different metadata content but represent the same version of table metadata. For example, the snapshots query parameter may result in different metadata representations depending on whether refs or all is provided, therefore should have distinct ETags.

application/json

Schema
Example (from schema)

Schema

metadata-location stringrequired

metadata

object

required

format-version integerrequired

Possible values: >= 1 and <= 3

table-uuid stringrequired

location string

last-updated-ms int64

next-row-id int64

A long higher than all assigned row IDs; the next snapshot's first-row-id.

properties

object

property name* string

schemas object[]

current-schema-id integer

last-column-id integer

partition-specs

object[]

Array [

spec-id integer

fields

object[]

required

Array [

field-id integer

source-id integerrequired

name stringrequired

transform Transform (string)required

]

default-spec-id integer

last-partition-id integer

sort-orders

object[]

Array [

order-id integerrequired

fields

object[]

required

Array [

source-id integerrequired

transform Transform (string)required

direction SortDirection (string)required

Possible values: [asc, desc]

null-order NullOrder (string)required

Possible values: [nulls-first, nulls-last]

]

default-sort-order-id integer

encryption-keys

object[]

Array [

key-id stringrequired

encrypted-key-metadata byterequired

encrypted-by-id string

properties

object

property name* string

]

snapshots

object[]

Array [

snapshot-id int64required

parent-snapshot-id int64

sequence-number int64

timestamp-ms int64required

manifest-list stringrequired

Location of the snapshot's manifest list file

first-row-id int64

The first _row_id assigned to the first row in the first data file in the first manifest

added-rows int64

The upper bound of the number of rows with assigned row IDs

summary

object

required

operation stringrequired

Possible values: [append, replace, overwrite, delete]

property name* string

schema-id integer

]

refs

object

property name*

SnapshotReference

type stringrequired

Possible values: [tag, branch]

snapshot-id int64required

max-ref-age-ms int64

max-snapshot-age-ms int64

min-snapshots-to-keep integer

current-snapshot-id int64

last-sequence-number int64

snapshot-log

object[]

Array [

snapshot-id int64required

timestamp-ms int64required

]

metadata-log

object[]

Array [

metadata-file stringrequired

timestamp-ms int64required

]

statistics

object[]

Array [

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

file-footer-size-in-bytes int64required

blob-metadata

object[]

required

Array [

type stringrequired

snapshot-id int64required

sequence-number int64required

fields integer[]required

properties

object

property name* string

]

partition-statistics

object[]

Array [

snapshot-id int64required

statistics-path stringrequired

file-size-in-bytes int64required

]

{
  "metadata-location": "string",
  "metadata": {
    "format-version": 0,
    "table-uuid": "string",
    "location": "string",
    "last-updated-ms": 0,
    "next-row-id": 0,
    "properties": {},
    "schemas": [
      {
        "type": "string",
        "fields": [
          {
            "id": 0,
            "name": "string",
            "type": [
              "long",
              "string",
              "fixed[16]",
              "decimal(10,2)"
            ],
            "required": true,
            "doc": "string",
            "initial-default": true,
            "write-default": true
          }
        ],
        "schema-id": 0,
        "identifier-field-ids": [
          0
        ]
      }
    ],
    "current-schema-id": 0,
    "last-column-id": 0,
    "partition-specs": [
      {
        "spec-id": 0,
        "fields": [
          {
            "field-id": 0,
            "source-id": 0,
            "name": "string",
            "transform": [
              "identity",
              "year",
              "month",
              "day",
              "hour",
              "bucket[256]",
              "truncate[16]"
            ]
          }
        ]
      }
    ],
    "default-spec-id": 0,
    "last-partition-id": 0,
    "sort-orders": [
      {
        "order-id": 0,
        "fields": [
          {
            "source-id": 0,
            "transform": [
              "identity",
              "year",
              "month",
              "day",
              "hour",
              "bucket[256]",
              "truncate[16]"
            ],
            "direction": "asc",
            "null-order": "nulls-first"
          }
        ]
      }
    ],
    "default-sort-order-id": 0,
    "encryption-keys": [
      {
        "key-id": "string",
        "encrypted-key-metadata": "string",
        "encrypted-by-id": "string",
        "properties": {}
      }
    ],
    "snapshots": [
      {
        "snapshot-id": 0,
        "parent-snapshot-id": 0,
        "sequence-number": 0,
        "timestamp-ms": 0,
        "manifest-list": "string",
        "first-row-id": 0,
        "added-rows": 0,
        "summary": {
          "operation": "append"
        },
        "schema-id": 0
      }
    ],
    "refs": {},
    "current-snapshot-id": 0,
    "last-sequence-number": 0,
    "snapshot-log": [
      {
        "snapshot-id": 0,
        "timestamp-ms": 0
      }
    ],
    "metadata-log": [
      {
        "metadata-file": "string",
        "timestamp-ms": 0
      }
    ],
    "statistics": [
      {
        "snapshot-id": 0,
        "statistics-path": "string",
        "file-size-in-bytes": 0,
        "file-footer-size-in-bytes": 0,
        "blob-metadata": [
          {
            "type": "string",
            "snapshot-id": 0,
            "sequence-number": 0,
            "fields": [
              0
            ],
            "properties": {}
          }
        ]
      }
    ],
    "partition-statistics": [
      {
        "snapshot-id": 0,
        "statistics-path": "string",
        "file-size-in-bytes": 0
      }
    ]
  }
}

Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure, such as invalid json. Usually serves application/json content, although in some cases simple text/plain content might be returned by the server's middleware.

application/json

Schema
Example (from schema)
Example

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

{
  "error": {
    "message": "Malformed request",
    "type": "BadRequestException",
    "code": 400
  }
}

Unauthorized. The REST Catalog SHOULD respond with the 401 UnauthorizedResponse when the access token provided is expired, revoked, malformed, or invalid for other reasons. The client MAY request a new access token and retry the request.

application/json

Schema
Example (from schema)
Example

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

{
  "error": {
    "message": "Not authorized to make this request",
    "type": "NotAuthorizedException",
    "code": 401
  }
}

Forbidden. Authenticated user does not have the necessary permissions.

application/json

Schema
Example (from schema)
Example

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

{
  "error": {
    "message": "Not authorized to make this request",
    "type": "NotAuthorizedException",
    "code": 403
  }
}

Not Found - NoSuchTableException, table to load does not exist

application/json

Schema
Example (from schema)
TableToUpdateDoesNotExist

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

The requested table does not exist

{
  "error": {
    "message": "The given table does not exist",
    "type": "NoSuchTableException",
    "code": 404
  }
}

Conflict - CommitFailedException, one or more requirements failed. The client may retry.

application/json

Schema
Example (from schema)

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

This is an optional status response type that the REST Catalog can issue when the token has expired. The client MAY request a new access token and retry the request. 401 UnauthorizedResponse SHOULD be preferred over this response type on token expiry.

application/json

Schema
Example (from schema)
Example

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

{
  "error": {
    "message": "Credentials have timed out",
    "type": "AuthenticationTimeoutException",
    "code": 419
  }
}

An unknown server-side problem occurred; the commit state is unknown.

application/json

Schema
Example (from schema)
Example

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

{
  "error": {
    "message": "Internal Server Error",
    "type": "CommitStateUnknownException",
    "code": 500
  }
}

A gateway or proxy received an invalid response from the upstream server; the commit state is unknown.

application/json

Schema
Example (from schema)
Example

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

{
  "error": {
    "message": "Invalid response from the upstream server",
    "type": "CommitStateUnknownException",
    "code": 502
  }
}

The service is not ready to handle the request, request could have been partially processed. The service may additionally send a Retry-After header to indicate when to retry, a non idempotent request should only be retried by the client when the Retry-After header is present.

application/json

Schema
Example (from schema)
Example

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

{
  "error": {
    "message": "Slow down",
    "type": "SlowDownException",
    "code": 503
  }
}

A server-side gateway timeout occurred; the commit state is unknown.

application/json

Schema
Example (from schema)
Example

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

{
  "error": {
    "message": "Gateway timed out during commit",
    "type": "CommitStateUnknownException",
    "code": 504
  }
}

A server-side problem that might not be addressable on the client.

application/json

Schema
Example (from schema)
Example

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

{
  "error": {
    "message": "Bad Gateway",
    "type": "InternalServerError",
    "code": 502
  }
}

Commit updates to a table

/v1/:prefix/namespaces/:namespace/tables/:table

Request​

Path Parameters

Header Parameters

Body

Responses​

Request

Responses