Click or drag to resize

IndexKeysBuilder Class

A builder for specifying the keys for an index.
Inheritance Hierarchy

Namespace:  MongoDB.Driver.Builders
Assembly:  MongoDB.Driver.Legacy (in MongoDB.Driver.Legacy.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
Syntax
[SerializableAttribute]
public class IndexKeysBuilder : BuilderBase, 
	IMongoIndexKeys

The IndexKeysBuilder type exposes the following members.

Constructors
  NameDescription
Public methodIndexKeysBuilder
Initializes a new instance of the IndexKeysBuilder class.
Top
Methods
  NameDescription
Public methodAscending
Sets one or more key names to index in ascending order.
Public methodDescending
Sets one or more key names to index in descending order.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGeoSpatial
Sets the key name to create a geospatial index on.
Public methodGeoSpatialHaystack(String) Obsolete.
Sets the key name to create a geospatial haystack index on.
Public methodGeoSpatialHaystack(String, String) Obsolete.
Sets the key name and additional field name to create a geospatial haystack index on.
Public methodGeoSpatialSpherical
Sets the key name to create a spherical geospatial index on.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHashed
Sets the key name to create a hashed index on.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodText
Sets one or more key names to include in the text index.
Public methodTextAll
Create a text index that indexes all text fields of a document.
Public methodToBsonDocument
Returns the result of the builder as a BsonDocument.
(Overrides BuilderBaseToBsonDocument.)
Public methodToString
Returns a string representation of the settings.
(Inherited from BuilderBase.)
Public methodWildcard
Sets a wildcard key to the index. The method doesn't expect to specify a wildcard key explicitly.
Top
Extension Methods
  NameDescription
Public Extension MethodToBson
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.)
Public Extension MethodToBsonDocument
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.)
Public Extension MethodToJson
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.)
Top
See Also