IMongoCollectionTDocumentReplaceOneAsync Method (FilterDefinitionTDocument, TDocument, UpdateOptions, CancellationToken) |
Note: This API is now obsolete.
Replaces a single document.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.19.1+3a2a09dd959482f665ffbb5df2557ec541597af4
Syntax [ObsoleteAttribute("Use the overload that takes a ReplaceOptions instead of an UpdateOptions.")]
Task<ReplaceOneResult> ReplaceOneAsync(
FilterDefinition<TDocument> filter,
TDocument replacement,
UpdateOptions options,
CancellationToken cancellationToken = default
)
<ObsoleteAttribute("Use the overload that takes a ReplaceOptions instead of an UpdateOptions.")>
Function ReplaceOneAsync (
filter As FilterDefinition(Of TDocument),
replacement As TDocument,
options As UpdateOptions,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of ReplaceOneResult)
[<ObsoleteAttribute("Use the overload that takes a ReplaceOptions instead of an UpdateOptions.")>]
abstract ReplaceOneAsync :
filter : FilterDefinition<'TDocument> *
replacement : 'TDocument *
options : UpdateOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<ReplaceOneResult>
Parameters
- filter
- Type: MongoDB.DriverFilterDefinitionTDocument
The filter. - replacement
- Type: TDocument
The replacement. - options
- Type: MongoDB.DriverUpdateOptions
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
TaskReplaceOneResult
The result of the replacement.
See Also