Click or drag to resize

MongoIndexManagerBaseTDocumentCreateOne Method (IClientSessionHandle, IndexKeysDefinitionTDocument, CreateIndexOptions, CancellationToken)

Creates an index.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.5.0+57.Branch.master.Sha.6a4e00a2d91090c65a9b11364b9ebfdb9c7da076
Syntax
public virtual string CreateOne(
	IClientSessionHandle session,
	IndexKeysDefinition<TDocument> keys,
	CreateIndexOptions options = null,
	CancellationToken cancellationToken = null
)

Parameters

session
Type: MongoDB.DriverIClientSessionHandle
The session.
keys
Type: MongoDB.DriverIndexKeysDefinitionTDocument
The keys.
options (Optional)
Type: MongoDB.DriverCreateIndexOptions
The options.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.

Return Value

Type: String
The name of the index that was created.

Implements

IMongoIndexManagerTDocumentCreateOne(IClientSessionHandle, IndexKeysDefinitionTDocument, CreateIndexOptions, CancellationToken)
See Also