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 '
{
  "identity": {
    "api_key": "<string>",
    "auth_token": "<string>"
  },
  "context": {},
  "id": [
    "<string>"
  ],
  "location": "<string>",
  "vend_credentials": true,
  "properties": {}
}
'
{
  "transaction_id": "<string>",
  "location": "<string>",
  "storage_options": {},
  "properties": {
    "owner": "Ralph",
    "created_at": "1452120468"
  },
  "managed_versioning": true
}

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.

​
identity
object

Identity information of a request.

​
context
object

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

REST NAMESPACE ONLY Context entries are passed via HTTP headers using the naming convention x-lance-ctx-<key>: <value>. For example, a context entry {"trace_id": "abc123"} would be sent as the header x-lance-ctx-trace_id: abc123.

​
id
string[]
​
location
string

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

​
vend_credentials
boolean

Whether to include vended credentials in the response storage_options. When true, the implementation should provide vended credentials for accessing storage. When not set, the implementation can decide whether to return vended credentials.

​
properties
object

Properties stored on the table, if supported by the server.

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.

​
properties
object

If the implementation does not support table properties, it should return null for this field. Otherwise it should return the properties.

Example:
{
  "owner": "Ralph",
  "created_at": "1452120468"
}
​
managed_versioning
boolean

When true, the caller should use namespace table version operations (CreateTableVersion, BatchCreateTableVersions, DescribeTableVersion, ListTableVersions, BatchDeleteTableVersions) to manage table versions instead of relying on Lance's native version management.