IMongoCollectionExtensionsCountAsyncTDocument Method (IMongoCollectionTDocument, IClientSessionHandle, ExpressionFuncTDocument, Boolean, CountOptions, CancellationToken) |
Note: This API is now obsolete.
Counts the number of documents in the collection.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.19.1+3a2a09dd959482f665ffbb5df2557ec541597af4
Syntax [ObsoleteAttribute("Use CountDocumentsAsync or EstimatedDocumentCountAsync instead.")]
public static Task<long> CountAsync<TDocument>(
this IMongoCollection<TDocument> collection,
IClientSessionHandle session,
Expression<Func<TDocument, bool>> filter,
CountOptions options = null,
CancellationToken cancellationToken = default
)
<ExtensionAttribute>
<ObsoleteAttribute("Use CountDocumentsAsync or EstimatedDocumentCountAsync instead.")>
Public Shared Function CountAsync(Of TDocument) (
collection As IMongoCollection(Of TDocument),
session As IClientSessionHandle,
filter As Expression(Of Func(Of TDocument, Boolean)),
Optional options As CountOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of Long)
[<ExtensionAttribute>]
[<ObsoleteAttribute("Use CountDocumentsAsync or EstimatedDocumentCountAsync instead.")>]
static member CountAsync :
collection : IMongoCollection<'TDocument> *
session : IClientSessionHandle *
filter : Expression<Func<'TDocument, bool>> *
?options : CountOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<int64>
Parameters
- collection
- Type: MongoDB.DriverIMongoCollectionTDocument
The collection. - session
- Type: MongoDB.DriverIClientSessionHandle
The session. - 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:
TaskInt64
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