IMongoCollection<TDocument>.DeleteOneAsync Method (IClientSessionHandle, FilterDefinition<TDocument>, DeleteOptions, CancellationToken) |
Deletes a single document.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.10.0+569905ff5e778c38ea19d9d0392496a83e1704ed
SyntaxTask<DeleteResult> DeleteOneAsync(
IClientSessionHandle session,
FilterDefinition<TDocument> filter,
DeleteOptions options = null,
CancellationToken cancellationToken = null
)
Function DeleteOneAsync (
session As IClientSessionHandle,
filter As FilterDefinition(Of TDocument),
Optional options As DeleteOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of DeleteResult)
abstract DeleteOneAsync :
session : IClientSessionHandle *
filter : FilterDefinition<'TDocument> *
?options : DeleteOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<DeleteResult>
Parameters
- session
- Type: MongoDB.Driver.IClientSessionHandle
The session. - filter
- Type: MongoDB.Driver.FilterDefinition<TDocument>
The filter. - options (Optional)
- Type: MongoDB.Driver.DeleteOptions
The options. - cancellationToken (Optional)
- Type: System.Threading.CancellationToken
The cancellation token.
Return Value
Type:
Task<DeleteResult>
The result of the delete operation.
See Also