IMongoCollectionExtensionsDeleteOneAsyncTDocument Method (IMongoCollectionTDocument, ExpressionFuncTDocument, Boolean, DeleteOptions, CancellationToken) |
Deletes a single document.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.16.0+eeafbea0921243a5868b81984e1083a07c1f75bc
Syntax public static Task<DeleteResult> DeleteOneAsync<TDocument>(
this IMongoCollection<TDocument> collection,
Expression<Func<TDocument, bool>> filter,
DeleteOptions options,
CancellationToken cancellationToken = default
)
<ExtensionAttribute>
Public Shared Function DeleteOneAsync(Of TDocument) (
collection As IMongoCollection(Of TDocument),
filter As Expression(Of Func(Of TDocument, Boolean)),
options As DeleteOptions,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of DeleteResult)
[<ExtensionAttribute>]
static member DeleteOneAsync :
collection : IMongoCollection<'TDocument> *
filter : Expression<Func<'TDocument, bool>> *
options : DeleteOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<DeleteResult>
Parameters
- collection
- Type: MongoDB.DriverIMongoCollectionTDocument
The collection. - filter
- Type: System.Linq.ExpressionsExpressionFuncTDocument, Boolean
The filter. - options
- Type: MongoDB.DriverDeleteOptions
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Type Parameters
- TDocument
- The type of the document.
Return Value
Type:
TaskDeleteResult
The result of the delete operation.
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