CreateIndexOptionsTDocument Class |
Options for creating an index.
Inheritance HierarchyNamespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.19.1+3a2a09dd959482f665ffbb5df2557ec541597af4
SyntaxType Parameters
- TDocument
- The type of the document.
The CreateIndexOptionsTDocument type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CreateIndexOptionsTDocument | Initializes a new instance of the CreateIndexOptionsTDocument class |
Properties| Name | Description | |
|---|---|---|
 | Background |
Gets or sets a value indicating whether to create the index in the background.
(Inherited from CreateIndexOptions.) |
| Bits |
Gets or sets the precision, in bits, used with geohash indexes.
(Inherited from CreateIndexOptions.) |
| BucketSize | Obsolete.
Gets or sets the size of a geohash bucket.
(Inherited from CreateIndexOptions.) |
| Collation |
Gets or sets the collation.
(Inherited from CreateIndexOptions.) |
| DefaultLanguage |
Gets or sets the default language.
(Inherited from CreateIndexOptions.) |
| ExpireAfter |
Gets or sets when documents expire (used with TTL indexes).
(Inherited from CreateIndexOptions.) |
| Hidden |
Gets or sets a value indicating whether the index is hidden.
(Inherited from CreateIndexOptions.) |
| LanguageOverride |
Gets or sets the language override.
(Inherited from CreateIndexOptions.) |
| Max |
Gets or sets the max value for 2d indexes.
(Inherited from CreateIndexOptions.) |
| Min |
Gets or sets the min value for 2d indexes.
(Inherited from CreateIndexOptions.) |
| Name |
Gets or sets the index name.
(Inherited from CreateIndexOptions.) |
| PartialFilterExpression |
Gets or sets the partial filter expression.
|
| Sparse |
Gets or sets a value indicating whether the index is a sparse index.
(Inherited from CreateIndexOptions.) |
| SphereIndexVersion |
Gets or sets the index version for 2dsphere indexes.
(Inherited from CreateIndexOptions.) |
| StorageEngine |
Gets or sets the storage engine options.
(Inherited from CreateIndexOptions.) |
| TextIndexVersion |
Gets or sets the index version for text indexes.
(Inherited from CreateIndexOptions.) |
| Unique |
Gets or sets a value indicating whether the index is a unique index.
(Inherited from CreateIndexOptions.) |
| Version |
Gets or sets the version of the index.
(Inherited from CreateIndexOptions.) |
| Weights |
Gets or sets the weights for text indexes.
(Inherited from CreateIndexOptions.) |
| WildcardProjection |
Gets or sets the wildcard projection.
|
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