Jump to: navigation, search

Difference between revisions of "EclipseLink/UserGuide/JPA/Advanced JPA Development/Schema Generation/Index"

(7 intermediate revisions by 2 users not shown)
Line 7: Line 7:
 
|apis=  
 
|apis=  
 
* [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/annotations/Index.html @Index]
 
* [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/annotations/Index.html @Index]
 +
|nativeapi=y
 +
|nativeapis=
 
* [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/tools/schemaframework/IndexDefinition.html IndexDefinition]
 
* [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/tools/schemaframework/IndexDefinition.html IndexDefinition]
 
}}
 
}}
  
=@Index Annotation=
+
=@Index=
  
 
An index is a database structure defined for a table, to improve query and look-up performance for a set of columns.  
 
An index is a database structure defined for a table, to improve query and look-up performance for a set of columns.  
Use the [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/annotations/Index.html <tt>@Index</tt>] annotation in code or the <tt><index></tt> element in the <tt>orm.xml</tt> descriptor to create an index on a table.  
+
Use the [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/annotations/Index.html <tt>@Index</tt>] annotation in code or the <tt><index></tt> element in the <tt>eclipselink-orm.xml</tt> 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.   
+
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.
+
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.
Some databases support advanced index DDL options. To create more advanced index DDL, a DDL script or native query can be used.
+
  
 
{{EclipseLink_AttributeTable
 
{{EclipseLink_AttributeTable
Line 61: Line 62:
 
}}
 
}}
  
<span id=Index_Annotation_Example></span>
+
This example defines three indexes, one on first name, one on last name, and a multiple column index on first name and last name.
'''@Index Annotation Example'''
+
This example defines three indexes, one on firstName, one on lastName, and a multiple column index on first/lastName.
+
 
<source lang="java">  
 
<source lang="java">  
 
@Entity
 
@Entity
Line 80: Line 79:
 
</source>
 
</source>
  
== Defining an Index in eclipselink-orm.xml ==
 
  
Create an index in <tt>eclipselink-orm.xml</tt> using <tt><index></tt>, as shown in the following example. Define columns using the <tt><column></tt> subelement to define columns. All the attributes supported in the @Index annotation are also supported in the <tt><index></tt> element.
+
You can also create an index in the <tt>eclipselink-orm.xml</tt> descriptor using <tt><index></tt>, as shown in the following example. Define columns using the <tt><column></tt> subelement. All the attributes supported in the <tt>@Index</tt> annotation are also supported in the <tt><index></tt> element.
  
 
<source lang="xml">
 
<source lang="xml">
Line 93: Line 91:
 
{{EclipseLink_JPA
 
{{EclipseLink_JPA
  
|previous =[[EclipseLink/UserGuide/JPA/Advanced_JPA_Development/Schema_Generation|Schema Generation]]
+
|previous =[[EclipseLink/UserGuide/JPA/Advanced_JPA_Development/Schema_Generation/CascadeOnDelete|@CascadeOnDelete]]
 
|up      =[[EclipseLink/UserGuide/JPA/Advanced_JPA_Development/Schema_Generation|Schema Generation]]
 
|up      =[[EclipseLink/UserGuide/JPA/Advanced_JPA_Development/Schema_Generation|Schema Generation]]
|next =[[EclipseLink/UserGuide/JPA/Advanced_JPA_Development/Schema_Generation/CascadeOnDelete|@CascadeOnDelete]]
+
|next =[[EclipseLink/UserGuide/JPA/Advanced_JPA_Development/Schema_Generation/Appending_strings_to_CREATE_TABLE_statements|Appending Strings to CREATE TABLE Statements]]
 
|version=2.2.0 DRAFT}}
 
|version=2.2.0 DRAFT}}

Revision as of 09:07, 21 June 2011

EclipseLink JPA

link="http://wiki.eclipse.org/EclipseLink"
EclipseLink
Website
Download
Community
Mailing ListForumsIRC
Bugzilla
Open
Help Wanted
Bug Day
Contribute
Browse Source

Elug api package icon.png Key API

Elug api package icon.png Native API


@Index

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 eclipselink-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

This example defines three indexes, one on first name, one on last name, and a multiple column index on first name and last name.

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


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

<index name="EMP_NAME_INDEX" table="EMPLOYEE" unique="true">
    <column>F_NAME</column>
    <column>L_NAME</column>
</index>

Eclipselink-logo.gif
Version: 2.2.0 DRAFT
Other versions...