LAlance-format
Table
Metadata

Get table statistics

Changed on

Get statistics for table id, including row counts, data sizes, and column statistics.

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

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[]
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"
  ],
  "branch": "branch"
}

Response

Table statistics

contextunknown
total_bytesinteger required

The total number of bytes in the table

num_rowsinteger required

The number of rows in the table

num_indicesinteger required

The number of indices in the table

Example response

{
  "num_indices": 0,
  "context": {
    "key": "context"
  },
  "total_bytes": 0,
  "num_rows": 0,
  "fragment_stats": {
    "num_small_fragments": 0,
    "lengths": {
      "p99": 0,
      "p25": 0,
      "min": 0,
      "max": 0,
      "mean": 0,
      "p50": 0,
      "p75": 0
    },
    "num_fragments": 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