Register a table to a namespace

Register an existing table at a given storage location as id.

POST /v1/table/{id}/register

Error

A valid request URL is required to generate request examples

200

{
  "transaction_id": "<string>",
  "location": "<string>",
  "properties": {}
}

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

location · string · required

identity · object

Identity information of a request.

Show child attributes

context · object

Arbitrary context for a request as key-value pairs. How to use the context is custom to the specific implementation.

REST NAMESPACE ONLY Context entries are passed via HTTP headers using the naming convention x-lance-ctx-<key>: <value>. For example, a context entry {"trace_id": "abc123"} would be sent as the header x-lance-ctx-trace_id: abc123.

Show child attributes

id · string[]

mode · string

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.

properties · object

Properties stored on the table, if supported by the implementation.

Show child attributes

Response

200

application/json

Table properties result when registering a table

transaction_id · string

Optional transaction identifier

location · string

properties · object

If the implementation does not support table properties, it should return null for this field. Otherwise, it should return the properties.

Show child attributes