javax.persistence

public @Interface Index

Annotations

Static Imports

java.lang.annotation.RetentionPolicy.RUNTIME

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.

Since: Java Persistence 2.1
See Also: Table, SecondaryTable, CollectionTable, JoinTable, TableGenerator

Method Summary

Modifier and Type	Method and Description
public String	columnList() (Required) The names of the columns to be included in the index, in order.
public String	name() (Optional) The name of the index; defaults to a provider-generated name.
public boolean	unique() (Optional) Whether the index is unique.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

columnList	back to summary
public String columnList() (Required) The names of the columns to be included in the index, in order.

name	back to summary
public String name() (Optional) The name of the index; defaults to a provider-generated name.

unique	back to summary
public boolean unique() (Optional) Whether the index is unique.