Get table statistics

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

post/v1/table/{id}/stats

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

{"stackTrail":"components:schemas:GetTableStatsRequest:properties:context","oasType":"schema","type":"unknown","description":"Arbitrary context for a request as key-value pairs.\nHow to use the context is custom to the specific implementation.\n\nREST NAMESPACE ONLY\nContext entries are passed via HTTP headers using the naming convention\n`x-lance-ctx-<key>: <value>`. For example, a context entry\n`{\"trace_id\": \"abc123\"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.\n"}

idstring[]

Example request

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

Response

Table statistics

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,
  "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
  }
}