IMongoCollectionExtensions.DeleteOneAsync<TDocument> Method |
Deletes a single document.
Namespace: MongoDB.DriverAssembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.3.0
Syntaxpublic static Task<DeleteResult> DeleteOneAsync<TDocument>(
this IMongoCollection<TDocument> collection,
Expression<Func<TDocument, bool>> filter,
CancellationToken cancellationToken = null
)
<ExtensionAttribute>
Public Shared Function DeleteOneAsync(Of TDocument) (
collection As IMongoCollection(Of TDocument),
filter As Expression(Of Func(Of TDocument, Boolean)),
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of DeleteResult)
[<ExtensionAttribute>]
static member DeleteOneAsync :
collection : IMongoCollection<'TDocument> *
filter : Expression<Func<'TDocument, bool>> *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<DeleteResult>
Parameters
- collection
- Type: MongoDB.Driver.IMongoCollection<TDocument>
The collection. - filter
- Type: System.Linq.Expressions.Expression<Func<TDocument, Boolean>>
The filter. - cancellationToken (Optional)
- Type: System.Threading.CancellationToken
The cancellation token.
Type Parameters
- TDocument
- The type of the document.
Return Value
Type:
Task<DeleteResult>
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
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