IndexKeysDefinition<TDocument> Class |
Base class for an index keys definition.
Inheritance HierarchySystem.Object
MongoDB.Driver.IndexKeysDefinition<TDocument>
MongoDB.Driver.BsonDocumentIndexKeysDefinition<TDocument>
MongoDB.Driver.JsonIndexKeysDefinition<TDocument>
MongoDB.Driver.IndexKeysDefinition<TDocument>
MongoDB.Driver.BsonDocumentIndexKeysDefinition<TDocument>
MongoDB.Driver.JsonIndexKeysDefinition<TDocument>
Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
SyntaxType Parameters
- TDocument
- The type of the document.
The IndexKeysDefinition<TDocument> type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | IndexKeysDefinition<TDocument> | Initializes a new instance of the IndexKeysDefinition<TDocument> 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.) |
| Render(IBsonSerializer<TDocument>, IBsonSerializerRegistry) |
Renders the index keys definition to a BsonDocument.
|
| Render(IBsonSerializer<TDocument>, IBsonSerializerRegistry, LinqProvider) |
Renders the index keys definition to a BsonDocument.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Operators| Name | Description | |
|---|---|---|
  | Implicit(String to IndexKeysDefinition<TDocument>) |
Performs an implicit conversion from String to IndexKeysDefinition<TDocument>.
|
| Implicit(BsonDocument to IndexKeysDefinition<TDocument>) |
Performs an implicit conversion from BsonDocument to IndexKeysDefinition<TDocument>.
|
Extension Methods| Name | Description | |
|---|---|---|
 | Ascending<TDocument>(Expression<Func<TDocument, Object>>) | Overloaded.
Combines an existing index keys definition with an ascending index key definition.
(Defined by IndexKeysDefinitionExtensions.) |
| Ascending<TDocument>(FieldDefinition<TDocument>) | Overloaded.
Combines an existing index keys definition with an ascending index key definition.
(Defined by IndexKeysDefinitionExtensions.) |
| Descending<TDocument>(Expression<Func<TDocument, Object>>) | Overloaded.
Combines an existing index keys definition with a descending index key definition.
(Defined by IndexKeysDefinitionExtensions.) |
| Descending<TDocument>(FieldDefinition<TDocument>) | Overloaded.
Combines an existing index keys definition with a descending index key definition.
(Defined by IndexKeysDefinitionExtensions.) |
| Geo2D<TDocument>(Expression<Func<TDocument, Object>>) | Overloaded.
Combines an existing index keys definition with a 2d index key definition.
(Defined by IndexKeysDefinitionExtensions.) |
| Geo2D<TDocument>(FieldDefinition<TDocument>) | Overloaded.
Combines an existing index keys definition with a 2d index key definition.
(Defined by IndexKeysDefinitionExtensions.) |
| Geo2DSphere<TDocument>(Expression<Func<TDocument, Object>>) | Overloaded.
Combines an existing index keys definition with a 2dsphere index key definition.
(Defined by IndexKeysDefinitionExtensions.) |
| Geo2DSphere<TDocument>(FieldDefinition<TDocument>) | Overloaded.
Combines an existing index keys definition with a 2dsphere index key definition.
(Defined by IndexKeysDefinitionExtensions.) |
| GeoHaystack<TDocument>(Expression<Func<TDocument, Object>>, Expression<Func<TDocument, Object>>) | Overloaded.
Combines an existing index keys definition with a geo haystack index key definition.
(Defined by IndexKeysDefinitionExtensions.) |
| GeoHaystack<TDocument>(FieldDefinition<TDocument>, FieldDefinition<TDocument>) | Overloaded.
Combines an existing index keys definition with a geo haystack index key definition.
(Defined by IndexKeysDefinitionExtensions.) |
| Hashed<TDocument>(Expression<Func<TDocument, Object>>) | Overloaded.
Combines an existing index keys definition with a hashed index key definition.
(Defined by IndexKeysDefinitionExtensions.) |
| Hashed<TDocument>(FieldDefinition<TDocument>) | Overloaded.
Combines an existing index keys definition with a hashed index key definition.
(Defined by IndexKeysDefinitionExtensions.) |
| Text<TDocument>(Expression<Func<TDocument, Object>>) | Overloaded.
Combines an existing index keys definition with a text index key definition.
(Defined by IndexKeysDefinitionExtensions.) |
| Text<TDocument>(FieldDefinition<TDocument>) | Overloaded.
Combines an existing index keys definition with a text index key definition.
(Defined by IndexKeysDefinitionExtensions.) |
| 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