v1

latestOpenAPI 3.1.1Apache 2.02026-07-2654130166.5 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

Response

Table properties result when creating a table

contextContext

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

On a request, it carries caller-provided context to the implementation. On a response, it carries implementation-provided context back to the caller.

REST NAMESPACE ONLY Context entries are mapped to and from HTTP headers using the header. prefix:

On a request, any entry whose key starts with header. is sent as an HTTP request header with the prefix stripped. For example, the entry {"header.Authorization": "Bearer abc"} is sent as the request header Authorization: Bearer abc.
On a response, every HTTP response header is returned as an entry whose key is the header name prefixed with header.. For example, the response header x-request-id: abc123 is returned as the entry {"header.x-request-id": "abc123"}.

transaction_idstring

Optional transaction identifier

locationstring

versioninteger

storage_optionsobject

Configuration options to be used to access storage. The available options depend on the type of storage in use. These will be passed directly to Lance to initialize storage access.

propertiesobject nullable

Business logic properties stored and managed by the namespace implementation outside Lance context. If the implementation does not support table properties, it should return null for this field.

Example response

{
  "properties": {
    "owner": "Ralph",
    "created_at": "1452120468"
  }
}