IMongoCollection<TDocument>.UpdateOne Method (IClientSessionHandle, FilterDefinition<TDocument>, UpdateDefinition<TDocument>, UpdateOptions, CancellationToken) |
Updates a single document.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e
Syntax UpdateResult UpdateOne(
IClientSessionHandle session,
FilterDefinition<TDocument> filter,
UpdateDefinition<TDocument> update,
UpdateOptions options = null,
CancellationToken cancellationToken = default
)
Function UpdateOne (
session As IClientSessionHandle,
filter As FilterDefinition(Of TDocument),
update As UpdateDefinition(Of TDocument),
Optional options As UpdateOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As UpdateResult
abstract UpdateOne :
session : IClientSessionHandle *
filter : FilterDefinition<'TDocument> *
update : UpdateDefinition<'TDocument> *
?options : UpdateOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> UpdateResult
Parameters
- session
- Type: MongoDB.Driver.IClientSessionHandle
The session. - filter
- Type: MongoDB.Driver.FilterDefinition<TDocument>
The filter. - update
- Type: MongoDB.Driver.UpdateDefinition<TDocument>
The update. - options (Optional)
- Type: MongoDB.Driver.UpdateOptions
The options. - cancellationToken (Optional)
- Type: System.Threading.CancellationToken
The cancellation token.
Return Value
Type:
UpdateResult
The result of the update operation.
See Also