IMongoIndexManagerTDocumentDropOneAsync Method (IClientSessionHandle, String, DropIndexOptions, CancellationToken) |
Drops an index by its name.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.16.0+eeafbea0921243a5868b81984e1083a07c1f75bc
Syntax Task DropOneAsync(
IClientSessionHandle session,
string name,
DropIndexOptions options,
CancellationToken cancellationToken = default
)
Function DropOneAsync (
session As IClientSessionHandle,
name As String,
options As DropIndexOptions,
Optional cancellationToken As CancellationToken = Nothing
) As Task
abstract DropOneAsync :
session : IClientSessionHandle *
name : string *
options : DropIndexOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task
Parameters
- session
- Type: MongoDB.DriverIClientSessionHandle
The session. - name
- Type: SystemString
The name. - options
- Type: MongoDB.DriverDropIndexOptions
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
Task
A task.
See Also