Click or drag to resize

CreateIndexOptions Class

Options for creating an index.
Inheritance Hierarchy

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.8.0+cc573f3e1f48f39162b4b680e921a623e127e8fa
Syntax
public class CreateIndexOptions

The CreateIndexOptions type exposes the following members.

Constructors
  NameDescription
Public methodCreateIndexOptions
Initializes a new instance of the CreateIndexOptions class
Top
Properties
  NameDescription
Public propertyBackground
Gets or sets a value indicating whether to create the index in the background.
Public propertyBits
Gets or sets the precision, in bits, used with geohash indexes.
Public propertyBucketSize
Gets or sets the size of a geohash bucket.
Public propertyCollation
Gets or sets the collation.
Public propertyDefaultLanguage
Gets or sets the default language.
Public propertyExpireAfter
Gets or sets when documents expire (used with TTL indexes).
Public propertyLanguageOverride
Gets or sets the language override.
Public propertyMax
Gets or sets the max value for 2d indexes.
Public propertyMin
Gets or sets the min value for 2d indexes.
Public propertyName
Gets or sets the index name.
Public propertySparse
Gets or sets a value indicating whether the index is a sparse index.
Public propertySphereIndexVersion
Gets or sets the index version for 2dsphere indexes.
Public propertyStorageEngine
Gets or sets the storage engine options.
Public propertyTextIndexVersion
Gets or sets the index version for text indexes.
Public propertyUnique
Gets or sets a value indicating whether the index is a unique index.
Public propertyVersion
Gets or sets the version of the index.
Public propertyWeights
Gets or sets the weights for text indexes.
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