Click or drag to resize

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.18.0+554c799eb1ec8dd732f16c739387f6664df1ba7a
Syntax
[ObsoleteAttribute("Use CreateOneAsync with a CreateIndexModel instead.")]
public virtual Task<string> CreateOneAsync(
	IndexKeysDefinition<TDocument> keys,
	CreateIndexOptions options = null,
	CancellationToken cancellationToken = default
)

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