MongoCollectionBaseTDocumentCountDocumentsAsync 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.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
Syntax public virtual Task<long> CountDocumentsAsync(
FilterDefinition<TDocument> filter,
CountOptions options = null,
CancellationToken cancellationToken = null
)
Public Overridable Function CountDocumentsAsync (
filter As FilterDefinition(Of TDocument),
Optional options As CountOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of Long)
abstract CountDocumentsAsync :
filter : FilterDefinition<'TDocument> *
?options : CountOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<int64>
override CountDocumentsAsync :
filter : FilterDefinition<'TDocument> *
?options : CountOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<int64>
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.
Implements
IMongoCollectionTDocumentCountDocumentsAsync(FilterDefinitionTDocument, CountOptions, CancellationToken)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