Click or drag to resize

IndexOptionsBuilderTDocument Class

A builder for the options used when creating an index.
Inheritance Hierarchy
SystemObject
  MongoDB.Driver.BuildersBuilderBase
    MongoDB.Driver.BuildersIndexOptionsBuilderTDocument

Namespace:  MongoDB.Driver.Builders
Assembly:  MongoDB.Driver.Legacy (in MongoDB.Driver.Legacy.dll) Version: 2.14.0+2b37a1fe1cbdbe1a020b52b77f1197b6d77575e7
Syntax
[SerializableAttribute]
public class IndexOptionsBuilder<TDocument> : BuilderBase, 
	IMongoIndexOptions

Type Parameters

TDocument
The type of the document.

The IndexOptionsBuilderTDocument type exposes the following members.

Constructors
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetBackground
Sets whether to build the index in the background.
Public methodSetBits
Sets the location precision bits.
Public methodSetBucketSize Obsolete.
Sets the bucket size for geospatial haystack indexes.
Public methodSetDropDups
Sets whether duplicates should be dropped.
Public methodSetGeoSpatialRange
Sets the geospatial range.
Public methodSetHidden
Sets whether the index is hidden.
Public methodSetName
Sets the name of the index.
Public methodSetPartialFilterExpression
Sets the partial filter expression.
Public methodSetSparse
Sets whether the index is a sparse index.
Public methodSetStorageEngineOptions
Sets the storage engine options.
Public methodSetTextDefaultLanguage
Sets the default language for the text index.
Public methodSetTextLanguageOverride
Specifies a member expression for the field name containing the language for the text index.
Public methodSetTimeToLive
Sets the time to live value.
Public methodSetUnique
Sets whether the index enforces unique values.
Public methodSetWeightTMember
Sets the weight of a field for the text index.
Public methodSetWildcardProjectionTMember
Sets the wildcardProjection for the index.
Public methodToBsonDocument
Converts this object to a BsonDocument.
(Overrides BuilderBaseToBsonDocument.)
Public methodToString
Returns a string representation of the settings.
(Inherited from BuilderBase.)
Top
Extension Methods
  NameDescription
Public Extension MethodToBson
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.)
Public Extension MethodToBsonDocument
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.)
Public Extension MethodToJson
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.)
Top
See Also