IMongoCollectionExtensionsFindOneAndUpdateAsyncTDocument Method (IMongoCollectionTDocument, IClientSessionHandle, FilterDefinitionTDocument, UpdateDefinitionTDocument, FindOneAndUpdateOptionsTDocument, TDocument, CancellationToken) |
Finds a single document and updates it atomically.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.15.0+f503bf610759c13f78cff9a3c01e91453185d2ed
Syntax public static Task<TDocument> FindOneAndUpdateAsync<TDocument>(
this IMongoCollection<TDocument> collection,
IClientSessionHandle session,
FilterDefinition<TDocument> filter,
UpdateDefinition<TDocument> update,
FindOneAndUpdateOptions<TDocument, TDocument> options = null,
CancellationToken cancellationToken = default
)
<ExtensionAttribute>
Public Shared Function FindOneAndUpdateAsync(Of TDocument) (
collection As IMongoCollection(Of TDocument),
session As IClientSessionHandle,
filter As FilterDefinition(Of TDocument),
update As UpdateDefinition(Of TDocument),
Optional options As FindOneAndUpdateOptions(Of TDocument, TDocument) = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of TDocument)
[<ExtensionAttribute>]
static member FindOneAndUpdateAsync :
collection : IMongoCollection<'TDocument> *
session : IClientSessionHandle *
filter : FilterDefinition<'TDocument> *
update : UpdateDefinition<'TDocument> *
?options : FindOneAndUpdateOptions<'TDocument, 'TDocument> *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<'TDocument>
Parameters
- collection
- Type: MongoDB.DriverIMongoCollectionTDocument
The collection. - session
- Type: MongoDB.DriverIClientSessionHandle
The session. - filter
- Type: MongoDB.DriverFilterDefinitionTDocument
The filter. - update
- Type: MongoDB.DriverUpdateDefinitionTDocument
The update. - options (Optional)
- Type: MongoDB.DriverFindOneAndUpdateOptionsTDocument, TDocument
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Type Parameters
- TDocument
- The type of the document.
Return Value
Type:
TaskTDocument
The returned document.
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