IMongoCollectionExtensionsFindOneAndDeleteAsyncTDocument, TProjection Method (IMongoCollectionTDocument, IClientSessionHandle, ExpressionFuncTDocument, Boolean, FindOneAndDeleteOptionsTDocument, TProjection, CancellationToken) (original) (raw)

Finds a single document and deletes it atomically.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.10.0+569905ff5e778c38ea19d9d0392496a83e1704ed

Syntax

public static Task FindOneAndDeleteAsync<TDocument, TProjection>( this IMongoCollection collection, IClientSessionHandle session, Expression<Func<TDocument, bool>> filter, FindOneAndDeleteOptions<TDocument, TProjection> options = null, CancellationToken cancellationToken = null )

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)

[] 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.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: TaskTProjection
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

Reference