Jump to: navigation, search

EclipseLink/UserGuide/JPA/Advanced JPA Development/Schema Generation/Index

EclipseLink JPA

Mailing ListForumsIRCmattermost
OpenHelp WantedBug Day
Browse Source

@Index Annotation

An index is a database structure defined for a table, to improve query and look-up performance for a set of columns. Use the @Index annotation in code or the <index> element in the orm.xml descriptor to create an index on a table.

An index can be defined on an Entity or on an attribute. For the Entity it must define a set of columns to index.

Index creation is database specific, some databases may not support indexes. Most databases auto index primary key and foriegn key columns. Some databases support advanced index DDL options. To create more advanced index DDL, a DDL script or native query can be used.

@Index Attributes
Attribute Description Default Required?
catalog The catalog of the INDEX. Default catalog No
columnNames Specify the set of columns to define the index on. For an Entity , the table. For an attribute, the table and column. Not required when annotated on a field or method.
name The name of the INDEX. <table>_<column>_INDEX (but a name should be provided) No
schema The schema of the INDEX. Default schema No
table The table to define the index on, defaults to entities primary table. The entity's primary table. No
unique Specify whether the index is unique or non-unique. false No

@Index Annotation Example This example defines three indexes, one on firstName, one on lastName, and a multiple column index on first/lastName.

@Index(name="EMP_NAME_INDEX", columns={"F_NAME","L_NAME"})
public class Employee{
    private long id;
    private String firstName;
    private String lastName;

Defining an Index in eclipselink-orm.xml

Create an index in eclipselink-orm.xml using <index>, as shown in the following example. Define columns using the <column> subelement to define columns. All the attributes supported in the @Index annotation are also supported in the <index> element.

<index name="EMP_NAME_INDEX" table="EMPLOYEE" unique="true">

Version: 2.2.0 DRAFT
Other versions...