Click or drag to resize

CreateIndexRequest Class

Represents a create index request.
Inheritance Hierarchy
SystemObject
  MongoDB.Driver.Core.OperationsCreateIndexRequest

Namespace:  MongoDB.Driver.Core.Operations
Assembly:  MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.18.0+554c799eb1ec8dd732f16c739387f6664df1ba7a
Syntax
public class CreateIndexRequest

The CreateIndexRequest type exposes the following members.

Constructors
  NameDescription
Public methodCreateIndexRequest
Initializes a new instance of the CreateIndexRequest class.
Top
Properties
  NameDescription
Public propertyAdditionalOptions
Gets or sets the additional options.
Public propertyBackground
Gets or sets a value indicating whether the index should be created in the background.
Public propertyBits
Gets or sets the bits of precision of the geohash values for 2d geo indexes.
Public propertyBucketSize Obsolete.
Gets or sets the size of the bucket for geo haystack indexes.
Public propertyCollation
Gets or sets the collation.
Public propertyDefaultLanguage
Gets or sets the default language for text indexes.
Public propertyExpireAfter
Gets or sets when documents in a TTL collection expire.
Public propertyHidden
Gets or sets a value indicating whether the index is hidden.
Public propertyKeys
Gets the keys.
Public propertyLanguageOverride
Gets or sets the language override for text indexes.
Public propertyMax
Gets or sets the maximum coordinate value for 2d indexes.
Public propertyMin
Gets or sets the minimum coordinate value for 2d indexes.
Public propertyName
Gets or sets the index name.
Public propertyPartialFilterExpression
Gets or sets the partial filter expression.
Public propertySparse
Gets or sets a value indicating whether the index is a sparse index.
Public propertySphereIndexVersion
Gets or sets the 2dsphere index version.
Public propertyStorageEngine
Gets or sets the storage engine options.
Public propertyTextIndexVersion
Gets or sets the text index version.
Public propertyUnique
Gets or sets a value indicating whether the index enforces the uniqueness of the key values.
Public propertyVersion
Gets or sets the index version.
Public propertyWeights
Gets or sets the weights for text indexes.
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 methodGetIndexName
Gets the name of the index.
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