Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "EclipseLink/DesignDocs/283430"
< EclipseLink | DesignDocs
(→Config files) |
|||
| Line 20: | Line 20: | ||
= Project overview = | = Project overview = | ||
| − | + | The ability to define database indexes and have EclipseLink's DDL generation generate them. | |
= Concepts = | = Concepts = | ||
| − | + | An index is a database structure define for a table to improve query and lookup performance for a set of columns. | |
= Requirements = | = Requirements = | ||
| + | Support defining indexes in JPA through annotations. | ||
| + | Support defining indexes in JPA through XML. | ||
| Line 34: | Line 36: | ||
= Functionality = | = Functionality = | ||
| + | An @Index annotation and XML will be added. An index can be defined on an Entity, or attribute. | ||
| + | For the Entity it must define a set of columns to index, the table will be defaulted. | ||
| + | For an attribute the table and column will be defaulted. | ||
| + | The name of the index will be default to <table>_<column>_INDEX, but the name should normally be provided. | ||
| + | |||
| + | An IndexDefinition will also be added to the schema framework to allow defining, creating/dropping indexes through code. | ||
| + | Annotation process will create an IndexDefinition from the @Index and store in on the descriptor's DatabaseTable. | ||
| + | During default schema generation the DefaultSchemaGenerator will add the IndexDefinition to the TableDefition to be created. | ||
| + | |||
| + | The existing support to create indexes for primary key and unique constraints will be refactored to use the IndexDefinition. | ||
| + | Support for indexes will be defined in the platform, by default a platform will be assumed to support indexes. | ||
| + | MySQL will require special drop syntax, to include the table name in the drop statement. | ||
= Testing = | = Testing = | ||
| Line 49: | Line 63: | ||
* orm.xml | * orm.xml | ||
<source lang="xml"> | <source lang="xml"> | ||
| − | <index name=" | + | <index name="EMP_NAME_INDEX" table="EMPLOYEE" unique="true"> |
<column name="F_NAME"/> | <column name="F_NAME"/> | ||
<column name="L_NAME"/> | <column name="L_NAME"/> | ||
Revision as of 13:23, 26 August 2010
Design Specification: Indexes
Document History
| Date | Author | Version Description & Notes |
|---|---|---|
| 2010-08-25 | James | 0.1 Draft |
Project overview
The ability to define database indexes and have EclipseLink's DDL generation generate them.
Concepts
An index is a database structure define for a table to improve query and lookup performance for a set of columns.
Requirements
Support defining indexes in JPA through annotations. Support defining indexes in JPA through XML.
Design Constraints
Functionality
An @Index annotation and XML will be added. An index can be defined on an Entity, or attribute. For the Entity it must define a set of columns to index, the table will be defaulted. For an attribute the table and column will be defaulted.
The name of the index will be default to| Issue # | Owner | Description / Notes |
|---|---|---|
| 1 | What databases support indexes, do any use a different syntax? |
Decisions
| Issue # | Description / Notes | Decision |
|---|
Future Considerations
- Other DDL options.