LAlance-format
Table
Metadata

List all versions of a table

Changed on

List all versions (commits) of table id with their metadata.

Use descending=true to guarantee versions are returned in descending order (latest to oldest). Otherwise, the ordering is implementation-defined.

REST NAMESPACE ONLY REST namespace does not use a request body for this operation. The ListTableVersionsRequest information is passed in the following way:

  • id: pass through path parameter of the same name
  • page_token: pass through query parameter of the same name
  • limit: pass through query parameter of the same name
  • descending: pass through query parameter of the same name
post/v1/table/{id}/version/list

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.

branchstring

Optional branch to target. When not specified, the main branch is used. Used by branch-scoped operations that cannot carry a branch field in their request body (Arrow IPC stream and bodyless operations). Operations with a JSON request body carry branch as a body field instead.

page_tokenstring nullable

An opaque token that allows pagination for list operations (e.g. ListNamespaces).

For an initial request of a list operation, if the implementation cannot return all items in one response, or if there are more items than the page limit specified in the request, the implementation must return a page token in the response, indicating there are more results available.

After the initial request, the value of the page token from each response must be used as the page token value for the next request.

Caller must interpret either null, missing value or empty string value of the page token from the implementation's response as the end of the listing results.

Pagination token from a previous request

limitinteger nullable

An inclusive upper bound of the number of results that a caller will receive.

Maximum number of items to return

descendingboolean

When true, versions are guaranteed to be returned in descending order (latest to oldest). When false or not specified, the ordering is implementation-defined.

Response

List of table versions

contextunknown
page_tokenstring nullable

An opaque token that allows pagination for list operations (e.g. ListNamespaces).

For an initial request of a list operation, if the implementation cannot return all items in one response, or if there are more items than the page limit specified in the request, the implementation must return a page token in the response, indicating there are more results available.

After the initial request, the value of the page token from each response must be used as the page token value for the next request.

Caller must interpret either null, missing value or empty string value of the page token from the implementation's response as the end of the listing results.

Example response

{
  "versions": [
    {
      "metadata": {
        "key": "metadata"
      },
      "manifest_path": "manifest_path",
      "timestamp_millis": 1,
      "manifest_size": 0,
      "e_tag": "e_tag",
      "version": 0
    },
    {
      "metadata": {
        "key": "metadata"
      },
      "manifest_path": "manifest_path",
      "timestamp_millis": 1,
      "manifest_size": 0,
      "e_tag": "e_tag",
      "version": 0
    }
  ],
  "context": {
    "key": "context"
  },
  "page_token": "page_token"
}

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 query request parameter branch to all path's operations

    • info

      added the new optional query request parameter branch