IMongoCollectionExtensionsFindOneAndReplaceAsyncTDocument, TProjection Method (IMongoCollectionTDocument, IClientSessionHandle, ExpressionFuncTDocument, Boolean, TDocument, FindOneAndReplaceOptionsTDocument, TProjection, CancellationToken) |
Finds a single document and replaces it atomically.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.11.0+cb27a82ea70620ad1acad8058809be8302ae4f2a
Syntax public static Task<TProjection> FindOneAndReplaceAsync<TDocument, TProjection>(
this IMongoCollection<TDocument> collection,
IClientSessionHandle session,
Expression<Func<TDocument, bool>> filter,
TDocument replacement,
FindOneAndReplaceOptions<TDocument, TProjection> options = null,
CancellationToken cancellationToken = null
)
<ExtensionAttribute>
Public Shared Function FindOneAndReplaceAsync(Of TDocument, TProjection) (
collection As IMongoCollection(Of TDocument),
session As IClientSessionHandle,
filter As Expression(Of Func(Of TDocument, Boolean)),
replacement As TDocument,
Optional options As FindOneAndReplaceOptions(Of TDocument, TProjection) = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of TProjection)
[<ExtensionAttribute>]
static member FindOneAndReplaceAsync :
collection : IMongoCollection<'TDocument> *
session : IClientSessionHandle *
filter : Expression<Func<'TDocument, bool>> *
replacement : 'TDocument *
?options : FindOneAndReplaceOptions<'TDocument, 'TProjection> *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<'TProjection>
Parameters
- collection
- Type: MongoDB.DriverIMongoCollectionTDocument
The collection. - session
- Type: MongoDB.DriverIClientSessionHandle
The session. - filter
- Type: System.Linq.ExpressionsExpressionFuncTDocument, Boolean
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
- TDocument
- The type of the document.
- TProjection
- The type of the projection (same as TDocument if there is no projection).
Return Value
Type:
TaskTProjection
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