com.mongodb.client.model

Class CreateIndexOptions

java.lang.Object

com.mongodb.client.model.CreateIndexOptions

public class CreateIndexOptions
extends Object

The options to apply to an operation that atomically finds a document and deletes it.

Since:

3.0

MongoDB documentation

Index options

Constructor Summary

Constructors

Constructor and Description
CreateIndexOptions()

Method Summary

Methods

Modifier and Type	Method and Description
CreateIndexOptions	background(boolean background) Should the index should be created in the background
CreateIndexOptions	bits(Integer bits) Sets the number of precision of the stored geohash value of the location data in 2d indexes.
CreateIndexOptions	bucketSize(Double bucketSize) Sets the specified the number of units within which to group the location values for geoHaystack Indexes
CreateIndexOptions	defaultLanguage(String defaultLanguage) Sets the language for the text index.
CreateIndexOptions	expireAfterSeconds(Integer expireAfterSeconds) s 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.
Integer	getExpireAfterSeconds() Gets the time to live for documents in the collection
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	getTextIndexVersion() The text index version number.
Integer	getTwoDSphereIndexVersion() Gets the 2dsphere index version number.
Integer	getVersion() Gets the index version number.
Bson	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.
CreateIndexOptions	languageOverride(String languageOverride) Sets the name of the field that contains the language string.
CreateIndexOptions	max(Double max) Sets the upper inclusive boundary for the longitude and latitude values for 2d indexes..
CreateIndexOptions	min(Double min) Sets the lower inclusive boundary for the longitude and latitude values for 2d indexes..
CreateIndexOptions	name(String name) Sets the name of the index.
CreateIndexOptions	sparse(boolean sparse) Should the index only references documents with the specified field
CreateIndexOptions	textIndexVersion(int textIndexVersion) Set the text index version number.
CreateIndexOptions	twoDSphereIndexVersion(int sphereIndexVersion) Sets the 2dsphere index version number.
CreateIndexOptions	unique(boolean unique) Should the index should be unique.
CreateIndexOptions	version(Integer version) Sets the index version number.
CreateIndexOptions	weights(Bson 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

CreateIndexOptions

public CreateIndexOptions()

Method Detail

isBackground

public boolean isBackground()

Create the index in the background

Returns:

true if should create the index in the background

background

public CreateIndexOptions 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 CreateIndexOptions 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 CreateIndexOptions 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 CreateIndexOptions 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

getExpireAfterSeconds

public Integer getExpireAfterSeconds()

Gets the time to live for documents in the collection

Returns:

the time to live for documents in the collection

MongoDB documentation

TTL

expireAfterSeconds

public CreateIndexOptions expireAfterSeconds(Integer expireAfterSeconds)

s the time to live for documents in the collection

Parameters:

expireAfterSeconds - the time to live for documents in the collection

Returns:

this

MongoDB documentation

TTL

getVersion

public Integer getVersion()

Gets the index version number.

Returns:

the index version number

version

public CreateIndexOptions version(Integer version)

Sets the index version number.

Parameters:

version - the index version number

Returns:

this

getWeights

public Bson 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 CreateIndexOptions weights(Bson 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 CreateIndexOptions 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 CreateIndexOptions 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

getTextIndexVersion

public Integer getTextIndexVersion()

The text index version number.

Returns:

the text index version number.

textIndexVersion

public CreateIndexOptions textIndexVersion(int textIndexVersion)

Set the text index version number.

Parameters:

textIndexVersion - the text index version number.

Returns:

this

getTwoDSphereIndexVersion

public Integer getTwoDSphereIndexVersion()

Gets the 2dsphere index version number.

Returns:

the 2dsphere index version number

twoDSphereIndexVersion

public CreateIndexOptions twoDSphereIndexVersion(int sphereIndexVersion)

Sets the 2dsphere index version number.

Parameters:

sphereIndexVersion - 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 CreateIndexOptions 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 CreateIndexOptions 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 CreateIndexOptions 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 CreateIndexOptions 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