Sign in
Table
Data

Count rows in a table

Count the number of rows in table id

REST NAMESPACE ONLY REST namespace returns the response as a plain integer instead of the CountTableRowsResponse JSON object.

post/v1/table/{id}/count_rows

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

idstring[]
versioninteger

Version of the table to describe. If not specified, server should resolve it to the latest version.

predicatestring

Optional SQL predicate to filter rows for counting

Example request

{
  "predicate": "predicate",
  "identity": {
    "api_key": "api_key",
    "auth_token": "auth_token"
  },
  "id": [
    "id",
    "id"
  ],
  "version": 0
}

Response

Result of counting rows in a table

integer required

Response containing the count of rows. Serializes transparently as just the number for backward compatibility.

Changes