Class CreateIndexOptions

Namespace

MongoDB.Driver

Assembly

MongoDB.Driver.dll

Options for creating an index.

public class CreateIndexOptions

Inheritance

object

CreateIndexOptions

Derived

CreateIndexOptions<TDocument>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Background

Gets or sets a value indicating whether to create the index in the background.

public bool? Background { get; set; }

Property Value

bool?

Bits

Gets or sets the precision, in bits, used with geohash indexes.

public int? Bits { get; set; }

Property Value

int?

BucketSize

Gets or sets the size of a geohash bucket.

[Obsolete("GeoHaystack indexes were deprecated in server version 4.4.")]
public double? BucketSize { get; set; }

Property Value

double?

Collation

Gets or sets the collation.

public Collation Collation { get; set; }

Property Value

Collation

DefaultLanguage

Gets or sets the default language.

public string DefaultLanguage { get; set; }

Property Value

string

ExpireAfter

Gets or sets when documents expire (used with TTL indexes).

public TimeSpan? ExpireAfter { get; set; }

Property Value

TimeSpan?

Hidden

Gets or sets a value indicating whether the index is hidden.

public bool? Hidden { get; set; }

Property Value

bool?

LanguageOverride

Gets or sets the language override.

public string LanguageOverride { get; set; }

Property Value

string

Max

Gets or sets the max value for 2d indexes.

public double? Max { get; set; }

Property Value

double?

Min

Gets or sets the min value for 2d indexes.

public double? Min { get; set; }

Property Value

double?

Name

Gets or sets the index name.

public string Name { get; set; }

Property Value

string

Sparse

Gets or sets a value indicating whether the index is a sparse index.

public bool? Sparse { get; set; }

Property Value

bool?

SphereIndexVersion

Gets or sets the index version for 2dsphere indexes.

public int? SphereIndexVersion { get; set; }

Property Value

int?

StorageEngine

Gets or sets the storage engine options.

public BsonDocument StorageEngine { get; set; }

Property Value

BsonDocument

TextIndexVersion

Gets or sets the index version for text indexes.

public int? TextIndexVersion { get; set; }

Property Value

int?

Unique

Gets or sets a value indicating whether the index is a unique index.

public bool? Unique { get; set; }

Property Value

bool?

Version

Gets or sets the version of the index.

public int? Version { get; set; }

Property Value

int?

Weights

Gets or sets the weights for text indexes.

public BsonDocument Weights { get; set; }

Property Value

BsonDocument