MongoCollectionBase<TDocument>.FindOneAndDelete<TProjection> Method (IClientSessionHandle, FilterDefinition<TDocument>, FindOneAndDeleteOptions<TDocument, TProjection>, CancellationToken) |
Finds a single document and deletes it atomically.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
Syntaxpublic virtual TProjection FindOneAndDelete<TProjection>(
IClientSessionHandle session,
FilterDefinition<TDocument> filter,
FindOneAndDeleteOptions<TDocument, TProjection> options = null,
CancellationToken cancellationToken = null
)
Public Overridable Function FindOneAndDelete(Of TProjection) (
session As IClientSessionHandle,
filter As FilterDefinition(Of TDocument),
Optional options As FindOneAndDeleteOptions(Of TDocument, TProjection) = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As TProjection
abstract FindOneAndDelete :
session : IClientSessionHandle *
filter : FilterDefinition<'TDocument> *
?options : FindOneAndDeleteOptions<'TDocument, 'TProjection> *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> 'TProjection
override FindOneAndDelete :
session : IClientSessionHandle *
filter : FilterDefinition<'TDocument> *
?options : FindOneAndDeleteOptions<'TDocument, 'TProjection> *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> 'TProjection
Parameters
- session
- Type: MongoDB.Driver.IClientSessionHandle
The session. - filter
- Type: MongoDB.Driver.FilterDefinition<TDocument>
The filter. - options (Optional)
- Type: MongoDB.Driver.FindOneAndDeleteOptions<TDocument, TProjection>
The options. - cancellationToken (Optional)
- Type: System.Threading.CancellationToken
The cancellation token.
Type Parameters
- TProjection
- The type of the projection (same as TDocument if there is no projection).
Return Value
Type:
TProjection
The returned document.
Implements
IMongoCollection<TDocument>.FindOneAndDelete<TProjection>(IClientSessionHandle, FilterDefinition<TDocument>, FindOneAndDeleteOptions<TDocument, TProjection>, CancellationToken)
See Also