IMongoIndexManagerTDocumentCreateOne Method (IClientSessionHandle, IndexKeysDefinitionTDocument, CreateIndexOptions, CancellationToken) |
Creates an index.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.6.0+Branch.origin/v2.6.x.Sha.593796a7b35dc59243383bcc684de296a5468f2e
Syntax string CreateOne(
IClientSessionHandle session,
IndexKeysDefinition<TDocument> keys,
CreateIndexOptions options = null,
CancellationToken cancellationToken = null
)
Function CreateOne (
session As IClientSessionHandle,
keys As IndexKeysDefinition(Of TDocument),
Optional options As CreateIndexOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As String
abstract CreateOne :
session : IClientSessionHandle *
keys : IndexKeysDefinition<'TDocument> *
?options : CreateIndexOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> 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:
String
The name of the index that was created.
See Also