Estimate document count (TypeScript)
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. If you are new to the Data API, check out the quickstart. |
Result
Returns a promise that resolves to an integer indicating the server-side estimate of the total number of documents in the collection.
Parameters
Use the estimatedDocumentCount method, which belongs to the Collection class.
Method signature
async estimatedDocumentCount(
options?: {
timeout?: number | TimeoutDescriptor,
},
): number| Name | Type | Summary |
|---|---|---|
|
|
Optional.
The options for this operation. See Properties of |
| Name | Type | Summary |
|---|---|---|
|
|
Optional. The timeout(s) to apply to this method.
You can specify For more information about the |
Examples
The following example demonstrates how to estimate the number of documents in a collection.
Estimate document count
import {
DataAPIClient,
UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";
// Get an existing collection
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
keyspace: "KEYSPACE_NAME",
});
const collection = database.collection("COLLECTION_NAME");
(async function () {
// Estimate count
const result = await collection.estimatedDocumentCount();
console.log(result);
})();Client reference
For more information, see the client reference.
