Click or drag to resize

IMongoCollectionExtensions.CountDocumentsAsync<TDocument> Method (IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, Boolean>>, CountOptions, CancellationToken)

Counts the number of documents in the collection. For a fast estimate of the total documents in a collection see EstimatedDocumentCountAsync(EstimatedDocumentCountOptions, CancellationToken).

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.10.0+569905ff5e778c38ea19d9d0392496a83e1704ed
Syntax
public static Task<long> CountDocumentsAsync<TDocument>(
	this IMongoCollection<TDocument> collection,
	IClientSessionHandle session,
	Expression<Func<TDocument, bool>> filter,
	CountOptions options = null,
	CancellationToken cancellationToken = null
)

Parameters

collection
Type: MongoDB.Driver.IMongoCollection<TDocument>
The collection.
session
Type: MongoDB.Driver.IClientSessionHandle
The session.
filter
Type: System.Linq.Expressions.Expression<Func<TDocument, Boolean>>
The filter.
options (Optional)
Type: MongoDB.Driver.CountOptions
The options.
cancellationToken (Optional)
Type: System.Threading.CancellationToken
The cancellation token.

Type Parameters

TDocument
The type of the document.

Return Value

Type: Task<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 IMongoCollection<TDocument>. 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