Click or drag to resize

MongoIndexManagerBaseTDocumentCreateOne Method (IClientSessionHandle, CreateIndexModelTDocument, CreateOneIndexOptions, CancellationToken)

Creates an index.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.12.2+a4a3888f4fb51bb518b1eb5002effc2d47f2ea6a
Syntax
public virtual string CreateOne(
	IClientSessionHandle session,
	CreateIndexModel<TDocument> model,
	CreateOneIndexOptions options = null,
	CancellationToken cancellationToken = null
)

Parameters

session
Type: MongoDB.DriverIClientSessionHandle
The session.
model
Type: MongoDB.DriverCreateIndexModelTDocument
The model defining the index.
options (Optional)
Type: MongoDB.DriverCreateOneIndexOptions
The create index operation options.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.

Return Value

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

Implements

IMongoIndexManagerTDocumentCreateOne(IClientSessionHandle, CreateIndexModelTDocument, CreateOneIndexOptions, CancellationToken)
See Also