IMongoCollectionExtensionsDeleteOneTDocument Method (IMongoCollectionTDocument, IClientSessionHandle, ExpressionFuncTDocument, Boolean, DeleteOptions, CancellationToken) (original) (raw)
Deletes a single document.
Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.10.0+569905ff5e778c38ea19d9d0392496a83e1704ed
Syntax
public static DeleteResult DeleteOne( this IMongoCollection collection, IClientSessionHandle session, Expression<Func<TDocument, bool>> filter, DeleteOptions options = null, CancellationToken cancellationToken = null )
Public Shared Function DeleteOne(Of TDocument) ( collection As IMongoCollection(Of TDocument), session As IClientSessionHandle, filter As Expression(Of Func(Of TDocument, Boolean)), Optional options As DeleteOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing ) As DeleteResult[] static member DeleteOne : collection : IMongoCollection<'TDocument> * session : IClientSessionHandle * filter : Expression<Func<'TDocument, bool>> * ?options : DeleteOptions * ?cancellationToken : CancellationToken (* Defaults: let _options = defaultArg options null let _cancellationToken = defaultArg cancellationToken null *) -> DeleteResult
Parameters
collection
Type: MongoDB.DriverIMongoCollectionTDocument
The collection.
session
Type: MongoDB.DriverIClientSessionHandle
The session.
filter
Type: System.Linq.ExpressionsExpressionFuncTDocument, Boolean
The filter.
options (Optional)
Type: MongoDB.DriverDeleteOptions
The options.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.
Type Parameters
TDocument
The type of the document.
Return Value
Type: DeleteResult
The result of the delete operation.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type IMongoCollectionTDocument. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
See Also