MongoDatabaseBaseDropCollectionAsync Method (IClientSessionHandle, String, DropCollectionOptions, CancellationToken) |
Drops the collection with the specified name.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.18.0+554c799eb1ec8dd732f16c739387f6664df1ba7a
Syntax public virtual Task DropCollectionAsync(
IClientSessionHandle session,
string name,
DropCollectionOptions options,
CancellationToken cancellationToken = default
)
Public Overridable Function DropCollectionAsync (
session As IClientSessionHandle,
name As String,
options As DropCollectionOptions,
Optional cancellationToken As CancellationToken = Nothing
) As Task
abstract DropCollectionAsync :
session : IClientSessionHandle *
name : string *
options : DropCollectionOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task
override DropCollectionAsync :
session : IClientSessionHandle *
name : string *
options : DropCollectionOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task
Parameters
- session
- Type: MongoDB.DriverIClientSessionHandle
The session. - name
- Type: SystemString
The name of the collection to drop. - options
- Type: MongoDB.DriverDropCollectionOptions
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
Task
A task.
Implements
IMongoDatabaseDropCollectionAsync(IClientSessionHandle, String, DropCollectionOptions, CancellationToken)See Also