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
  • location: pass through header x-lance-table-location
  • properties: pass through header x-lance-table-properties
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 nullable

An opaque token that allows pagination for list operations (e.g. ListNamespaces).

For an initial request of a list operation, if the implementation cannot return all items in one response, or if there are more items than the page limit specified in the request, the implementation must return a page token in the response, indicating there are more results available.

After the initial request, the value of the page token from each response must be used as the page token value for the next request.

Caller must interpret either null, missing value or empty string value of the page token from the implementation's response as the end of the listing results.

An optional delimiter of the string identifier, following the Lance Namespace spec. When not specified, the . delimiter must be used.

Headers

x-lance-table-locationstring

URI pointing to root location to create the table at

x-lance-table-propertiesstring

JSON-encoded string map (e.g. { "owner": "jack" })

Response

Table properties result when creating a table

locationstring required
versioninteger
{"stackTrail":"components:schemas:CreateTableResponse:properties:properties","oasType":"schema","type":"unknown"}
{"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

{
  "schema": {
    "metadata": {
      "key": "metadata"
    },
    "fields": [
      {
        "metadata": {
          "key": "metadata"
        },
        "nullable": true,
        "name": "name",
        "type": {
          "length": 0,
          "fields": [
            null,
            null
          ],
          "type": "type"
        }
      },
      {
        "metadata": {
          "key": "metadata"
        },
        "nullable": true,
        "name": "name",
        "type": {
          "length": 0,
          "fields": [
            null,
            null
          ],
          "type": "type"
        }
      }
    ]
  },
  "location": "location",
  "version": 0,
  "properties": {
    "key": "properties"
  },
  "storage_options": {
    "key": "storage_options"
  }
}

Changes