LAlance-format
Table
Index
Metadata

Get table index statistics

Changed on

Get statistics for a specific index on a table. Returns information about the index type, distance type (for vector indices), and row counts.

post/v1/table/{id}/index/{index_name}/stats

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.

index_namestring required

Name of the index to get stats for

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[]
versioninteger nullable

Optional table version to get stats for

branchstring

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

index_namestring

Name of the index

Example request

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

Response

Index statistics

contextunknown
distance_typestring nullable

Distance type for vector indexes

index_typestring nullable

Type of the index

num_indexed_rowsinteger nullable

Number of indexed rows

num_unindexed_rowsinteger nullable

Number of unindexed rows

num_indicesinteger nullable

Number of indices

Example response

{
  "num_indices": 0,
  "distance_type": "distance_type",
  "num_unindexed_rows": 0,
  "context": {
    "key": "context"
  },
  "num_indexed_rows": 0,
  "index_type": "index_type"
}

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