MongoCollectionBaseTDocumentDeleteOneAsync Method (IClientSessionHandle, FilterDefinitionTDocument, DeleteOptions, CancellationToken) |
Deletes a single document.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.15.0+f503bf610759c13f78cff9a3c01e91453185d2ed
Syntax public virtual Task<DeleteResult> DeleteOneAsync(
IClientSessionHandle session,
FilterDefinition<TDocument> filter,
DeleteOptions options = null,
CancellationToken cancellationToken = default
)
Public Overridable 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 new CancellationToken()
*)
-> Task<DeleteResult>
override DeleteOneAsync :
session : IClientSessionHandle *
filter : FilterDefinition<'TDocument> *
?options : DeleteOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<DeleteResult>
Parameters
- session
- Type: MongoDB.DriverIClientSessionHandle
The session. - filter
- Type: MongoDB.DriverFilterDefinitionTDocument
The filter. - options (Optional)
- Type: MongoDB.DriverDeleteOptions
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
TaskDeleteResult
The result of the delete operation.
Implements
IMongoCollectionTDocumentDeleteOneAsync(IClientSessionHandle, FilterDefinitionTDocument, DeleteOptions, CancellationToken)See Also