MongoCollectionBaseTDocumentCountDocuments Method (FilterDefinitionTDocument, CountOptions, CancellationToken) |
Counts the number of documents in the collection.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.7.3+Branch.v2.7.x.Sha.2f1f2be13a23b8520cb9c2ee8439c022f9a03efe
Syntax public virtual long CountDocuments(
FilterDefinition<TDocument> filter,
CountOptions options = null,
CancellationToken cancellationToken = null
)
Public Overridable Function CountDocuments (
filter As FilterDefinition(Of TDocument),
Optional options As CountOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Long
abstract CountDocuments :
filter : FilterDefinition<'TDocument> *
?options : CountOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> int64
override CountDocuments :
filter : FilterDefinition<'TDocument> *
?options : CountOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> 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:
Int64
The number of documents in the collection.
Implements
IMongoCollectionTDocumentCountDocuments(FilterDefinitionTDocument, CountOptions, CancellationToken)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