io.ebean.annotation

Annotation Type Index

@Target(value={TYPE,FIELD})
 @Retention(value=RUNTIME)
 @Repeatable(value=Indices.class)
public @interface Index

An annotation for declaring an index.

Author:

rvbiljouw

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	columnNames When placed on the class (rather than field) you can specify the columns to include in the index in order.
String	name Name of the index.
boolean	unique If set true indicates this is a unique index.

Element Detail

name

public abstract String name

Name of the index. If left blank a name is derived using the built in naming convention.

Default:

""

unique

public abstract boolean unique

If set true indicates this is a unique index.

Default:

false

columnNames

public abstract String[] columnNames

When placed on the class (rather than field) you can specify the columns to include in the index in order.

When placed on a field, and columnNames are specified, the field-column has to be included. You can use "${fa}" for alias.

Default:

{}