CreateIndexRequest Class |
Represents a create index request.
Inheritance HierarchyNamespace: MongoDB.Driver.Core.Operations
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e
SyntaxThe CreateIndexRequest type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CreateIndexRequest |
Initializes a new instance of the CreateIndexRequest class.
|
Properties| Name | Description | |
|---|---|---|
 | AdditionalOptions |
Gets or sets the additional options.
|
| Background |
Gets or sets a value indicating whether the index should be created in the background.
|
| Bits |
Gets or sets the bits of precision of the geohash values for 2d geo indexes.
|
| BucketSize | Obsolete.
Gets or sets the size of the bucket for geo haystack indexes.
|
| Collation |
Gets or sets the collation.
|
| DefaultLanguage |
Gets or sets the default language for text indexes.
|
| ExpireAfter |
Gets or sets when documents in a TTL collection expire.
|
| Hidden |
Gets or sets a value indicating whether the index is hidden.
|
| Keys |
Gets the keys.
|
| LanguageOverride |
Gets or sets the language override for text indexes.
|
| Max |
Gets or sets the maximum coordinate value for 2d indexes.
|
| Min |
Gets or sets the minimum coordinate value for 2d indexes.
|
| Name |
Gets or sets the index name.
|
| PartialFilterExpression |
Gets or sets the partial filter expression.
|
| Sparse |
Gets or sets a value indicating whether the index is a sparse index.
|
| SphereIndexVersion |
Gets or sets the 2dsphere index version.
|
| StorageEngine |
Gets or sets the storage engine options.
|
| TextIndexVersion |
Gets or sets the text index version.
|
| Unique |
Gets or sets a value indicating whether the index enforces the uniqueness of the key values.
|
| Version |
Gets or sets the index version.
|
| Weights |
Gets or sets the weights for text indexes.
|
| 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.) |
| GetIndexName |
Gets the name of the index.
|
| 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