MongoCollectionBaseTDocumentReplaceOne Method (IClientSessionHandle, FilterDefinitionTDocument, TDocument, ReplaceOptions, CancellationToken) |
Replaces a single document.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e
Syntax public virtual ReplaceOneResult ReplaceOne(
IClientSessionHandle session,
FilterDefinition<TDocument> filter,
TDocument replacement,
ReplaceOptions options = null,
CancellationToken cancellationToken = default
)
Public Overridable Function ReplaceOne (
session As IClientSessionHandle,
filter As FilterDefinition(Of TDocument),
replacement As TDocument,
Optional options As ReplaceOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As ReplaceOneResult
abstract ReplaceOne :
session : IClientSessionHandle *
filter : FilterDefinition<'TDocument> *
replacement : 'TDocument *
?options : ReplaceOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> ReplaceOneResult
override ReplaceOne :
session : IClientSessionHandle *
filter : FilterDefinition<'TDocument> *
replacement : 'TDocument *
?options : ReplaceOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> 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:
ReplaceOneResult
The result of the replacement.
Implements
IMongoCollectionTDocumentReplaceOne(IClientSessionHandle, FilterDefinitionTDocument, TDocument, ReplaceOptions, CancellationToken)See Also