Click or drag to resize

IMongoIndexManagerTDocumentCreateOneAsync 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.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
Syntax
[ObsoleteAttribute("Use CreateOneAsync with a CreateIndexModel instead.")]
Task<string> CreateOneAsync(
	IndexKeysDefinition<TDocument> keys,
	CreateIndexOptions options = null,
	CancellationToken cancellationToken = null
)

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.
See Also