JPA Annotation

Index

Implemented Interfaces:
Annotation
Used in schema generation to specify creation of an index.

The syntax of the columnList element is given by the following simple BNF: 

     column_list ::= index_column [, index_column]

     index_column ::= column_name [ASC | DESC]

If neither ASC nor DESC is not specified, ASC, that is, ascending order, is assumed.

Note that it is not necessary to specify an index for a primary key, as the primary key has a unique constraint with an index created automatically.

See Also:
Table
SecondaryTable
CollectionTable
JoinTable
TableGenerator
Since:
JPA 2.1

Public Annotation Attributes

String columnList default null
(Required) The columns included in the index, in order, following the BNF rule column_list given above.
Since:
JPA 2.1
String name default ""
(Optional) The name of the index.

Defaults to a provider-generated name.

Since:
JPA 2.1
String options default ""
(Optional) A SQL fragment appended to the generated DDL which creates this index.
Since:
JPA 3.2
boolean unique default false
(Optional) Whether the index is unique.
Since:
JPA 2.1