Click or drag to resize

MongoIndexManagerBaseTDocumentCreateOneAsync Method (IClientSessionHandle, CreateIndexModelTDocument, CreateOneIndexOptions, CancellationToken)

Creates an index.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e
Syntax
public virtual Task<string> CreateOneAsync(
	IClientSessionHandle session,
	CreateIndexModel<TDocument> model,
	CreateOneIndexOptions options = null,
	CancellationToken cancellationToken = default
)

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: TaskString
A task whose result is the name of the index that was created.

Implements

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