MongoCollectionBaseTDocumentFindOneAndUpdateAsyncTProjection Method (IClientSessionHandle, FilterDefinitionTDocument, UpdateDefinitionTDocument, FindOneAndUpdateOptionsTDocument, TProjection, CancellationToken) |
Finds a single document and updates it atomically.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.18.0+554c799eb1ec8dd732f16c739387f6664df1ba7a
Syntax public virtual Task<TProjection> FindOneAndUpdateAsync<TProjection>(
IClientSessionHandle session,
FilterDefinition<TDocument> filter,
UpdateDefinition<TDocument> update,
FindOneAndUpdateOptions<TDocument, TProjection> options = null,
CancellationToken cancellationToken = default
)
Public Overridable Function FindOneAndUpdateAsync(Of TProjection) (
session As IClientSessionHandle,
filter As FilterDefinition(Of TDocument),
update As UpdateDefinition(Of TDocument),
Optional options As FindOneAndUpdateOptions(Of TDocument, TProjection) = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of TProjection)
abstract FindOneAndUpdateAsync :
session : IClientSessionHandle *
filter : FilterDefinition<'TDocument> *
update : UpdateDefinition<'TDocument> *
?options : FindOneAndUpdateOptions<'TDocument, 'TProjection> *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<'TProjection>
override FindOneAndUpdateAsync :
session : IClientSessionHandle *
filter : FilterDefinition<'TDocument> *
update : UpdateDefinition<'TDocument> *
?options : FindOneAndUpdateOptions<'TDocument, 'TProjection> *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<'TProjection>
Parameters
- session
- Type: MongoDB.DriverIClientSessionHandle
The session. - filter
- Type: MongoDB.DriverFilterDefinitionTDocument
The filter. - update
- Type: MongoDB.DriverUpdateDefinitionTDocument
The update. - options (Optional)
- Type: MongoDB.DriverFindOneAndUpdateOptionsTDocument, TProjection
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Type Parameters
- TProjection
- The type of the projection (same as TDocument if there is no projection).
Return Value
Type:
TaskTProjection
The returned document.
Implements
IMongoCollectionTDocumentFindOneAndUpdateAsyncTProjection(IClientSessionHandle, FilterDefinitionTDocument, UpdateDefinitionTDocument, FindOneAndUpdateOptionsTDocument, TProjection, CancellationToken)See Also