IMongoCollectionExtensions.FindOneAndDeleteAsync<TDocument, TProjection> Method (IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, Boolean>>, FindOneAndDeleteOptions<TDocument, TProjection>, CancellationToken) |
Finds a single document and deletes it atomically.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.8.0+cc573f3e1f48f39162b4b680e921a623e127e8fa
Syntax public static Task<TProjection> FindOneAndDeleteAsync<TDocument, TProjection>(
this IMongoCollection<TDocument> collection,
IClientSessionHandle session,
Expression<Func<TDocument, bool>> filter,
FindOneAndDeleteOptions<TDocument, TProjection> options = null,
CancellationToken cancellationToken = null
)
<ExtensionAttribute>
Public Shared Function FindOneAndDeleteAsync(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 Task(Of TProjection)
[<ExtensionAttribute>]
static member FindOneAndDeleteAsync :
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 null
*)
-> Task<'TProjection>
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. - options (Optional)
- Type: MongoDB.Driver.FindOneAndDeleteOptions<TDocument, TProjection>
The options. - cancellationToken (Optional)
- Type: System.Threading.CancellationToken
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:
Task<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
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