IMongoCollectionExtensions.UpdateOne<TDocument> Method (IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, Boolean>>, UpdateDefinition<TDocument>, UpdateOptions, CancellationToken) |
Updates a single document.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e
Syntax public static UpdateResult UpdateOne<TDocument>(
this IMongoCollection<TDocument> collection,
IClientSessionHandle session,
Expression<Func<TDocument, bool>> filter,
UpdateDefinition<TDocument> update,
UpdateOptions options = null,
CancellationToken cancellationToken = default
)
<ExtensionAttribute>
Public Shared Function UpdateOne(Of TDocument) (
collection As IMongoCollection(Of TDocument),
session As IClientSessionHandle,
filter As Expression(Of Func(Of TDocument, Boolean)),
update As UpdateDefinition(Of TDocument),
Optional options As UpdateOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As UpdateResult
[<ExtensionAttribute>]
static member UpdateOne :
collection : IMongoCollection<'TDocument> *
session : IClientSessionHandle *
filter : Expression<Func<'TDocument, bool>> *
update : UpdateDefinition<'TDocument> *
?options : UpdateOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> UpdateResult
Parameters
- collection
- Type: MongoDB.Driver.IMongoCollection<TDocument>
The collection. - session
- Type: MongoDB.Driver.IClientSessionHandle
The session. - filter
- Type: System.Linq.Expressions.Expression<Func<TDocument, Boolean>>
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.
Type Parameters
- TDocument
- The type of the document.
Return Value
Type:
UpdateResult
The result of the update operation.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
IMongoCollection<TDocument>. When you use instance method syntax to call this method, omit the first parameter. For more information, see
Extension Methods (Visual Basic) or
Extension Methods (C# Programming Guide).
See Also