MongoCollection.EnsureIndex Method (IMongoIndexKeys, IMongoIndexOptions)

MongoCollectionEnsureIndex Method (IMongoIndexKeys, IMongoIndexOptions)

Note: This API is now obsolete.

Ensures that the desired index exists and creates it if it does not.

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

Syntax

[ObsoleteAttribute("Use CreateIndex instead.")]
public virtual void EnsureIndex(
	IMongoIndexKeys keys,
	IMongoIndexOptions options
)

<ObsoleteAttribute("Use CreateIndex instead.")>
Public Overridable Sub EnsureIndex ( 
	keys As IMongoIndexKeys,
	options As IMongoIndexOptions
)

[<ObsoleteAttribute("Use CreateIndex instead.")>]
abstract EnsureIndex : 
        keys : IMongoIndexKeys * 
        options : IMongoIndexOptions -> unit 
[<ObsoleteAttribute("Use CreateIndex instead.")>]
override EnsureIndex : 
        keys : IMongoIndexKeys * 
        options : IMongoIndexOptions -> unit

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).

Reference

MongoCollection Class

EnsureIndex Overload

MongoDB.Driver Namespace