Estimate document count (HTTP)

For details about additional languages, see:

Estimates the number of documents in a collection.

This method only returns an estimated count. It is an alternative to getting an exact count, which is a slow and expensive operation.

The estimated count is based on current system statistics at the time the request is received by the database server.

The caller must have the SELECT permission on the system keyspace. For more information, see Manage roles and permissions.

Ready to write code? See the examples for this method to get started.

Result

The response includes a status.count property, which is an integer indicating the server-side estimate of the total number of documents in the collection.

Example response:

{
  "status": {
    "count": 37500
  }
}

Signature

The estimatedDocumentCount command doesn’t accept any parameters.

curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME/COLLECTION_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
  "estimatedDocumentCount": {}
}'

Parameters

Examples

The following example demonstrates how to estimate the number of documents in a collection.