IMongoCollectionExtensions.FindAsync<TDocument> Method (IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, Boolean>>, FindOptions<TDocument, TDocument>, CancellationToken) |
Finds the documents matching the filter.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
Syntaxpublic static Task<IAsyncCursor<TDocument>> FindAsync<TDocument>(
this IMongoCollection<TDocument> collection,
IClientSessionHandle session,
Expression<Func<TDocument, bool>> filter,
FindOptions<TDocument, TDocument> options = null,
CancellationToken cancellationToken = null
)
<ExtensionAttribute>
Public Shared Function FindAsync(Of TDocument) (
collection As IMongoCollection(Of TDocument),
session As IClientSessionHandle,
filter As Expression(Of Func(Of TDocument, Boolean)),
Optional options As FindOptions(Of TDocument, TDocument) = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of IAsyncCursor(Of TDocument))
[<ExtensionAttribute>]
static member FindAsync :
collection : IMongoCollection<'TDocument> *
session : IClientSessionHandle *
filter : Expression<Func<'TDocument, bool>> *
?options : FindOptions<'TDocument, 'TDocument> *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<IAsyncCursor<'TDocument>>
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.FindOptions<TDocument, TDocument>
The options. - cancellationToken (Optional)
- Type: System.Threading.CancellationToken
The cancellation token.
Type Parameters
- TDocument
- The type of the document.
Return Value
Type:
Task<IAsyncCursor<TDocument>>
A Task whose result is a cursor.
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