IMongoCollectionExtensionsFindSyncTDocument Method (IMongoCollectionTDocument, IClientSessionHandle, FilterDefinitionTDocument, FindOptionsTDocument, TDocument, CancellationToken) |
Finds the documents matching the filter.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.19.1+3a2a09dd959482f665ffbb5df2557ec541597af4
Syntax public static IAsyncCursor<TDocument> FindSync<TDocument>(
this IMongoCollection<TDocument> collection,
IClientSessionHandle session,
FilterDefinition<TDocument> filter,
FindOptions<TDocument, TDocument> options = null,
CancellationToken cancellationToken = default
)
<ExtensionAttribute>
Public Shared Function FindSync(Of TDocument) (
collection As IMongoCollection(Of TDocument),
session As IClientSessionHandle,
filter As FilterDefinition(Of TDocument),
Optional options As FindOptions(Of TDocument, TDocument) = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As IAsyncCursor(Of TDocument)
[<ExtensionAttribute>]
static member FindSync :
collection : IMongoCollection<'TDocument> *
session : IClientSessionHandle *
filter : FilterDefinition<'TDocument> *
?options : FindOptions<'TDocument, 'TDocument> *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> IAsyncCursor<'TDocument>
Parameters
- collection
- Type: MongoDB.DriverIMongoCollectionTDocument
The collection. - session
- Type: MongoDB.DriverIClientSessionHandle
The session. - 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:
IAsyncCursorTDocument
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
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