LAlance-format
Table
Index
Metadata

List indexes on a table

Changed on

List all indices created on a table. Returns information about each index including name, columns, status, and UUID.

post/v1/table/{id}/index/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.

Request body

contextunknown
idstring[]

The namespace identifier

versioninteger nullable

Optional table version to list indexes from

branchstring

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

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.

limitinteger nullable

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

Example request

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

Response

List of indices on the table

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

{
  "indexes": [
    {
      "index_uuid": "index_uuid",
      "size_bytes": 0,
      "columns": [
        "columns",
        "columns"
      ],
      "created_at": "2000-01-23T04:56:07.000+00:00",
      "index_details": "index_details",
      "num_indexed_rows": 0,
      "num_segments": 0,
      "index_type": "index_type",
      "index_version": 0,
      "num_unindexed_rows": 0,
      "index_name": "index_name",
      "status": "status",
      "type_url": "type_url"
    },
    {
      "index_uuid": "index_uuid",
      "size_bytes": 0,
      "columns": [
        "columns",
        "columns"
      ],
      "created_at": "2000-01-23T04:56:07.000+00:00",
      "index_details": "index_details",
      "num_indexed_rows": 0,
      "num_segments": 0,
      "index_type": "index_type",
      "index_version": 0,
      "num_unindexed_rows": 0,
      "index_name": "index_name",
      "status": "status",
      "type_url": "type_url"
    }
  ],
  "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

  • 18253b7d5e1cRevision 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

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status