IMongoCollectionExtensionsFindAsyncTDocument Method (IMongoCollectionTDocument, FilterDefinitionTDocument, FindOptionsTDocument, TDocument, CancellationToken) |
Finds the documents matching the filter.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.18.0+554c799eb1ec8dd732f16c739387f6664df1ba7a
Syntax public static Task<IAsyncCursor<TDocument>> FindAsync<TDocument>(
this IMongoCollection<TDocument> collection,
FilterDefinition<TDocument> filter,
FindOptions<TDocument, TDocument> options = null,
CancellationToken cancellationToken = default
)
<ExtensionAttribute>
Public Shared Function FindAsync(Of TDocument) (
collection As IMongoCollection(Of TDocument),
filter As FilterDefinition(Of TDocument),
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> *
filter : FilterDefinition<'TDocument> *
?options : FindOptions<'TDocument, 'TDocument> *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<IAsyncCursor<'TDocument>>
Parameters
- collection
- Type: MongoDB.DriverIMongoCollectionTDocument
The collection. - filter
- Type: MongoDB.DriverFilterDefinitionTDocument
The filter. - options (Optional)
- Type: MongoDB.DriverFindOptionsTDocument, TDocument
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Type Parameters
- TDocument
- The type of the document.
Return Value
Type:
TaskIAsyncCursorTDocumentA 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
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