IMongoCollectionTDocumentCountDocuments Method (IClientSessionHandle, FilterDefinitionTDocument, CountOptions, CancellationToken) |
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.16.0+eeafbea0921243a5868b81984e1083a07c1f75bc
Syntax long CountDocuments(
IClientSessionHandle session,
FilterDefinition<TDocument> filter,
CountOptions options = null,
CancellationToken cancellationToken = default
)
Function CountDocuments (
session As IClientSessionHandle,
filter As FilterDefinition(Of TDocument),
Optional options As CountOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Long
abstract CountDocuments :
session : IClientSessionHandle *
filter : FilterDefinition<'TDocument> *
?options : CountOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> 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:
Int64
The number of documents in the collection.
Remarks
Note: when migrating from Count to CountDocuments the following query operations must be replaced:
+-------------+--------------------------------+
| Operator | Replacement |
+=============+================================+
| $where | $expr |
+-------------+--------------------------------+
| $near | $geoWithin with $center |
+-------------+--------------------------------+
| $nearSphere | $geoWithin with $centerSphere |
+-------------+--------------------------------+
See Also