ClusteredIndexOptionsTDocument Class

Options for creating a clustered index.

Inheritance Hierarchy

SystemObject
MongoDB.DriverClusteredIndexOptionsTDocument

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242

Syntax

public class ClusteredIndexOptions<TDocument>

Public Class ClusteredIndexOptions(Of TDocument)

type ClusteredIndexOptions<'TDocument> =  class end

The ClusteredIndexOptionsTDocument type exposes the following members.

Constructors

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

Properties

	Name	Description
	Key	Gets or sets the index key, which must currently be {_id: 1}.
	Name	Gets or sets the index name.
	Unique	Gets or sets whether the index entries must be unique, which currently must be true.

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.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

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

ClusteredIndexOptionsAddLanguageSpecificTextSet("LSTB76DF76E_0?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");TDocumentAddLanguageSpecificTextSet("LSTB76DF76E_1?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)"); Class