LAlance-format
Table
Metadata

Describe a specific table version

Changed on

Describe the detailed information for a specific version of table id.

Returns the manifest path and metadata for the specified version.

post/v1/table/{id}/version/describe

Request

  • Base URL
    http://localhost:2333
  • Auth
    • OAuth 2
      Client credentials
      Token URL: /oauth/token
    • or HTTP bearer
    • or API key in header x-api-key

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.

Request body

contextunknown
idstring[]

The table identifier

versioninteger

Version number to describe

branchstring

Branch to target. When not specified, the main branch is used.

Example request

{
  "identity": {
    "api_key": "api_key",
    "auth_token": "auth_token"
  },
  "context": {
    "key": "context"
  },
  "id": [
    "id",
    "id"
  ],
  "version": 0,
  "branch": "branch"
}

Response

Table version information

contextunknown

Example response

{
  "context": {
    "key": "context"
  },
  "version": {
    "metadata": {
      "key": "metadata"
    },
    "manifest_path": "manifest_path",
    "timestamp_millis": 1,
    "manifest_size": 0,
    "e_tag": "e_tag",
    "version": 0
  }
}

Changes

  • 591cd95574b0Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 9932582b6bd7Revision changes
    • info

      added the new optional request property