Update per-field metadata

Update the Arrow field (column) metadata for table id.

Each entry targets a field by path and merges the provided key-value pairs into that field’s existing metadata, or replaces it when replace is true. A null metadata value deletes that key.

POST /v1/table/{id}/update_field_metadata

Error

A valid request URL is required to generate request examples

200

{
  "version": 1,
  "fields": {}
}

Authorizations

OAuth2BearerAuthApiKeyAuth

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id · string · required

string identifier of an object in a namespace, following the Lance Namespace spec. When the value is equal to the delimiter, it represents the root namespace. For example, v1/namespace/$/list performs a ListNamespace on the root namespace.

Query Parameters

delimiter · string

An optional delimiter of the string identifier, following the Lance Namespace spec. When not specified, the $ delimiter must be used.

Body

application/json

updates · object[] · required

List of per-field metadata updates to apply

Show child attributes

identity · object

Identity information of a request.

Show child attributes

id · string[]

Table identifier path (namespace + table name)

branch · string

Branch to target. When not specified, the main branch is used.

Response

200

application/json

Field metadata update result

version · integer<int64> · required

The commit version associated with the operation

Required range: x >= 0

fields · object

Resulting metadata for each updated field, keyed by canonical Lance field path.

Show child attributes