IMongoCollectionExtensions.DeleteMany<TDocument> Method (IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, Boolean>>, DeleteOptions, CancellationToken) |
Deletes multiple documents.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.10.0+569905ff5e778c38ea19d9d0392496a83e1704ed
Syntaxpublic static DeleteResult DeleteMany<TDocument>(
this IMongoCollection<TDocument> collection,
IClientSessionHandle session,
Expression<Func<TDocument, bool>> filter,
DeleteOptions options = null,
CancellationToken cancellationToken = null
)
<ExtensionAttribute>
Public Shared Function DeleteMany(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
[<ExtensionAttribute>]
static member DeleteMany :
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.Driver.IMongoCollection<TDocument>
The collection. - session
- Type: MongoDB.Driver.IClientSessionHandle
The session. - filter
- Type: System.Linq.Expressions.Expression<Func<TDocument, Boolean>>
The filter. - options (Optional)
- Type: MongoDB.Driver.DeleteOptions
The options. - cancellationToken (Optional)
- Type: System.Threading.CancellationToken
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
IMongoCollection<TDocument>. 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