Skip to main content
POST
/
v1
/
table
/
{id}
/
describe
Error
A valid request URL is required to generate request examples
{
  "table": "<string>",
  "namespace": [
    "<string>"
  ],
  "version": 1,
  "location": "<string>",
  "table_uri": "<string>",
  "schema": {
    "fields": [
      {
        "name": "<string>",
        "nullable": true,
        "type": {
          "type": "<string>",
          "fields": "<array>",
          "length": 1
        },
        "metadata": {}
      }
    ],
    "metadata": {}
  },
  "storage_options": {},
  "stats": {
    "num_deleted_rows": 1,
    "num_fragments": 1
  }
}

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.

​
with_table_uri
boolean
default:false

Whether to include the table URI in the response

Body

application/json
​
id
string[]
​
version
integer<int64>

Version of the table to describe. If not specified, server should resolve it to the latest version.

Required range: x >= 0
​
with_table_uri
boolean
default:false

Whether to include the table URI in the response. Default is false.

Response

Table properties result when loading a table

​
table
string

Table name

​
namespace
string[]

The namespace identifier as a list of parts

​
version
integer<int64>
Required range: x >= 0
​
location
string

Table storage location (e.g., S3/GCS path)

​
table_uri
string

Table URI. Unlike location, this field must be a complete and valid URI

​
schema
object

JSON representation of a Apache Arrow schema.

​
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.

​
stats
object

Table statistics