IMongoCollectionExtensions.FindOneAndReplaceAsync<TDocument> Method (IMongoCollection<TDocument>, FilterDefinition<TDocument>, TDocument, FindOneAndReplaceOptions<TDocument, TDocument>, CancellationToken) |
Finds a single document and replaces it atomically.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.14.0+2b37a1fe1cbdbe1a020b52b77f1197b6d77575e7
Syntax public static Task<TDocument> FindOneAndReplaceAsync<TDocument>(
this IMongoCollection<TDocument> collection,
FilterDefinition<TDocument> filter,
TDocument replacement,
FindOneAndReplaceOptions<TDocument, TDocument> options = null,
CancellationToken cancellationToken = default
)
<ExtensionAttribute>
Public Shared Function FindOneAndReplaceAsync(Of TDocument) (
collection As IMongoCollection(Of TDocument),
filter As FilterDefinition(Of TDocument),
replacement As TDocument,
Optional options As FindOneAndReplaceOptions(Of TDocument, TDocument) = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of TDocument)
[<ExtensionAttribute>]
static member FindOneAndReplaceAsync :
collection : IMongoCollection<'TDocument> *
filter : FilterDefinition<'TDocument> *
replacement : 'TDocument *
?options : FindOneAndReplaceOptions<'TDocument, 'TDocument> *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<'TDocument>
Parameters
- collection
- Type: MongoDB.Driver.IMongoCollection<TDocument>
The collection. - filter
- Type: MongoDB.Driver.FilterDefinition<TDocument>
The filter. - replacement
- Type: TDocument
The replacement. - options (Optional)
- Type: MongoDB.Driver.FindOneAndReplaceOptions<TDocument, TDocument>
The options. - cancellationToken (Optional)
- Type: System.Threading.CancellationToken
The cancellation token.
Type Parameters
- TDocument
- The type of the document.
Return Value
Type:
Task<TDocument>
The returned document.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
IMongoCollection<TDocument>. 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