Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "EclipseLink/Development/Documentation/JPA"
< EclipseLink | Development | Documentation
m (→Table of Contents) |
m (→Table of Contents) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
= EclipseLink JPA User's Guide = | = EclipseLink JPA User's Guide = | ||
| + | |||
| + | As a result of community input during the Ottawa EclipseLink summit, the JPA User's Guide will remain in wiki format. | ||
| + | |||
| + | The new, 2.0.2 (in progress) docs: http://wiki.eclipse.org/EclipseLink/UserGuide/JPA | ||
| + | |||
== Development == | == Development == | ||
| Line 13: | Line 18: | ||
== Table of Contents == | == Table of Contents == | ||
| + | {{EclipseLink_Warning | ||
| + | |warning=This table of contents is out of date. Please refer to the [[EclipseLink/UserGuide/JPA|EclipseLink JPA User's Guide]] for current documentation. | ||
| + | }} | ||
The following is the proposed TOC which is currently '''under development'''. Where applicable, show where existing ELUG wiki pages can be mined for initial content. | The following is the proposed TOC which is currently '''under development'''. Where applicable, show where existing ELUG wiki pages can be mined for initial content. | ||
| Line 22: | Line 30: | ||
**** persistence.xml <br /> '' edit content from http://wiki.eclipse.org/Using_EclipseLink_JPA_Extensions_(ELUG)#What_You_May_Need_to_Know_About_Using_EclipseLink_JPA_Persistence_Unit_Properties and http://wiki.eclipse.org/Packaging_and_Deploying_EclipseLink_JPA_Applications_(ELUG)#How_to_Specify_the_Persistence_Unit_Name'' | **** persistence.xml <br /> '' edit content from http://wiki.eclipse.org/Using_EclipseLink_JPA_Extensions_(ELUG)#What_You_May_Need_to_Know_About_Using_EclipseLink_JPA_Persistence_Unit_Properties and http://wiki.eclipse.org/Packaging_and_Deploying_EclipseLink_JPA_Applications_(ELUG)#How_to_Specify_the_Persistence_Unit_Name'' | ||
**** annotations | **** annotations | ||
| − | **** orm.xml | + | **** orm.xml <br /> ''edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_JPA_(ELUG)#Using_XML '' |
**** defaults <br /> '' edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_JPA_(ELUG)#Defaulting_Properties '' | **** defaults <br /> '' edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_JPA_(ELUG)#Defaulting_Properties '' | ||
**** eclipselink-orm.xml <br /> '' edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_JPA_(ELUG)#Overriding_and_Merging_XML '' | **** eclipselink-orm.xml <br /> '' edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_JPA_(ELUG)#Overriding_and_Merging_XML '' | ||
** Mapping | ** Mapping | ||
*** Entity <br /> '' edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_JPA_(ELUG)#Configuring_an_Entity '' | *** Entity <br /> '' edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_JPA_(ELUG)#Configuring_an_Entity '' | ||
| − | **** Id | + | **** Id <br /> ''edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_JPA_(ELUG)#.40Id '' |
*** Basic Mappings <br /> '' edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_JPA_(ELUG)#Declaring_Basic_Property_Mappings '' | *** Basic Mappings <br /> '' edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_JPA_(ELUG)#Declaring_Basic_Property_Mappings '' | ||
**** Column | **** Column | ||
| Line 45: | Line 53: | ||
*** Type & Size | *** Type & Size | ||
*** Expiration | *** Expiration | ||
| − | *** Coordination | + | *** Coordination <br /> ''edit content from http://wiki.eclipse.org and http://wiki.eclipse.org/Configuring_a_Coordinated_Cache_(ELUG)/Introduction_to_Cache_(ELUG)#When_to_Use_Cache_Coordination '' |
** Querying | ** Querying | ||
*** Overview of approaches: JPQL, Criteria, Native <br /> ''edit content from http://wiki.eclipse.org/Using_Basic_Query_API_(ELUG) and http://wiki.eclipse.org/Using_Advanced_Query_API_(ELUG) '' | *** Overview of approaches: JPQL, Criteria, Native <br /> ''edit content from http://wiki.eclipse.org/Using_Basic_Query_API_(ELUG) and http://wiki.eclipse.org/Using_Advanced_Query_API_(ELUG) '' | ||
| Line 54: | Line 62: | ||
*** Performance Profiling <br /> ''edit content from http://wiki.eclipse.org/Optimizing_the_EclipseLink_Application_(ELUG)#Measuring_EclipseLink_Performance_with_the_EclipseLink_Profiler '' | *** Performance Profiling <br /> ''edit content from http://wiki.eclipse.org/Optimizing_the_EclipseLink_Application_(ELUG)#Measuring_EclipseLink_Performance_with_the_EclipseLink_Profiler '' | ||
*** Weaving (What is it and why do I care) <br /> ''edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_Application_Development_(ELUG)#Using_Weaving and http://wiki.eclipse.org/Using_EclipseLink_JPA_Extensions_(ELUG)#Using_EclipseLink_JPA_Weaving'' | *** Weaving (What is it and why do I care) <br /> ''edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_Application_Development_(ELUG)#Using_Weaving and http://wiki.eclipse.org/Using_EclipseLink_JPA_Extensions_(ELUG)#Using_EclipseLink_JPA_Weaving'' | ||
| + | ****Understanding Weaving | ||
| + | *****Weaving JPA Entities | ||
| + | *****Weaving POJO Classes | ||
| + | *****Weaving and Java EE Application Servers | ||
| + | ****Configuring Dynamic Weaving | ||
| + | ****Configuring Static Weaving | ||
| + | ****Disabling Weaving with Persistence Unit Properties | ||
*** FetchGroups <br /> ''edit content from http://wiki.eclipse.org/Developing_Applications_Using_EclipseLink_JPA_(ELUG)#How_to_Configure_Fetch_Groups'' | *** FetchGroups <br /> ''edit content from http://wiki.eclipse.org/Developing_Applications_Using_EclipseLink_JPA_(ELUG)#How_to_Configure_Fetch_Groups'' | ||
** Platform Specific <br /> ''edit content from http://wiki.eclipse.org/Developing_Applications_Using_EclipseLink_JPA_(ELUG) '' | ** Platform Specific <br /> ''edit content from http://wiki.eclipse.org/Developing_Applications_Using_EclipseLink_JPA_(ELUG) '' | ||
Latest revision as of 13:43, 22 June 2010
EclipseLink JPA User's Guide
As a result of community input during the Ottawa EclipseLink summit, the JPA User's Guide will remain in wiki format.
The new, 2.0.2 (in progress) docs: http://wiki.eclipse.org/EclipseLink/UserGuide/JPA
Development
The EclipseLink JPA User's Guide is being developed within the EclipseLink SVN repository @ https://dev.eclipse.org/svnroot/rt/org.eclipse.persistence/trunk/documentation/guides/jpa
OpenOffice
To edit the content XML files in OTN XSLT transforms are required. These DocBook transforms are available from OpenOffice.org.
To create a new chapter or section of the ELUG documentation, use the DocBookTemplate, available from OpenOffice.org.
Table of Contents
Warning: This table of contents is out of date. Please refer to the EclipseLink JPA User's Guide for current documentation.
The following is the proposed TOC which is currently under development. Where applicable, show where existing ELUG wiki pages can be mined for initial content.
- Introduction
- JPA Development Basics
edit content from http://wiki.eclipse.org/Introduction_to_Java_Persistence_API_(ELUG)- Configuration
- JPA
- persistence.xml
edit content from http://wiki.eclipse.org/Using_EclipseLink_JPA_Extensions_(ELUG)#What_You_May_Need_to_Know_About_Using_EclipseLink_JPA_Persistence_Unit_Properties and http://wiki.eclipse.org/Packaging_and_Deploying_EclipseLink_JPA_Applications_(ELUG)#How_to_Specify_the_Persistence_Unit_Name - annotations
- orm.xml
edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_JPA_(ELUG)#Using_XML - defaults
edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_JPA_(ELUG)#Defaulting_Properties - eclipselink-orm.xml
edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_JPA_(ELUG)#Overriding_and_Merging_XML
- persistence.xml
- JPA
- Mapping
- Entity
edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_JPA_(ELUG)#Configuring_an_Entity- Id
edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_JPA_(ELUG)#.40Id
- Id
- Basic Mappings
edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_JPA_(ELUG)#Declaring_Basic_Property_Mappings- Column
- Default conversions & Converters
- Lazy Basics (default FetchGroup)
- Relationship Mappings
edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_JPA_(ELUG)#Mapping_Relationships- Common Relationship Config
- FetchType
- Collection Mappings
- Common Collection Config
- OneToMany
- ManyToMany
- Common Relationship Config
- Locking
- Optimistic Locking
- Entity
- Caching
edit content from http://wiki.eclipse.org/Using_EclipseLink_JPA_Extensions_(ELUG)#Using_EclipseLink_JPA_Extensions_for_Entity_Caching- Shared and Isolated
- Type & Size
- Expiration
- Coordination
edit content from http://wiki.eclipse.org and http://wiki.eclipse.org/Configuring_a_Coordinated_Cache_(ELUG)/Introduction_to_Cache_(ELUG)#When_to_Use_Cache_Coordination
- Querying
- Overview of approaches: JPQL, Criteria, Native
edit content from http://wiki.eclipse.org/Using_Basic_Query_API_(ELUG) and http://wiki.eclipse.org/Using_Advanced_Query_API_(ELUG)
- Overview of approaches: JPQL, Criteria, Native
- Transactions
edit content from http://wiki.eclipse.org/Introduction_to_Java_Persistence_API_(ELUG)#Transaction_Management and http://wiki.eclipse.org/Introduction_to_EclipseLink_Transactions_(ELUG)- Handling Concurrency Violations
- Configuration
- Advanced JPA
- Performance Tuning
edit content from http://wiki.eclipse.org/Optimizing_the_EclipseLink_Application_(ELUG)- Performance Profiling
edit content from http://wiki.eclipse.org/Optimizing_the_EclipseLink_Application_(ELUG)#Measuring_EclipseLink_Performance_with_the_EclipseLink_Profiler - Weaving (What is it and why do I care)
edit content from http://wiki.eclipse.org/Introduction_to_EclipseLink_Application_Development_(ELUG)#Using_Weaving and http://wiki.eclipse.org/Using_EclipseLink_JPA_Extensions_(ELUG)#Using_EclipseLink_JPA_Weaving- Understanding Weaving
- Weaving JPA Entities
- Weaving POJO Classes
- Weaving and Java EE Application Servers
- Configuring Dynamic Weaving
- Configuring Static Weaving
- Disabling Weaving with Persistence Unit Properties
- Understanding Weaving
- FetchGroups
edit content from http://wiki.eclipse.org/Developing_Applications_Using_EclipseLink_JPA_(ELUG)#How_to_Configure_Fetch_Groups
- Performance Profiling
- Platform Specific
edit content from http://wiki.eclipse.org/Developing_Applications_Using_EclipseLink_JPA_(ELUG)- Oracle
- DB2
- MySQL
- Dynamic
- Performance Tuning