MongoCollectionBase<TDocument>.DeleteOne Method (FilterDefinition<TDocument>, DeleteOptions, CancellationToken) |
Deletes a single document.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
Syntaxpublic virtual DeleteResult DeleteOne(
FilterDefinition<TDocument> filter,
DeleteOptions options,
CancellationToken cancellationToken = null
)
Public Overridable Function DeleteOne (
filter As FilterDefinition(Of TDocument),
options As DeleteOptions,
Optional cancellationToken As CancellationToken = Nothing
) As DeleteResult
abstract DeleteOne :
filter : FilterDefinition<'TDocument> *
options : DeleteOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken null
*)
-> DeleteResult
override DeleteOne :
filter : FilterDefinition<'TDocument> *
options : DeleteOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken null
*)
-> DeleteResult
Parameters
- filter
- Type: MongoDB.Driver.FilterDefinition<TDocument>
The filter. - options
- Type: MongoDB.Driver.DeleteOptions
The options. - cancellationToken (Optional)
- Type: System.Threading.CancellationToken
The cancellation token.
Return Value
Type:
DeleteResult
The result of the delete operation.
Implements
IMongoCollection<TDocument>.DeleteOne(FilterDefinition<TDocument>, DeleteOptions, CancellationToken)
See Also