Click or drag to resize

IMongoIndexManager<TDocument>.CreateOneAsync Method (IClientSessionHandle, IndexKeysDefinition<TDocument>, CreateIndexOptions, CancellationToken)

Note: This API is now obsolete.

Creates an index.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
Syntax
[ObsoleteAttribute("Use CreateOneAsyc with a CreateIndexModel instead.")]
Task<string> CreateOneAsync(
	IClientSessionHandle session,
	IndexKeysDefinition<TDocument> keys,
	CreateIndexOptions options = null,
	CancellationToken cancellationToken = null
)

Parameters

session
Type: MongoDB.Driver.IClientSessionHandle
The session.
keys
Type: MongoDB.Driver.IndexKeysDefinition<TDocument>
The keys.
options (Optional)
Type: MongoDB.Driver.CreateIndexOptions
The create index request options.
cancellationToken (Optional)
Type: System.Threading.CancellationToken
The cancellation token.

Return Value

Type: Task<String>
A task whose result is the name of the index that was created.
See Also