v52

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

Table

Data

Create a table with the given name

Create table id in the namespace with the given data in Arrow IPC stream.

The schema of the Arrow IPC stream is used as the table schema. If the stream is empty, the API creates a new empty table.

REST NAMESPACE ONLY REST namespace uses Arrow IPC stream as the request body. It passes in the CreateTableRequest information in the following way:

id: pass through path parameter of the same name
mode: pass through query parameter of the same name
properties: serialize as a single JSON-encoded query parameter such as properties={"user":"alice","team":"eng"}; these are business logic properties managed by the namespace implementation outside Lance context
storage_options: serialize as a single JSON-encoded query parameter such as storage_options={"aws_region":"us-east-1","timeout":"30s"}; these configure write-time overrides for data and metadata written during table creation

post/v1/table/{id}/create

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.

modestring

propertiesstring

Business logic properties managed by the namespace implementation outside Lance context. The map is translated to a single JSON-encoded query parameter such as properties={"user":"alice","team":"eng"}.

storage_optionsstring

Storage options that configure overrides for writing table data and metadata during table creation. These are passed to Lance for the write path. The map is translated to a single JSON-encoded query parameter such as storage_options={"aws_region":"us-east-1","timeout":"30s"}.

Response

Table properties result when creating a table

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

versioninteger

{"stackTrail":"components:schemas:CreateTableResponse:properties:storage_options","oasType":"schema","type":"unknown","description":"Configuration options to be used to access storage. The available\noptions depend on the type of storage in use. These will be\npassed directly to Lance to initialize storage access.\n"}

{"stackTrail":"components:schemas:CreateTableResponse:properties:properties","oasType":"schema","type":"unknown","description":"Business logic properties stored and managed by the namespace implementation outside\nLance context. If the implementation does not support table properties, it should\nreturn null for this field.\n","example":{"owner":"Ralph","created_at":"1452120468"},"nullable":true}

Example response

{
  "transaction_id": "transaction_id",
  "context": {
    "key": "context"
  },
  "location": "location",
  "version": 0,
  "properties": {
    "owner": "Ralph",
    "created_at": "1452120468"
  },
  "storage_options": {
    "key": "storage_options"
  }
}