IMongoCollectionTDocumentEstimatedDocumentCount Method |
Returns an estimate of the number of documents in the collection.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.18.0+554c799eb1ec8dd732f16c739387f6664df1ba7a
Syntax long EstimatedDocumentCount(
EstimatedDocumentCountOptions options = null,
CancellationToken cancellationToken = default
)
Function EstimatedDocumentCount (
Optional options As EstimatedDocumentCountOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Long
abstract EstimatedDocumentCount :
?options : EstimatedDocumentCountOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> int64
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.
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