IMongoCollectionExtensions.FindOneAndDelete<TDocument> Method (IMongoCollection<TDocument>, IClientSessionHandle, FilterDefinition<TDocument>, FindOneAndDeleteOptions<TDocument, TDocument>, CancellationToken) |
Finds a single document and deletes it atomically.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.9.0+32b058abcdf2c7e8d9dd3a676d207b31897eee2e
Syntax public static TDocument FindOneAndDelete<TDocument>(
this IMongoCollection<TDocument> collection,
IClientSessionHandle session,
FilterDefinition<TDocument> filter,
FindOneAndDeleteOptions<TDocument, TDocument> options = null,
CancellationToken cancellationToken = null
)
<ExtensionAttribute>
Public Shared Function FindOneAndDelete(Of TDocument) (
collection As IMongoCollection(Of TDocument),
session As IClientSessionHandle,
filter As FilterDefinition(Of TDocument),
Optional options As FindOneAndDeleteOptions(Of TDocument, TDocument) = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As TDocument
[<ExtensionAttribute>]
static member FindOneAndDelete :
collection : IMongoCollection<'TDocument> *
session : IClientSessionHandle *
filter : FilterDefinition<'TDocument> *
?options : FindOneAndDeleteOptions<'TDocument, 'TDocument> *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> 'TDocument
Parameters
- collection
- Type: MongoDB.Driver.IMongoCollection<TDocument>
The collection. - session
- Type: MongoDB.Driver.IClientSessionHandle
The session. - filter
- Type: MongoDB.Driver.FilterDefinition<TDocument>
The filter. - options (Optional)
- Type: MongoDB.Driver.FindOneAndDeleteOptions<TDocument, TDocument>
The options. - cancellationToken (Optional)
- Type: System.Threading.CancellationToken
The cancellation token.
Type Parameters
- TDocument
- The type of the document.
Return Value
Type:
TDocument
The deleted document if one was deleted.
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