v52

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

Update table schema metadata

Replace the schema metadata for table id with the provided key-value pairs.

REST NAMESPACE ONLY REST namespace uses a direct object (map of string to string) as both request and response body instead of the wrapped UpdateTableSchemaMetadataRequest and UpdateTableSchemaMetadataResponse.

post/v1/table/{id}/schema_metadata/update

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.

branchstring

Optional branch to target. When not specified, the main branch is used. Used by branch-scoped operations that cannot carry a branch field in their request body (Arrow IPC stream and bodyless operations). Operations with a JSON request body carry branch as a body field instead.

Request body

{"stackTrail":"paths:/v1/table/{id}/schema_metadata/update:post:requestBody:content:application/json:schema","oasType":"schema","type":"unknown","description":"Schema metadata key-value pairs"}

Response

Schema metadata update result

{"stackTrail":"paths:/v1/table/{id}/schema_metadata/update:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","description":"The updated schema metadata"}