IMongoCollectionExtensionsCountDocumentsTDocument Method (IMongoCollectionTDocument, ExpressionFuncTDocument, Boolean, CountOptions, CancellationToken) |
Counts the number of documents in the collection.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.9.0+32b058abcdf2c7e8d9dd3a676d207b31897eee2e
Syntax public static long CountDocuments<TDocument>(
this IMongoCollection<TDocument> collection,
Expression<Func<TDocument, bool>> filter,
CountOptions options = null,
CancellationToken cancellationToken = null
)
<ExtensionAttribute>
Public Shared Function CountDocuments(Of TDocument) (
collection As IMongoCollection(Of TDocument),
filter As Expression(Of Func(Of TDocument, Boolean)),
Optional options As CountOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Long
[<ExtensionAttribute>]
static member CountDocuments :
collection : IMongoCollection<'TDocument> *
filter : Expression<Func<'TDocument, bool>> *
?options : CountOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> int64
Parameters
- collection
- Type: MongoDB.DriverIMongoCollectionTDocument
The collection. - filter
- Type: System.Linq.ExpressionsExpressionFuncTDocument, Boolean
The filter. - options (Optional)
- Type: MongoDB.DriverCountOptions
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Type Parameters
- TDocument
- The type of the document.
Return Value
Type:
Int64
The number of documents in the collection.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
IMongoCollectionTDocument. When you use instance method syntax to call this method, omit the first parameter. For more information, see
Extension Methods (Visual Basic) or
Extension Methods (C# Programming Guide).
See Also