IMongoIndexManagerTDocumentCreateOneAsync Method (IClientSessionHandle, IndexKeysDefinitionTDocument, CreateIndexOptions, CancellationToken) |
Creates an index.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.5.0+57.Branch.master.Sha.6a4e00a2d91090c65a9b11364b9ebfdb9c7da076
Syntax Task<string> CreateOneAsync(
IClientSessionHandle session,
IndexKeysDefinition<TDocument> keys,
CreateIndexOptions options = null,
CancellationToken cancellationToken = null
)
Function CreateOneAsync (
session As IClientSessionHandle,
keys As IndexKeysDefinition(Of TDocument),
Optional options As CreateIndexOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of String)
abstract CreateOneAsync :
session : IClientSessionHandle *
keys : IndexKeysDefinition<'TDocument> *
?options : CreateIndexOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<string>
Parameters
- session
- Type: MongoDB.DriverIClientSessionHandle
The session. - keys
- Type: MongoDB.DriverIndexKeysDefinitionTDocument
The keys. - options (Optional)
- Type: MongoDB.DriverCreateIndexOptions
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
TaskString
A task whose result is the name of the index that was created.
See Also