v52

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

Table

Metadata

Register a table to a namespace

post/v1/table/{id}/register

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:RegisterTableRequest: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[]

locationstring required

modestring

There are two modes when trying to register a table, to differentiate the behavior when a table of the same name already exists. Case insensitive, supports both PascalCase and snake_case. Valid values are:

Create (default): the operation fails with 409.
Overwrite: the existing table registration is replaced with the new registration.

{"stackTrail":"components:schemas:RegisterTableRequest:properties:properties","oasType":"schema","type":"unknown","description":"Properties stored on the table, if supported by the implementation.\n"}

Example request

{
  "mode": "mode",
  "identity": {
    "api_key": "api_key",
    "auth_token": "auth_token"
  },
  "context": {
    "key": "context"
  },
  "location": "location",
  "id": [
    "id",
    "id"
  ],
  "properties": {
    "key": "properties"
  }
}

Response

Table properties result when registering a table

{"stackTrail":"components:schemas:RegisterTableResponse: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"}

transaction_idstring

Optional transaction identifier

locationstring

{"stackTrail":"components:schemas:RegisterTableResponse:properties:properties","oasType":"schema","type":"unknown","description":"If the implementation does not support table properties, it should return null for this field. Otherwise, it should return the properties.\n"}

Example response

{
  "transaction_id": "transaction_id",
  "context": {
    "key": "context"
  },
  "location": "location",
  "properties": {
    "key": "properties"
  }
}