MongoCollectionBaseTDocumentUpdateOne Method (IClientSessionHandle, FilterDefinitionTDocument, UpdateDefinitionTDocument, UpdateOptions, CancellationToken) |
Updates a single document.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.11.0+cb27a82ea70620ad1acad8058809be8302ae4f2a
Syntax public virtual UpdateResult UpdateOne(
IClientSessionHandle session,
FilterDefinition<TDocument> filter,
UpdateDefinition<TDocument> update,
UpdateOptions options = null,
CancellationToken cancellationToken = null
)
Public Overridable 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 null
*)
-> UpdateResult
override UpdateOne :
session : IClientSessionHandle *
filter : FilterDefinition<'TDocument> *
update : UpdateDefinition<'TDocument> *
?options : UpdateOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> UpdateResult
Parameters
- session
- Type: MongoDB.DriverIClientSessionHandle
The session. - filter
- Type: MongoDB.DriverFilterDefinitionTDocument
The filter. - update
- Type: MongoDB.DriverUpdateDefinitionTDocument
The update. - options (Optional)
- Type: MongoDB.DriverUpdateOptions
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
UpdateResult
The result of the update operation.
Implements
IMongoCollectionTDocumentUpdateOne(IClientSessionHandle, FilterDefinitionTDocument, UpdateDefinitionTDocument, UpdateOptions, CancellationToken)See Also