MongoIndexManagerBaseTDocumentCreateOneAsync Method (IndexKeysDefinitionTDocument, CreateIndexOptions, CancellationToken) |
Note: This API is now obsolete.
Creates an index.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.12.2+a4a3888f4fb51bb518b1eb5002effc2d47f2ea6a
Syntax [ObsoleteAttribute("Use CreateOneAsync with a CreateIndexModel instead.")]
public virtual Task<string> CreateOneAsync(
IndexKeysDefinition<TDocument> keys,
CreateIndexOptions options = null,
CancellationToken cancellationToken = null
)
<ObsoleteAttribute("Use CreateOneAsync with a CreateIndexModel instead.")>
Public Overridable Function CreateOneAsync (
keys As IndexKeysDefinition(Of TDocument),
Optional options As CreateIndexOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of String)
[<ObsoleteAttribute("Use CreateOneAsync with a CreateIndexModel instead.")>]
abstract CreateOneAsync :
keys : IndexKeysDefinition<'TDocument> *
?options : CreateIndexOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<string>
[<ObsoleteAttribute("Use CreateOneAsync with a CreateIndexModel instead.")>]
override CreateOneAsync :
keys : IndexKeysDefinition<'TDocument> *
?options : CreateIndexOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<string>
Parameters
- 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:
TaskString
A task whose result is the name of the index that was created.
Implements
IMongoIndexManagerTDocumentCreateOneAsync(IndexKeysDefinitionTDocument, CreateIndexOptions, CancellationToken)See Also