IMongoCollectionTDocumentReplaceOneAsync Method (IClientSessionHandle, FilterDefinitionTDocument, TDocument, ReplaceOptions, CancellationToken) |
Replaces a single document.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.19.1+3a2a09dd959482f665ffbb5df2557ec541597af4
Syntax Task<ReplaceOneResult> ReplaceOneAsync(
IClientSessionHandle session,
FilterDefinition<TDocument> filter,
TDocument replacement,
ReplaceOptions options = null,
CancellationToken cancellationToken = default
)
Function ReplaceOneAsync (
session As IClientSessionHandle,
filter As FilterDefinition(Of TDocument),
replacement As TDocument,
Optional options As ReplaceOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of ReplaceOneResult)
abstract ReplaceOneAsync :
session : IClientSessionHandle *
filter : FilterDefinition<'TDocument> *
replacement : 'TDocument *
?options : ReplaceOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<ReplaceOneResult>
Parameters
- session
- Type: MongoDB.DriverIClientSessionHandle
The session. - filter
- Type: MongoDB.DriverFilterDefinitionTDocument
The filter. - replacement
- Type: TDocument
The replacement. - options (Optional)
- Type: MongoDB.DriverReplaceOptions
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
TaskReplaceOneResult
The result of the replacement.
See Also