Click or drag to resize

IMongoCollectionExtensionsFindOneAndDeleteAsyncTDocument Method (IMongoCollectionTDocument, IClientSessionHandle, FilterDefinitionTDocument, FindOneAndDeleteOptionsTDocument, TDocument, CancellationToken)

Finds a single document and deletes it atomically.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.11.0+cb27a82ea70620ad1acad8058809be8302ae4f2a
Syntax
public static Task<TDocument> FindOneAndDeleteAsync<TDocument>(
	this IMongoCollection<TDocument> collection,
	IClientSessionHandle session,
	FilterDefinition<TDocument> filter,
	FindOneAndDeleteOptions<TDocument, TDocument> options = null,
	CancellationToken cancellationToken = null
)

Parameters

collection
Type: MongoDB.DriverIMongoCollectionTDocument
The collection.
session
Type: MongoDB.DriverIClientSessionHandle
The session.
filter
Type: MongoDB.DriverFilterDefinitionTDocument
The filter.
options (Optional)
Type: MongoDB.DriverFindOneAndDeleteOptionsTDocument, TDocument
The options.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.

Type Parameters

TDocument
The type of the document.

Return Value

Type: TaskTDocument
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 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