IMongoIndexManagerTDocumentCreateOneAsync Method (CreateIndexModelTDocument, CreateOneIndexOptions, CancellationToken)

Creates an index.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2

Syntax

Copy

Task<string> CreateOneAsync(
	CreateIndexModel<TDocument> model,
	CreateOneIndexOptions options = null,
	CancellationToken cancellationToken = null
)

Function CreateOneAsync ( 
	model As CreateIndexModel(Of TDocument),
	Optional options As CreateOneIndexOptions = Nothing,
	Optional cancellationToken As CancellationToken = Nothing
) As Task(Of String)

abstract CreateOneAsync : 
        model : CreateIndexModel<'TDocument> * 
        ?options : CreateOneIndexOptions * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _options = defaultArg options null
        let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<string>

Parameters

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.

Reference

IMongoIndexManagerTDocument Interface

CreateOneAsync Overload

MongoDB.Driver Namespace