Sign in
Table
Metadata

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 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.

An optional delimiter of the string identifier, following the Lance Namespace spec. When not specified, the . delimiter must be used.

Request body

idstring[]

Example request

{
  "id": [
    "id",
    "id"
  ]
}

Response

Table statistics

num_rowsinteger required

Total number of rows in the table

size_bytesinteger required

Total size of the table in bytes

num_fragmentsinteger

Number of data fragments

Example response

{
  "size_bytes": 0,
  "num_rows": 0,
  "num_fragments": 0
}

Changes