Sign in
Table
Metadata

Describe information of a table

Describe the detailed information for table id.

REST NAMESPACE ONLY REST namespace passes with_table_uri as a query parameter instead of in the request body.

post/v1/table/{id}/describe

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.

with_table_uriboolean

Whether to include the table URI in the response

Request body

idstring[]
versioninteger

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

with_table_uriboolean

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

Example request

{
  "id": [
    "id",
    "id"
  ],
  "version": 0,
  "with_table_uri": false
}

Response

Table properties result when loading a table

tablestring

Table name

namespacestring[]

The namespace identifier as a list of parts

versioninteger
locationstring

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

table_uristring

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

{"stackTrail":"components:schemas:DescribeTableResponse: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"
        }
      }
    ]
  },
  "table_uri": "table_uri",
  "stats": {
    "num_deleted_rows": 0,
    "num_fragments": 0
  },
  "namespace": [
    "namespace",
    "namespace"
  ],
  "location": "location",
  "version": 0,
  "table": "table",
  "storage_options": {
    "key": "storage_options"
  }
}

Changes