org.mongodb.morphia.annotations

Annotation Type Indexed

@Documented
 @Inherited
 @Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface Indexed

Specified on fields that should be Indexed.

Author:

Scott Hernandez

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	background Deprecated. use the IndexOptions found in options()
boolean	dropDups Deprecated. use the IndexOptions found in options()
int	expireAfterSeconds Deprecated. use the IndexOptions found in options()
String	name Deprecated. use the IndexOptions found in options()
IndexOptions	options Options to apply to the index.
boolean	sparse Deprecated. use the IndexOptions found in options()
boolean	unique Deprecated. use the IndexOptions found in options()
IndexDirection	value Deprecated. use the IndexOptions found in options()

Element Detail

options

public abstract IndexOptions options

Options to apply to the index. Use of this field will ignore any of the deprecated options defined on Index directly.

Default:

@org.mongodb.morphia.annotations.IndexOptions

background

@Deprecated
public abstract boolean background

Deprecated. use the IndexOptions found in options()

Create the index in the background?

Default:

false

dropDups

@Deprecated
public abstract boolean dropDups

Deprecated. use the IndexOptions found in options()

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

Default:

false

expireAfterSeconds

@Deprecated
public abstract int expireAfterSeconds

Deprecated. use the IndexOptions found in options()

defines the time to live for documents in the collection

Default:

-1

name

@Deprecated
public abstract String name

Deprecated. use the IndexOptions found in options()

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:

""

sparse

@Deprecated
public abstract boolean sparse

Deprecated. use the IndexOptions found in options()

Create the index with the sparse option

Default:

false

unique

@Deprecated
public abstract boolean unique

Deprecated. use the IndexOptions found in options()

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

Default:

false

value

@Deprecated
public abstract IndexDirection value

Deprecated. use the IndexOptions found in options()

Indicates the direction of the index (ascending, descending); default is ascending

Default:

org.mongodb.morphia.utils.IndexDirection.ASC