MongoCollection.CreateIndex Method (IMongoIndexKeys, IMongoIndexOptions)

MongoCollectionCreateIndex Method (IMongoIndexKeys, IMongoIndexOptions)

Creates an index for this collection.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver.Legacy (in MongoDB.Driver.Legacy.dll) Version: 2.2.0

Syntax

public virtual WriteConcernResult CreateIndex(
	IMongoIndexKeys keys,
	IMongoIndexOptions options
)

Public Overridable Function CreateIndex ( 
	keys As IMongoIndexKeys,
	options As IMongoIndexOptions
) As WriteConcernResult

abstract CreateIndex : 
        keys : IMongoIndexKeys * 
        options : IMongoIndexOptions -> WriteConcernResult 
override CreateIndex : 
        keys : IMongoIndexKeys * 
        options : IMongoIndexOptions -> WriteConcernResult

Parameters

keys: Type: MongoDB.DriverIMongoIndexKeys
The indexed fields (usually an IndexKeysDocument or constructed using the IndexKeys builder).
options: Type: MongoDB.DriverIMongoIndexOptions
The index options(usually an IndexOptionsDocument or created using the IndexOption builder).

Return Value

Type: WriteConcernResult
A WriteConcernResult.

Reference

MongoCollection Class

CreateIndex Overload

MongoDB.Driver Namespace