Click or drag to resize

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>

Type Parameters

TDocument
The document type.

The ClusteredIndexOptionsTDocument type exposes the following members.

Constructors
  NameDescription
Public methodClusteredIndexOptionsTDocument
Initializes a new instance of the ClusteredIndexOptionsTDocument class.
Top
Properties
  NameDescription
Public propertyKey
Gets or sets the index key, which must currently be {_id: 1}.
Public propertyName
Gets or sets the index name.
Public propertyUnique
Gets or sets whether the index entries must be unique, which currently must be true.
Top
Methods
  NameDescription
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 methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
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