CreateIndexOptions Class |
Options for creating an index.
Inheritance HierarchyNamespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.16.0+eeafbea0921243a5868b81984e1083a07c1f75bc
SyntaxThe CreateIndexOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CreateIndexOptions | Initializes a new instance of the CreateIndexOptions class |
Properties| Name | Description | |
|---|---|---|
 | Background |
Gets or sets a value indicating whether to create the index in the background.
|
| Bits |
Gets or sets the precision, in bits, used with geohash indexes.
|
| BucketSize | Obsolete.
Gets or sets the size of a geohash bucket.
|
| Collation |
Gets or sets the collation.
|
| DefaultLanguage |
Gets or sets the default language.
|
| ExpireAfter |
Gets or sets when documents expire (used with TTL indexes).
|
| Hidden |
Gets or sets a value indicating whether the index is hidden.
|
| LanguageOverride |
Gets or sets the language override.
|
| Max |
Gets or sets the max value for 2d indexes.
|
| Min |
Gets or sets the min value for 2d indexes.
|
| Name |
Gets or sets the index name.
|
| Sparse |
Gets or sets a value indicating whether the index is a sparse index.
|
| SphereIndexVersion |
Gets or sets the index version for 2dsphere indexes.
|
| StorageEngine |
Gets or sets the storage engine options.
|
| TextIndexVersion |
Gets or sets the index version for text indexes.
|
| Unique |
Gets or sets a value indicating whether the index is a unique index.
|
| Version |
Gets or sets the version of the index.
|
| Weights |
Gets or sets the weights for text indexes.
|
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.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
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