IndexOptions(TDocument) Class

IndexOptionsTDocument Class

A builder for the options used when creating an index.

Inheritance Hierarchy

SystemObject
MongoDB.Driver.BuildersIndexOptionsTDocument

Namespace: MongoDB.Driver.Builders
Assembly: MongoDB.Driver.Legacy (in MongoDB.Driver.Legacy.dll) Version: 2.4.1

Syntax

public static class IndexOptions<TDocument>

Public NotInheritable Class IndexOptions(Of TDocument)

[<AbstractClassAttribute>]
[<SealedAttribute>]
type IndexOptions<'TDocument> =  class end

The IndexOptionsTDocument type exposes the following members.

Methods

	Name	Description
	SetBackground	Sets whether to build the index in the background.
	SetBits	Sets the location precision bits.
	SetBucketSize	Sets the bucket size for geospatial haystack indexes.
	SetDropDups	Sets whether duplicates should be dropped.
	SetGeoSpatialRange	Sets the geospatial range.
	SetName	Sets the name of the index.
	SetPartialFilterExpression	Sets the partial filter expression.
	SetSparse	Sets whether the index is a sparse index.
	SetStorageEngineOptions	Sets the storage engine options.
	SetTextDefaultLanguage	Sets the default language for the text index.
	SetTextLanguageOverride	Specifies a member expression for the field name containing the language for the text index.
	SetTimeToLive	Sets the time to live value.
	SetUnique	Sets whether the index enforces unique values.
	SetWeightTMember	Sets the weight of a field for the text index.

Properties

	Name	Description
	Null	Gets a null value with a type of IMongoIndexOptions.