IndexOptionsBuilderTDocument Class |
A builder for the options used when creating an index.
Inheritance HierarchyNamespace: MongoDB.Driver.Builders
Assembly: MongoDB.Driver.Legacy (in MongoDB.Driver.Legacy.dll) Version: 2.15.0+f503bf610759c13f78cff9a3c01e91453185d2ed
Syntax[SerializableAttribute] public class IndexOptionsBuilder<TDocument> : BuilderBase, IMongoIndexOptions
Type Parameters
- TDocument
- The type of the document.
The IndexOptionsBuilderTDocument type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | IndexOptionsBuilderTDocument |
Initializes a new instance of the IndexOptionsBuilder class.
|
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 a member expression for 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.
|
| SetWeightTMember |
Sets the weight of a field for the text index.
|
| SetWildcardProjectionTMember |
Sets the wildcardProjection for the index.
|
| ToBsonDocument |
Converts this object to a BsonDocument.
(Overrides BuilderBaseToBsonDocument.) |
| ToString |
Returns a string representation of the settings.
(Inherited from BuilderBase.) |
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.) |
See Also