Method FindOneAndDeleteAsync
| MongoDB CSharp Driver API Reference (original) (raw)
Namespace
Assembly
MongoDB.Driver.dll
FindOneAndDeleteAsync(IMongoCollection, FilterDefinition, FindOneAndDeleteOptions<TDocument, TDocument>, CancellationToken)
Finds a single document and deletes it atomically.
public static Task<TDocument> FindOneAndDeleteAsync<TDocument>(this IMongoCollection<TDocument> collection, FilterDefinition<TDocument> filter, FindOneAndDeleteOptions<TDocument, TDocument> options = null, CancellationToken cancellationToken = default)Parameters
collection IMongoCollection
The collection.
filter FilterDefinition
The filter.
options FindOneAndDeleteOptions<TDocument, TDocument>
The options.
cancellationToken CancellationToken
The cancellation token.
Returns
The deleted document if one was deleted.
Type Parameters
TDocument
The type of the document.
FindOneAndDeleteAsync(IMongoCollection, Expression<Func<TDocument, bool>>, FindOneAndDeleteOptions, CancellationToken)
Finds a single document and deletes it atomically.
public static Task<TDocument> FindOneAndDeleteAsync<TDocument>(this IMongoCollection<TDocument> collection, Expression<Func<TDocument, bool>> filter, FindOneAndDeleteOptions<TDocument> options = null, CancellationToken cancellationToken = default)Parameters
collection IMongoCollection
The collection.
filter Expression<Func<TDocument, bool>>
The filter.
options FindOneAndDeleteOptions
The options.
cancellationToken CancellationToken
The cancellation token.
Returns
The deleted document if one was deleted.
Type Parameters
TDocument
The type of the document.
FindOneAndDeleteAsync<TDocument, TProjection>(IMongoCollection, Expression<Func<TDocument, bool>>, FindOneAndDeleteOptions<TDocument, TProjection>, CancellationToken)
Finds a single document and deletes it atomically.
public static Task<TProjection> FindOneAndDeleteAsync<TDocument, TProjection>(this IMongoCollection<TDocument> collection, Expression<Func<TDocument, bool>> filter, FindOneAndDeleteOptions<TDocument, TProjection> options = null, CancellationToken cancellationToken = default)Parameters
collection IMongoCollection
The collection.
filter Expression<Func<TDocument, bool>>
The filter.
options FindOneAndDeleteOptions<TDocument, TProjection>
The options.
cancellationToken CancellationToken
The cancellation token.
Returns
The returned document.
Type Parameters
TDocument
The type of the document.
TProjection
The type of the projection (same as TDocument if there is no projection).
FindOneAndDeleteAsync(IMongoCollection, IClientSessionHandle, FilterDefinition, FindOneAndDeleteOptions<TDocument, TDocument>, CancellationToken)
Finds a single document and deletes it atomically.
public static Task<TDocument> FindOneAndDeleteAsync<TDocument>(this IMongoCollection<TDocument> collection, IClientSessionHandle session, FilterDefinition<TDocument> filter, FindOneAndDeleteOptions<TDocument, TDocument> options = null, CancellationToken cancellationToken = default)Parameters
collection IMongoCollection
The collection.
session IClientSessionHandle
The session.
filter FilterDefinition
The filter.
options FindOneAndDeleteOptions<TDocument, TDocument>
The options.
cancellationToken CancellationToken
The cancellation token.
Returns
The deleted document if one was deleted.
Type Parameters
TDocument
The type of the document.
FindOneAndDeleteAsync(IMongoCollection, IClientSessionHandle, Expression<Func<TDocument, bool>>, FindOneAndDeleteOptions<TDocument, TDocument>, CancellationToken)
Finds a single document and deletes it atomically.
public static Task<TDocument> FindOneAndDeleteAsync<TDocument>(this IMongoCollection<TDocument> collection, IClientSessionHandle session, Expression<Func<TDocument, bool>> filter, FindOneAndDeleteOptions<TDocument, TDocument> options = null, CancellationToken cancellationToken = default)Parameters
collection IMongoCollection
The collection.
session IClientSessionHandle
The session.
filter Expression<Func<TDocument, bool>>
The filter.
options FindOneAndDeleteOptions<TDocument, TDocument>
The options.
cancellationToken CancellationToken
The cancellation token.
Returns
The deleted document if one was deleted.
Type Parameters
TDocument
The type of the document.
FindOneAndDeleteAsync<TDocument, TProjection>(IMongoCollection, IClientSessionHandle, Expression<Func<TDocument, bool>>, FindOneAndDeleteOptions<TDocument, TProjection>, CancellationToken)
Finds a single document and deletes it atomically.
public static Task<TProjection> FindOneAndDeleteAsync<TDocument, TProjection>(this IMongoCollection<TDocument> collection, IClientSessionHandle session, Expression<Func<TDocument, bool>> filter, FindOneAndDeleteOptions<TDocument, TProjection> options = null, CancellationToken cancellationToken = default)Parameters
collection IMongoCollection
The collection.
session IClientSessionHandle
The session.
filter Expression<Func<TDocument, bool>>
The filter.
options FindOneAndDeleteOptions<TDocument, TProjection>
The options.
cancellationToken CancellationToken
The cancellation token.
Returns
The returned document.
Type Parameters
TDocument
The type of the document.
TProjection
The type of the projection (same as TDocument if there is no projection).