com.mongodb.bulk

Class IndexRequest

java.lang.Object

com.mongodb.bulk.IndexRequest

public class IndexRequest
extends Object

The settings to apply to the creation of an index.

Since:

3.0

MongoDB documentation

Index options

Constructor Summary

Constructors

Constructor and Description
IndexRequest(BsonDocument keys) Construct a new instance with the given keys

Method Summary

Methods

Modifier and Type	Method and Description
IndexRequest	background(boolean background) Should the index should be created in the background
IndexRequest	bits(Integer bits) Sets the number of precision of the stored geohash value of the location data in 2d indexes.
IndexRequest	bucketSize(Double bucketSize) Sets the specified the number of units within which to group the location values for geoHaystack Indexes
IndexRequest	defaultLanguage(String defaultLanguage) Sets the language for the text index.
IndexRequest	dropDups(boolean dropDups) Sets the legacy dropDups setting
IndexRequest	expireAfter(Long expireAfter, TimeUnit timeUnit) Sets the time to live for documents in the collection
Integer	getBits() Gets the number of precision of the stored geohash value of the location data in 2d indexes.
Double	getBucketSize() Gets the specified the number of units within which to group the location values for geoHaystack Indexes
String	getDefaultLanguage() Gets the language for a text index.
boolean	getDropDups() Returns the legacy dropDups setting
Long	getExpireAfter(TimeUnit timeUnit) Gets the time to live for documents in the collection
BsonDocument	getKeys() Gets the index keys
String	getLanguageOverride() Gets the name of the field that contains the language string.
Double	getMax() Gets the upper inclusive boundary for the longitude and latitude values for 2d indexes..
Double	getMin() Gets the lower inclusive boundary for the longitude and latitude values for 2d indexes..
String	getName() Gets the name of the index.
Integer	getSphereVersion() Gets the 2dsphere index version number.
BsonDocument	getStorageEngine() Gets the storage engine options document for this index.
Integer	getTextVersion() The text index version number.
Integer	getVersion() Gets the index version number.
BsonDocument	getWeights() Gets the weighting object for use with a text index
boolean	isBackground() Create the index in the background
boolean	isSparse() If true, the index only references documents with the specified field
boolean	isUnique() Gets if the index should be unique.
IndexRequest	languageOverride(String languageOverride) Sets the name of the field that contains the language string.
IndexRequest	max(Double max) Sets the upper inclusive boundary for the longitude and latitude values for 2d indexes..
IndexRequest	min(Double min) Sets the lower inclusive boundary for the longitude and latitude values for 2d indexes..
IndexRequest	name(String name) Sets the name of the index.
IndexRequest	sparse(boolean sparse) Should the index only references documents with the specified field
IndexRequest	sphereVersion(Integer sphereVersion) Sets the 2dsphere index version number.
IndexRequest	storageEngine(BsonDocument storageEngineOptions) Sets the storage engine options document for this index.
IndexRequest	textVersion(Integer textVersion) Set the text index version number.
IndexRequest	unique(boolean unique) Should the index should be unique.
IndexRequest	version(Integer version) Sets the index version number.
IndexRequest	weights(BsonDocument weights) Sets the weighting object for use with a text index.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndexRequest

public IndexRequest(BsonDocument keys)

Construct a new instance with the given keys

Parameters:

keys - the index keys

Method Detail

getKeys

public BsonDocument getKeys()

Gets the index keys

Returns:

the index keys

isBackground

public boolean isBackground()

Create the index in the background

Returns:

true if should create the index in the background

background

public IndexRequest background(boolean background)

Should the index should be created in the background

Parameters:

background - true if should create the index in the background

Returns:

this

isUnique

public boolean isUnique()

Gets if the index should be unique.

Returns:

true if the index should be unique

unique

public IndexRequest unique(boolean unique)

Should the index should be unique.

Parameters:

unique - if the index should be unique

Returns:

this

getName

public String getName()

Gets the name of the index.

Returns:

the name of the index

name

public IndexRequest name(String name)

Sets the name of the index.

Parameters:

name - of the index

Returns:

this

isSparse

public boolean isSparse()

If true, the index only references documents with the specified field

Returns:

if the index should only reference documents with the specified field

sparse

public IndexRequest sparse(boolean sparse)

Should the index only references documents with the specified field

Parameters:

sparse - if true, the index only references documents with the specified field

Returns:

this

getExpireAfter

public Long getExpireAfter(TimeUnit timeUnit)

Gets the time to live for documents in the collection

Parameters:

timeUnit - the time unit

Returns:

the time to live for documents in the collection

MongoDB documentation

TTL

expireAfter

public IndexRequest expireAfter(Long expireAfter,
                       TimeUnit timeUnit)

Sets the time to live for documents in the collection

Parameters:

expireAfter - the time to live for documents in the collection

timeUnit - the time unit

Returns:

this

MongoDB documentation

TTL

getVersion

public Integer getVersion()

Gets the index version number.

Returns:

the index version number

version

public IndexRequest version(Integer version)

Sets the index version number.

Parameters:

version - the index version number

Returns:

this

getWeights

public BsonDocument getWeights()

Gets the weighting object for use with a text index

A document that represents field and weight pairs. The weight is an integer ranging from 1 to 99,999 and denotes the significance of the field relative to the other indexed fields in terms of the score.

Returns:

the weighting object

MongoDB documentation

Control Search Results with Weights

weights

public IndexRequest weights(BsonDocument weights)

Sets the weighting object for use with a text index.

An document that represents field and weight pairs. The weight is an integer ranging from 1 to 99,999 and denotes the significance of the field relative to the other indexed fields in terms of the score.

Parameters:

weights - the weighting object

Returns:

this

MongoDB documentation

Control Search Results with Weights

getDefaultLanguage

public String getDefaultLanguage()

Gets the language for a text index.

The language that determines the list of stop words and the rules for the stemmer and tokenizer.

Returns:

the language for a text index.

MongoDB documentation

Text Search languages

defaultLanguage

public IndexRequest defaultLanguage(String defaultLanguage)

Sets the language for the text index.

The language that determines the list of stop words and the rules for the stemmer and tokenizer.

Parameters:

defaultLanguage - the language for the text index.

Returns:

this

MongoDB documentation

Text Search languages

getLanguageOverride

public String getLanguageOverride()

Gets the name of the field that contains the language string.

For text indexes, the name of the field, in the collection's documents, that contains the override language for the document.

Returns:

the name of the field that contains the language string.

MongoDB documentation

Language override

languageOverride

public IndexRequest languageOverride(String languageOverride)

Sets the name of the field that contains the language string.

For text indexes, the name of the field, in the collection's documents, that contains the override language for the document.

Parameters:

languageOverride - the name of the field that contains the language string.

Returns:

this

MongoDB documentation

Language override

getTextVersion

public Integer getTextVersion()

The text index version number.

Returns:

the text index version number.

textVersion

public IndexRequest textVersion(Integer textVersion)

Set the text index version number.

Parameters:

textVersion - the text index version number.

Returns:

this

getSphereVersion

public Integer getSphereVersion()

Gets the 2dsphere index version number.

Returns:

the 2dsphere index version number

sphereVersion

public IndexRequest sphereVersion(Integer sphereVersion)

Sets the 2dsphere index version number.

Parameters:

sphereVersion - the 2dsphere index version number.

Returns:

this

getBits

public Integer getBits()

Gets the number of precision of the stored geohash value of the location data in 2d indexes.

Returns:

the number of precision of the stored geohash value

bits

public IndexRequest bits(Integer bits)

Sets the number of precision of the stored geohash value of the location data in 2d indexes.

Parameters:

bits - the number of precision of the stored geohash value

Returns:

this

getMin

public Double getMin()

Gets the lower inclusive boundary for the longitude and latitude values for 2d indexes..

Returns:

the lower inclusive boundary for the longitude and latitude values.

min

public IndexRequest min(Double min)

Sets the lower inclusive boundary for the longitude and latitude values for 2d indexes..

Parameters:

min - the lower inclusive boundary for the longitude and latitude values

Returns:

this

getMax

public Double getMax()

Gets the upper inclusive boundary for the longitude and latitude values for 2d indexes..

Returns:

the upper inclusive boundary for the longitude and latitude values.

max

public IndexRequest max(Double max)

Sets the upper inclusive boundary for the longitude and latitude values for 2d indexes..

Parameters:

max - the upper inclusive boundary for the longitude and latitude values

Returns:

this

getBucketSize

public Double getBucketSize()

Gets the specified the number of units within which to group the location values for geoHaystack Indexes

Returns:

the specified the number of units within which to group the location values for geoHaystack Indexes

MongoDB documentation

geoHaystack Indexes

bucketSize

public IndexRequest bucketSize(Double bucketSize)

Sets the specified the number of units within which to group the location values for geoHaystack Indexes

Parameters:

bucketSize - the specified the number of units within which to group the location values for geoHaystack Indexes

Returns:

this

MongoDB documentation

geoHaystack Indexes

getDropDups

public boolean getDropDups()

Returns the legacy dropDups setting

Prior to MongoDB 3.0 dropDups could be used with unique indexes allowing documents with duplicate values to be dropped when building the index. Later versions of MongoDB will silently ignore this setting.

Returns:

the legacy dropDups setting

MongoDB documentation

duplicate dropping

dropDups

public IndexRequest dropDups(boolean dropDups)

Sets the legacy dropDups setting

Prior to MongoDB 3.0 dropDups could be used with unique indexes allowing documents with duplicate values to be dropped when building the index. Later versions of MongoDB will silently ignore this setting.

Parameters:

dropDups - the legacy dropDups setting

Returns:

this

MongoDB documentation

duplicate dropping

getStorageEngine

public BsonDocument getStorageEngine()

Gets the storage engine options document for this index.

Returns:

the storage engine options

Since server release

3.0

storageEngine

public IndexRequest storageEngine(BsonDocument storageEngineOptions)

Sets the storage engine options document for this index.

Parameters:

storageEngineOptions - the storate engine options

Returns:

this

Since server release

3.0