EclipseLink Java Persistence API (JPA) Extensions Reference for EclipseLink Release 2.6 June 2014 EclipseLink Java Persistence API (JPA) Extensions Reference for EclipseLink Copyright © 2014 by The Eclipse Foundation under the Eclipse Public License (EPL) http://www.eclipse.org/org/documents/epl-v10.php The initial contribution of this content was based on work copyrighted by Oracle and was submitted with permission. Print date: June 10, 2014 Contents Preface ................................................................................................................................................................. xi Audience....................................................................................................................................................... xi Related Documents ..................................................................................................................................... xi Conventions ................................................................................................................................................. xi 1 Introduction About EclipseLink...................................................................................................................................... 1-1 About This Documentation...................................................................................................................... 1-2 Other Resources ....................................................................................................................................1-2 2 Annotation Extensions Reference Functional Listing of Annotation Extensions....................................................................................... 2-1 Mapping Annotations .........................................................................................................................2-1 Entity Annotations ...............................................................................................................................2-2 Converter Annotations ........................................................................................................................2-2 Caching Annotations ...........................................................................................................................2-2 Customization and Optimization Annotations ...............................................................................2-2 Copy Policy Annotations ....................................................................................................................2-3 Returning Policy Annotations ............................................................................................................2-3 Stored Procedure and Function Annotations ..................................................................................2-3 Partitioning Annotations .....................................................................................................................2-3 Non-relational (NoSQL) Annotations ...............................................................................................2-4 Alphabetical Listing of Annotation Extensions................................................................................... 2-4 @AdditionalCriteria................................................................................................................................... 2-8 @Array ....................................................................................................................................................... 2-11 @BatchFetch.............................................................................................................................................. 2-13 @Cache....................................................................................................................................................... 2-15 @CacheIndex ............................................................................................................................................ 2-19 @CacheIndexes......................................................................................................................................... 2-21 @CacheInterceptor................................................................................................................................... 2-22 @CascadeOnDelete ................................................................................................................................. 2-24 @ChangeTracking.................................................................................................................................... 2-27 @ClassExtractor........................................................................................................................................ 2-29 @CloneCopyPolicy.................................................................................................................................. 2-31 @CompositeMember............................................................................................................................... 2-33 iii @ConversionValue .................................................................................................................................. 2-35 @Convert ................................................................................................................................................... 2-37 @Converter................................................................................................................................................ 2-39 @Converters.............................................................................................................................................. 2-41 @CopyPolicy............................................................................................................................................. 2-42 @Customizer............................................................................................................................................. 2-43 @DeleteAll ................................................................................................................................................ 2-45 @DiscriminatorClass............................................................................................................................... 2-47 @ExcludeDefaultMappings................................................................................................................... 2-48 @ExistenceChecking ............................................................................................................................... 2-49 @FetchAttribute ....................................................................................................................................... 2-51 @FetchGroup ............................................................................................................................................ 2-53 @FetchGroups .......................................................................................................................................... 2-55 @Field......................................................................................................................................................... 2-56 @HashPartitioning .................................................................................................................................. 2-57 @Index ....................................................................................................................................................... 2-59 @Indexes.................................................................................................................................................... 2-61 @InstantiationCopyPolicy ..................................................................................................................... 2-62 @JoinFetch................................................................................................................................................. 2-64 @JoinField................................................................................................................................................. 2-66 @JoinFields ............................................................................................................................................... 2-67 @MapKeyConvert ................................................................................................................................... 2-68 @Multitenant............................................................................................................................................ 2-70 Single-Table Multitenancy............................................................................................................... 2-72 Examples ..................................................................................................................................... 2-72 Table-Per-Tenanat Multitenancy .................................................................................................... 2-73 Examples ..................................................................................................................................... 2-73 VPD Multitenancy............................................................................................................................. 2-75 Examples ....................................................................................................................................