v52

latestOpenAPI 3.1.1Apache 2.0raw.githubusercontent.com2026-08-0354155395.9 KB

Table

Metadata

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

Path parameters

idstring 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

delimiterstring

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

Request body

{"stackTrail":"components:schemas:UpdateFieldMetadataRequest:properties:context","oasType":"schema","type":"unknown","description":"Arbitrary context as key-value pairs.\nHow to use the context is custom to the specific implementation.\n\nOn a request, it carries caller-provided context to the implementation.\nOn a response, it carries implementation-provided context back to the caller.\n\nREST NAMESPACE ONLY\nContext entries are mapped to and from HTTP headers using the `header.` prefix:\n- On a request, any entry whose key starts with `header.` is sent as an HTTP\n request header with the prefix stripped. For example, the entry\n `{\"header.Authorization\": \"Bearer abc\"}` is sent as the request header\n `Authorization: Bearer abc`.\n- On a response, every HTTP response header is returned as an entry whose key is the\n header name prefixed with `header.`. For example, the response header\n `x-request-id: abc123` is returned as the entry `{\"header.x-request-id\": \"abc123\"}`.\n"}

idstring[]

Table identifier path (namespace + table name)

branchstring

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

Example request

{
  "identity": {
    "api_key": "api_key",
    "auth_token": "auth_token"
  },
  "context": {
    "key": "context"
  },
  "id": [
    "id",
    "id"
  ],
  "updates": [
    {
      "path": "path",
      "metadata": {
        "key": "metadata"
      },
      "replace": true
    },
    {
      "path": "path",
      "metadata": {
        "key": "metadata"
      },
      "replace": true
    }
  ],
  "branch": "branch"
}

Response

Field metadata update result

{"stackTrail":"components:schemas:UpdateFieldMetadataResponse:properties:context","oasType":"schema","type":"unknown","description":"Arbitrary context as key-value pairs.\nHow to use the context is custom to the specific implementation.\n\nOn a request, it carries caller-provided context to the implementation.\nOn a response, it carries implementation-provided context back to the caller.\n\nREST NAMESPACE ONLY\nContext entries are mapped to and from HTTP headers using the `header.` prefix:\n- On a request, any entry whose key starts with `header.` is sent as an HTTP\n request header with the prefix stripped. For example, the entry\n `{\"header.Authorization\": \"Bearer abc\"}` is sent as the request header\n `Authorization: Bearer abc`.\n- On a response, every HTTP response header is returned as an entry whose key is the\n header name prefixed with `header.`. For example, the response header\n `x-request-id: abc123` is returned as the entry `{\"header.x-request-id\": \"abc123\"}`.\n"}

versioninteger required

The commit version associated with the operation

{"stackTrail":"components:schemas:UpdateFieldMetadataResponse:properties:fields","oasType":"schema","type":"unknown","description":"Resulting metadata for each updated field, keyed by canonical Lance field path.\n"}

Example response

{
  "context": {
    "key": "context"
  },
  "fields": {
    "key": {
      "key": "fields"
    }
  },
  "version": 0
}