MongoIndexManagerBaseTDocumentCreateOne Method (IClientSessionHandle, IndexKeysDefinitionTDocument, CreateIndexOptions, CancellationToken) |
Note: This API is now obsolete.
Creates an index.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e
Syntax [ObsoleteAttribute("Use CreateOne with a CreateIndexModel instead.")]
public virtual string CreateOne(
IClientSessionHandle session,
IndexKeysDefinition<TDocument> keys,
CreateIndexOptions options = null,
CancellationToken cancellationToken = default
)
<ObsoleteAttribute("Use CreateOne with a CreateIndexModel instead.")>
Public Overridable Function CreateOne (
session As IClientSessionHandle,
keys As IndexKeysDefinition(Of TDocument),
Optional options As CreateIndexOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As String
[<ObsoleteAttribute("Use CreateOne with a CreateIndexModel instead.")>]
abstract CreateOne :
session : IClientSessionHandle *
keys : IndexKeysDefinition<'TDocument> *
?options : CreateIndexOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> string
[<ObsoleteAttribute("Use CreateOne with a CreateIndexModel instead.")>]
override CreateOne :
session : IClientSessionHandle *
keys : IndexKeysDefinition<'TDocument> *
?options : CreateIndexOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> string
Parameters
- session
- Type: MongoDB.DriverIClientSessionHandle
The session. - keys
- Type: MongoDB.DriverIndexKeysDefinitionTDocument
The keys. - options (Optional)
- Type: MongoDB.DriverCreateIndexOptions
The create index request options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
String
The name of the index that was created.
Implements
IMongoIndexManagerTDocumentCreateOne(IClientSessionHandle, IndexKeysDefinitionTDocument, CreateIndexOptions, CancellationToken)See Also