IMongoCollectionExtensionsDeleteOneTDocument Method (IMongoCollectionTDocument, ExpressionFuncTDocument, Boolean, DeleteOptions, CancellationToken) |
Deletes a single document.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.17.0+b316340e6cc3a8bfc8638dc31b54fbbfe41bfcb2
Syntax public static DeleteResult DeleteOne<TDocument>(
this IMongoCollection<TDocument> collection,
Expression<Func<TDocument, bool>> filter,
DeleteOptions options,
CancellationToken cancellationToken = default
)
<ExtensionAttribute>
Public Shared Function DeleteOne(Of TDocument) (
collection As IMongoCollection(Of TDocument),
filter As Expression(Of Func(Of TDocument, Boolean)),
options As DeleteOptions,
Optional cancellationToken As CancellationToken = Nothing
) As DeleteResult
[<ExtensionAttribute>]
static member DeleteOne :
collection : IMongoCollection<'TDocument> *
filter : Expression<Func<'TDocument, bool>> *
options : DeleteOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> 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:
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
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