Sign in
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
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

Response

Table properties result when creating a table

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"}

Example response

{
  "transaction_id": "transaction_id",
  "location": "location",
  "version": 0,
  "storage_options": {
    "key": "storage_options"
  }
}

Changes