Class IndexOptionsBuilder

Namespace

MongoDB.Driver.Builders

Assembly

MongoDB.Driver.Legacy.dll

A builder for the options used when creating an index.

[Serializable]
[BsonSerializer(typeof(IndexOptionsBuilder.Serializer))]
public class IndexOptionsBuilder : BuilderBase, IConvertibleToBsonDocument, IMongoIndexOptions

Inheritance

object

BuilderBase

IndexOptionsBuilder

Implements

IConvertibleToBsonDocument

IMongoIndexOptions

Inherited Members

BuilderBase.ToString()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

LinqToMongo.In<TSource>(TSource, IEnumerable<TSource>)

Constructors

IndexOptionsBuilder()

Initializes a new instance of the IndexOptionsBuilder class.

public IndexOptionsBuilder()

Methods

SetBackground(bool)

Sets whether to build the index in the background.

public IndexOptionsBuilder SetBackground(bool value)

Parameters

value bool

Whether to build the index in the background.

Returns

IndexOptionsBuilder

The builder (so method calls can be chained).

SetBits(int)

Sets the location precision bits.

public IndexOptionsBuilder SetBits(int value)

Parameters

value int

The value.

Returns

IndexOptionsBuilder

The builder (so method calls can be chained).

SetBucketSize(double)

Sets the bucket size for geospatial haystack indexes.

[Obsolete("GeoHaystack indexes were deprecated in server version 4.4.")]
public IndexOptionsBuilder SetBucketSize(double value)

Parameters

value double

The bucket size.

Returns

IndexOptionsBuilder

The builder (so method calls can be chained).

SetDropDups(bool)

Sets whether duplicates should be dropped.

public IndexOptionsBuilder SetDropDups(bool value)

Parameters

value bool

Whether duplicates should be dropped.

Returns

IndexOptionsBuilder

The builder (so method calls can be chained).

SetGeoSpatialRange(double, double)

Sets the geospatial range.

public IndexOptionsBuilder SetGeoSpatialRange(double min, double max)

Parameters

min double

The min value of the range.

max double

The max value of the range.

Returns

IndexOptionsBuilder

The builder (so method calls can be chained).

SetHidden(bool)

Sets whether the index is hidden.

public IndexOptionsBuilder SetHidden(bool value)

Parameters

value bool

Whether the index is hidden.

Returns

IndexOptionsBuilder

The builder (so method calls can be chained).

SetName(string)

Sets the name of the index.

public IndexOptionsBuilder SetName(string value)

Parameters

value string

The name of the index.

Returns

IndexOptionsBuilder

The builder (so method calls can be chained).

SetPartialFilterExpression(IMongoQuery)

Sets the partial filter expression.

public IndexOptionsBuilder SetPartialFilterExpression(IMongoQuery value)

Parameters

value IMongoQuery

The value.

Returns

IndexOptionsBuilder

The builder (so method calls can be chained).

SetSparse(bool)

Sets whether the index is a sparse index.

public IndexOptionsBuilder SetSparse(bool value)

Parameters

value bool

Whether the index is a sparse index.

Returns

IndexOptionsBuilder

The builder (so method calls can be chained).

SetStorageEngineOptions(BsonDocument)

Sets the storage engine options.

public IndexOptionsBuilder SetStorageEngineOptions(BsonDocument value)

Parameters

value BsonDocument

The value.

Returns

IndexOptionsBuilder

The builder (so method calls can be chained).

SetTextDefaultLanguage(string)

Sets the default language for the text index.

public IndexOptionsBuilder SetTextDefaultLanguage(string language)

Parameters

language string

The default language.

Returns

IndexOptionsBuilder

The builder (so method calls can be chained).

SetTextLanguageOverride(string)

Specifies the field name containing the language for the text index.

public IndexOptionsBuilder SetTextLanguageOverride(string fieldName)

Parameters

fieldName string

The field name.

Returns

IndexOptionsBuilder

The builder (so method calls can be chained).

SetTimeToLive(TimeSpan)

Sets the time to live value.

public IndexOptionsBuilder SetTimeToLive(TimeSpan timeToLive)

Parameters

timeToLive TimeSpan

The time to live.

Returns

IndexOptionsBuilder

The builder (so method calls can be chained).

SetUnique(bool)

Sets whether the index enforces unique values.

public IndexOptionsBuilder SetUnique(bool value)

Parameters

value bool

Whether the index enforces unique values.

Returns

IndexOptionsBuilder

The builder (so method calls can be chained).

SetWeight(string, int)

Sets the weight of a field for the text index.

public IndexOptionsBuilder SetWeight(string name, int value)

Parameters

name string

The field name.

value int

The weight.

Returns

IndexOptionsBuilder

The builder (so method calls can be chained).

SetWildcardProjection(string, bool)

Sets the wildcardProjection for the index.

public IndexOptionsBuilder SetWildcardProjection(string name, bool included)

Parameters

name string

The field name.

included bool

The flag determines whether the field should be included or excluded from wildcard projecting.

Returns

IndexOptionsBuilder

The builder (so method calls can be chained).

ToBsonDocument()

Returns the result of the builder as a BsonDocument.

public override BsonDocument ToBsonDocument()

Returns

BsonDocument

A BsonDocument.