JPA Annotation

Index

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

Note that it is not necessary to specify an index for a primary key, as the primary key index will be created automatically.

The syntax of the columnList element is a column_list, as follows: 

    column::= index_column [,index_column]

    index_column::= column_name [ASC | DESC]

If ASC or DESC is not specified, ASC (ascending order) is assumed.

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

Public Annotation Attributes

String columnList default null
(Required) The names of the columns to be included in the index, in order.
Since:
JPA 2.1
String name default ""
(Optional) The name of the index; defaults to a provider-generated name.
Since:
JPA 2.1
boolean unique default false
(Optional) Whether the index is unique.
Since:
JPA 2.1