Click or drag to resize

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.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e
Syntax
public virtual long EstimatedDocumentCount(
	EstimatedDocumentCountOptions options = null,
	CancellationToken cancellationToken = default
)

Parameters

options (Optional)
Type: MongoDB.DriverEstimatedDocumentCountOptions
The options.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.

Return Value

Type: Int64
An 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