Click or drag to resize

CreateIndexOptionsTDocument Class

Options for creating an index.
Inheritance Hierarchy
SystemObject
  MongoDB.DriverCreateIndexOptions
    MongoDB.DriverCreateIndexOptionsTDocument

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
Syntax
public class CreateIndexOptions<TDocument> : CreateIndexOptions

Type Parameters

TDocument
The type of the document.

The CreateIndexOptionsTDocument type exposes the following members.

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