IMongoCollectionExtensionsFindOneAndDeleteTDocument, TProjection Method (IMongoCollectionTDocument, IClientSessionHandle, ExpressionFuncTDocument, Boolean, FindOneAndDeleteOptionsTDocument, TProjection, CancellationToken) |
Finds a single document and deletes it atomically.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.14.0+2b37a1fe1cbdbe1a020b52b77f1197b6d77575e7
Syntax public static TProjection FindOneAndDelete<TDocument, TProjection>(
this IMongoCollection<TDocument> collection,
IClientSessionHandle session,
Expression<Func<TDocument, bool>> filter,
FindOneAndDeleteOptions<TDocument, TProjection> options = null,
CancellationToken cancellationToken = default
)
<ExtensionAttribute>
Public Shared Function FindOneAndDelete(Of TDocument, TProjection) (
collection As IMongoCollection(Of TDocument),
session As IClientSessionHandle,
filter As Expression(Of Func(Of TDocument, Boolean)),
Optional options As FindOneAndDeleteOptions(Of TDocument, TProjection) = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As TProjection
[<ExtensionAttribute>]
static member FindOneAndDelete :
collection : IMongoCollection<'TDocument> *
session : IClientSessionHandle *
filter : Expression<Func<'TDocument, bool>> *
?options : FindOneAndDeleteOptions<'TDocument, 'TProjection> *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> 'TProjection
Parameters
- collection
- Type: MongoDB.DriverIMongoCollectionTDocument
The collection. - session
- Type: MongoDB.DriverIClientSessionHandle
The session. - filter
- Type: System.Linq.ExpressionsExpressionFuncTDocument, Boolean
The filter. - options (Optional)
- Type: MongoDB.DriverFindOneAndDeleteOptionsTDocument, TProjection
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Type Parameters
- TDocument
- The type of the document.
- TProjection
- The type of the projection (same as TDocument if there is no projection).
Return Value
Type:
TProjection
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