IndexOptionsBuilder Class

A builder for the options used when creating an index.

Inheritance Hierarchy

SystemObject
MongoDB.Driver.BuildersBuilderBase
MongoDB.Driver.BuildersIndexOptionsBuilder

Namespace: MongoDB.Driver.Builders
Assembly: MongoDB.Driver.Legacy (in MongoDB.Driver.Legacy.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242

Syntax

Copy

[SerializableAttribute]
public class IndexOptionsBuilder : BuilderBase, 
	IMongoIndexOptions

<SerializableAttribute>
Public Class IndexOptionsBuilder
	Inherits BuilderBase
	Implements IMongoIndexOptions

[<SerializableAttribute>]
type IndexOptionsBuilder =  
    class
        inherit BuilderBase
        interface IMongoIndexOptions
    end

The IndexOptionsBuilder type exposes the following members.

Constructors

	Name	Description
	IndexOptionsBuilder	Initializes a new instance of the IndexOptionsBuilder class.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SetBackground	Sets whether to build the index in the background.
	SetBits	Sets the location precision bits.
	SetBucketSize	Obsolete. Sets the bucket size for geospatial haystack indexes.
	SetDropDups	Sets whether duplicates should be dropped.
	SetGeoSpatialRange	Sets the geospatial range.
	SetHidden	Sets whether the index is hidden.
	SetName	Sets the name of the index.
	SetPartialFilterExpression	Sets the partial filter expression.
	SetSparse	Sets whether the index is a sparse index.
	SetStorageEngineOptions	Sets the storage engine options.
	SetTextDefaultLanguage	Sets the default language for the text index.
	SetTextLanguageOverride	Specifies the field name containing the language for the text index.
	SetTimeToLive	Sets the time to live value.
	SetUnique	Sets whether the index enforces unique values.
	SetWeight	Sets the weight of a field for the text index.
	SetWildcardProjection	Sets the wildcardProjection for the index.
	ToBsonDocument	Returns the result of the builder as a BsonDocument. (Overrides BuilderBaseToBsonDocument.)
	ToString	Returns a string representation of the settings. (Inherited from BuilderBase.)

Top

Extension Methods

	Name	Description
	ToBson	Serializes an object to a BSON byte array. (Defined by BsonExtensionMethods.)
	ToBsonDocument	Serializes an object to a BsonDocument. (Defined by BsonExtensionMethods.)
	ToJson	Serializes an object to a JSON string. (Defined by BsonExtensionMethods.)

Top

Reference

MongoDB.Driver.Builders Namespace