IMongoCollectionTDocumentFindOneAndReplaceAsyncTProjection Method (IClientSessionHandle, FilterDefinitionTDocument, TDocument, FindOneAndReplaceOptionsTDocument, TProjection, CancellationToken) |
Finds a single document and replaces it atomically.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.16.0+eeafbea0921243a5868b81984e1083a07c1f75bc
Syntax Task<TProjection> FindOneAndReplaceAsync<TProjection>(
IClientSessionHandle session,
FilterDefinition<TDocument> filter,
TDocument replacement,
FindOneAndReplaceOptions<TDocument, TProjection> options = null,
CancellationToken cancellationToken = default
)
Function FindOneAndReplaceAsync(Of TProjection) (
session As IClientSessionHandle,
filter As FilterDefinition(Of TDocument),
replacement As TDocument,
Optional options As FindOneAndReplaceOptions(Of TDocument, TProjection) = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of TProjection)
abstract FindOneAndReplaceAsync :
session : IClientSessionHandle *
filter : FilterDefinition<'TDocument> *
replacement : 'TDocument *
?options : FindOneAndReplaceOptions<'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. - replacement
- Type: TDocument
The replacement. - options (Optional)
- Type: MongoDB.DriverFindOneAndReplaceOptionsTDocument, 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.
See Also