Click or drag to resize

IMongoCollectionTDocumentCountDocumentsAsync Method (FilterDefinitionTDocument, CountOptions, CancellationToken)

Counts the number of documents in the collection. For a fast estimate of the total documents in a collection see .

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.16.0+eeafbea0921243a5868b81984e1083a07c1f75bc
Syntax
Task<long> CountDocumentsAsync(
	FilterDefinition<TDocument> filter,
	CountOptions options = null,
	CancellationToken cancellationToken = default
)

Parameters

filter
Type: MongoDB.DriverFilterDefinitionTDocument
The filter.
options (Optional)
Type: MongoDB.DriverCountOptions
The options.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.

Return Value

Type: TaskInt64
The number of documents in the collection.
Remarks
Note: when migrating from CountAsync to CountDocumentsAsync the following query operations must be replaced:
+-------------+--------------------------------+
| Operator    | Replacement                    |
+=============+================================+
| $where      |  $expr                         |
+-------------+--------------------------------+
| $near       |  $geoWithin with $center       |
+-------------+--------------------------------+
| $nearSphere |  $geoWithin with $centerSphere |
+-------------+--------------------------------+
See Also