Skip to main content
POST
/
v1
/
table
/
{id}
/
declare
Declare a table
curl --request POST \
  --url {scheme}://{host}:{port}/{basePath}/v1/table/{id}/declare \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": [
    "<string>"
  ],
  "location": "<string>"
}
'
{
  "transaction_id": "<string>",
  "location": "<string>",
  "storage_options": {}
}

Authorizations

​
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

Request for declaring a table.

​
id
string[]
​
location
string

Optional storage location for the table. If not provided, the namespace implementation should determine the table location.

Response

Table properties result when declaring a table

Response for declaring a table.

​
transaction_id
string

Optional transaction identifier

​
location
string
​
storage_options
object

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.