Module org.eclipse.persistence.core
Annotation Type 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.
- Since:
- EclipseLink 2.2
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionThe catalog of the INDEXString[]
Specify the set of columns to define the index on.The name of the INDEX, defaults to INDEX_<table-name>The schema of the INDEXThe table to define the index on, defaults to entities primary table.boolean
-
Element Details
-
name
String nameThe name of the INDEX, defaults to INDEX_<table-name>- Default:
""
-
schema
String schemaThe schema of the INDEX- Default:
""
-
catalog
String catalogThe catalog of the INDEX- Default:
""
-
table
String tableThe table to define the index on, defaults to entities primary table.- Default:
""
-
unique
boolean unique- Default:
false
-
columnNames
String[] columnNamesSpecify the set of columns to define the index on. Not required when annotated on a field/method.- Default:
{}
-