Click or drag to resize

IMongoIndexManagerTDocumentCreateOneAsync 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.14.0+2b37a1fe1cbdbe1a020b52b77f1197b6d77575e7
[ObsoleteAttribute("Use CreateOneAsyc with a CreateIndexModel instead.")]
Task<string> CreateOneAsync(
	IClientSessionHandle session,
	IndexKeysDefinition<TDocument> keys,
	CreateIndexOptions options = null,
	CancellationToken cancellationToken = default


Type: MongoDB.DriverIClientSessionHandle
The session.
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