org.mongodb.morphia.annotations

Annotation Type IndexOptions

@Documented
@Inherited
@Retention(value=RUNTIME)
@Target(value=ANNOTATION_TYPE)
public @interface IndexOptions

Defines the options to be used when declaring an index.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	background Create the index in the background
boolean	disableValidation disables validation for the field name
boolean	dropDups Tells the unique index to drop duplicates silently when creating; only the first will be kept
int	expireAfterSeconds defines the time to live for documents in the collection
String	language Default language for the index.
String	languageOverride The field to use to override the default language.
String	name The name of the index to create; default is to let the mongodb create a name (in the form of key1_1/-1_key2_1/-1...)
boolean	sparse Create the index with the sparse option
boolean	unique Creates the index as a unique value index; inserting duplicates values in this field will cause errors

Element Detail

name

public abstract String name

The name of the index to create; default is to let the mongodb create a name (in the form of key1_1/-1_key2_1/-1...)

Default:

""

unique

public abstract boolean unique

Creates the index as a unique value index; inserting duplicates values in this field will cause errors

Default:

false

dropDups

public abstract boolean dropDups

Tells the unique index to drop duplicates silently when creating; only the first will be kept

Default:

false

background

public abstract boolean background

Create the index in the background

Default:

false

sparse

public abstract boolean sparse

Create the index with the sparse option

Default:

false

disableValidation

public abstract boolean disableValidation

disables validation for the field name

Default:

false

expireAfterSeconds

public abstract int expireAfterSeconds

defines the time to live for documents in the collection

Default:

-1

language

public abstract String language

Default language for the index.

Default:

""

languageOverride

public abstract String languageOverride

The field to use to override the default language.

Default:

""