v1

latestOpenAPI 3.1.1Apache 2.02026-07-2654130166.5 KB

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. The REST response maps to the CountTableRowsResponse model as follows:

the integer response body maps to count
response headers map to context via the header. prefix (see the Context schema)

post/v1/table/{id}/count_rows

Request body

contextContext

Arbitrary context as key-value pairs. How to use the context is custom to the specific implementation.

On a request, it carries caller-provided context to the implementation. On a response, it carries implementation-provided context back to the caller.

REST NAMESPACE ONLY Context entries are mapped to and from HTTP headers using the header. prefix:

On a request, any entry whose key starts with header. is sent as an HTTP request header with the prefix stripped. For example, the entry {"header.Authorization": "Bearer abc"} is sent as the request header Authorization: Bearer abc.
On a response, every HTTP response header is returned as an entry whose key is the header name prefixed with header.. For example, the response header x-request-id: abc123 is returned as the entry {"header.x-request-id": "abc123"}.

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. Field references must use Lance field path syntax: nested fields use dot-separated segments, literal dots require backtick-quoted segments, and backticks inside quoted segments are doubled.

Response

Result of counting rows in a table

integer required

Row count serialized transparently as a bare number for the REST namespace. The CountTableRowsResponse object model is used by non-REST interfaces.