IndexKeysBuilder Class

A builder for specifying the keys for an index.

Inheritance Hierarchy

SystemObject
MongoDB.Driver.BuildersBuilderBase
MongoDB.Driver.BuildersIndexKeysBuilder

Namespace: MongoDB.Driver.Builders
Assembly: MongoDB.Driver.Legacy (in MongoDB.Driver.Legacy.dll) Version: 2.19.1+3a2a09dd959482f665ffbb5df2557ec541597af4

Syntax

Copy

[SerializableAttribute]
public class IndexKeysBuilder : BuilderBase, 
	IMongoIndexKeys

<SerializableAttribute>
Public Class IndexKeysBuilder
	Inherits BuilderBase
	Implements IMongoIndexKeys

[<SerializableAttribute>]
type IndexKeysBuilder =  
    class
        inherit BuilderBase
        interface IMongoIndexKeys
    end

The IndexKeysBuilder type exposes the following members.

Constructors

	Name	Description
	IndexKeysBuilder	Initializes a new instance of the IndexKeysBuilder class.

Top

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.)
	GeoSpatial	Sets the key name to create a geospatial index on.
	GeoSpatialHaystack(String)	Obsolete. Sets the key name to create a geospatial haystack index on.
	GeoSpatialHaystack(String, String)	Obsolete. Sets the key name and additional field name to create a geospatial haystack index on.
	GeoSpatialSpherical	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.)
	Hashed	Sets the key name to create a hashed index on.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Text	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	Returns the result of the builder as a BsonDocument. (Overrides BuilderBaseToBsonDocument.)
	ToString	Returns a string representation of the settings. (Inherited from BuilderBase.)
	Wildcard	Sets a wildcard key to the index. The method doesn't expect to specify a wildcard key explicitly.

Top

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.)

Top

Reference

MongoDB.Driver.Builders Namespace