MongoCollectionBaseTDocumentEstimatedDocumentCount Method |
Returns an estimate of the number of documents in the collection.
Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
Syntaxpublic virtual long EstimatedDocumentCount( EstimatedDocumentCountOptions options = null, CancellationToken cancellationToken = null )
Parameters
- options (Optional)
- Type: MongoDB.DriverEstimatedDocumentCountOptions
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type: Int64An estimate of the number of documents in the collection.
Implements
IMongoCollectionTDocumentEstimatedDocumentCount(EstimatedDocumentCountOptions, CancellationToken)Remarks
Due to an oversight in versions 5.0.0-5.0.8 of MongoDB, the count command, which estimatedDocumentCount uses
in its implementation, was not included in v1 of the Stable API. If you are using the Stable API with
estimatedDocumentCount, you must upgrade to server version 5.0.9+ or set strict: false when configuring
ServerApi to avoid encountering errors.
See Also