IndexKeysBuilderTDocument Class |
A builder for specifying the keys for an index.
Inheritance HierarchyNamespace: MongoDB.Driver.Builders
Assembly: MongoDB.Driver.Legacy (in MongoDB.Driver.Legacy.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
Syntax[SerializableAttribute] public class IndexKeysBuilder<TDocument> : BuilderBase, IMongoIndexKeys
Type Parameters
- TDocument
- The type of the document.
The IndexKeysBuilderTDocument type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | IndexKeysBuilderTDocument |
Initializes a new instance of the IndexKeysBuilder class.
|
Methods| Name | Description | |
|---|---|---|
| Ascending |
Sets one or more key names to index in ascending order.
|
| Descending |
Sets one or more key names to index in descending order.
|
| 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.) |
| GeoSpatialTMember |
Sets the key name to create a geospatial index on.
|
| GeoSpatialHaystackTMember(ExpressionFuncTDocument, TMember) | Obsolete.
Sets the key name to create a geospatial haystack index on.
|
| GeoSpatialHaystackTMember, TAdditionalMember(ExpressionFuncTDocument, TMember, ExpressionFuncTDocument, TAdditionalMember) | Obsolete.
Sets the key name and additional field name to create a geospatial haystack index on.
|
| GeoSpatialSphericalTMember |
Sets the key name to create a spherical geospatial index on.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HashedTMember |
Sets the key name to create a hashed index on.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Text(ExpressionFuncTDocument, IEnumerableString) |
Sets one or more key names to include in the text index.
|
| Text(ExpressionFuncTDocument, String) |
Sets one or more key names to include in the text index.
|
| TextAll |
Create a text index that indexes all text fields of a document.
|
| ToBsonDocument |
Converts this object to a BsonDocument.
(Overrides BuilderBaseToBsonDocument.) |
| ToString |
Returns a string representation of the settings.
(Inherited from BuilderBase.) |
| Wildcard |
Sets a wildcard key to the index.
|
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