Click or drag to resize

IndexKeysBuilder<TDocument> Class

A builder for specifying the keys for an index.
Inheritance Hierarchy
System.Object
  MongoDB.Driver.Builders.BuilderBase
    MongoDB.Driver.Builders.IndexKeysBuilder<TDocument>

Namespace:  MongoDB.Driver.Builders
Assembly:  MongoDB.Driver.Legacy (in MongoDB.Driver.Legacy.dll) Version: 2.15.0+f503bf610759c13f78cff9a3c01e91453185d2ed
Syntax
[SerializableAttribute]
public class IndexKeysBuilder<TDocument> : BuilderBase, 
	IMongoIndexKeys

Type Parameters

TDocument
The type of the document.

The IndexKeysBuilder<TDocument> type exposes the following members.

Constructors
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<TMember>
Sets the key name to create a geospatial index on.
Public methodGeoSpatialHaystack<TMember>(Expression<Func<TDocument, TMember>>) Obsolete.
Sets the key name to create a geospatial haystack index on.
Public methodGeoSpatialHaystack<TMember, TAdditionalMember>(Expression<Func<TDocument, TMember>>, Expression<Func<TDocument, TAdditionalMember>>) Obsolete.
Sets the key name and additional field name to create a geospatial haystack index on.
Public methodGeoSpatialSpherical<TMember>
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<TMember>
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(Expression<Func<TDocument, IEnumerable<String>>>[])
Sets one or more key names to include in the text index.
Public methodText(Expression<Func<TDocument, String>>[])
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
Converts this object to a BsonDocument.
(Overrides BuilderBase.ToBsonDocument().)
Public methodToString
Returns a string representation of the settings.
(Inherited from BuilderBase.)
Public methodWildcard
Sets a wildcard key to the index.
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