IMongoCollectionTDocumentCountDocumentsAsync Method (IClientSessionHandle, FilterDefinitionTDocument, CountOptions, CancellationToken) |
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.14.0+2b37a1fe1cbdbe1a020b52b77f1197b6d77575e7
Syntax Task<long> CountDocumentsAsync(
IClientSessionHandle session,
FilterDefinition<TDocument> filter,
CountOptions options = null,
CancellationToken cancellationToken = default
)
Function CountDocumentsAsync (
session As IClientSessionHandle,
filter As FilterDefinition(Of TDocument),
Optional options As CountOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of Long)
abstract CountDocumentsAsync :
session : IClientSessionHandle *
filter : FilterDefinition<'TDocument> *
?options : CountOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<int64>
Parameters
- session
- Type: MongoDB.DriverIClientSessionHandle
The session. - 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