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

{"stackTrail":"components:schemas:CountTableRowsRequest: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[]
versioninteger

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

branchstring

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

predicatestring

Optional SQL predicate to filter rows for counting

Example request

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

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