org.eclipse.persistence.annotations

Annotation Type Index

@Target(value={METHOD,FIELD,TYPE})
 @Retention(value=RUNTIME)
public @interface Index

Allow a database INDEX to be define when generating DDL. The @Index can be defined on a Entity class, or on an attribute. The column is defaulted when defined on a attribute.

Author:

James Sutherland

Since:

EclipseLink 2.2

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	catalog The catalog of the INDEX
java.lang.String[]	columnNames Specify the set of columns to define the index on.
java.lang.String	name The name of the INDEX, defaults to INDEX_<table-name>
java.lang.String	schema The schema of the INDEX
java.lang.String	table The table to define the index on, defaults to entities primary table.
boolean	unique

Element Detail

name

public abstract java.lang.String name

The name of the INDEX, defaults to INDEX_<table-name>

Default:

""

schema

public abstract java.lang.String schema

The schema of the INDEX

Default:

""

catalog

public abstract java.lang.String catalog

The catalog of the INDEX

Default:

""

table

public abstract java.lang.String table

The table to define the index on, defaults to entities primary table.

Default:

""

unique

public abstract boolean unique

Default:

false

columnNames

public abstract java.lang.String[] columnNames

Specify the set of columns to define the index on. Not required when annotated on a field/method.

Default:

{}