IMongoCollectionExtensionsFindOneAndUpdateTDocument Method (IMongoCollectionTDocument, FilterDefinitionTDocument, UpdateDefinitionTDocument, FindOneAndUpdateOptionsTDocument, TDocument, CancellationToken) |
Finds a single document and updates it atomically.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.11.0+cb27a82ea70620ad1acad8058809be8302ae4f2a
Syntax public static TDocument FindOneAndUpdate<TDocument>(
this IMongoCollection<TDocument> collection,
FilterDefinition<TDocument> filter,
UpdateDefinition<TDocument> update,
FindOneAndUpdateOptions<TDocument, TDocument> options = null,
CancellationToken cancellationToken = null
)
<ExtensionAttribute>
Public Shared Function FindOneAndUpdate(Of TDocument) (
collection As IMongoCollection(Of TDocument),
filter As FilterDefinition(Of TDocument),
update As UpdateDefinition(Of TDocument),
Optional options As FindOneAndUpdateOptions(Of TDocument, TDocument) = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As TDocument
[<ExtensionAttribute>]
static member FindOneAndUpdate :
collection : IMongoCollection<'TDocument> *
filter : FilterDefinition<'TDocument> *
update : UpdateDefinition<'TDocument> *
?options : FindOneAndUpdateOptions<'TDocument, 'TDocument> *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> 'TDocument
Parameters
- collection
- Type: MongoDB.DriverIMongoCollectionTDocument
The collection. - filter
- Type: MongoDB.DriverFilterDefinitionTDocument
The filter. - update
- Type: MongoDB.DriverUpdateDefinitionTDocument
The update. - options (Optional)
- Type: MongoDB.DriverFindOneAndUpdateOptionsTDocument, TDocument
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Type Parameters
- TDocument
- The type of the document.
Return Value
Type:
TDocument
The returned document.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
IMongoCollectionTDocument. 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