EclipseLink Java Persistence API (JPA) Extensions Reference for EclipseLink Release 2.5 October 2013 EclipseLink Java Persistence API (JPA) Extensions Reference for EclipseLink Copyright © 2012, 2013 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: October 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-12 @BatchFetch.............................................................................................................................................. 2-14 @Cache....................................................................................................................................................... 2-16 @CacheIndex ............................................................................................................................................ 2-20 @CacheIndexes......................................................................................................................................... 2-22 @CacheInterceptor................................................................................................................................... 2-24 @CascadeOnDelete ................................................................................................................................. 2-26 @ChangeTracking.................................................................................................................................... 2-30 @ClassExtractor........................................................................................................................................ 2-32 @CloneCopyPolicy.................................................................................................................................. 2-34 @CompositeMember............................................................................................................................... 2-36 iii @ConversionValue .................................................................................................................................. 2-38 @Convert ................................................................................................................................................... 2-40 @Converter................................................................................................................................................ 2-42 @Converters.............................................................................................................................................. 2-44 @CopyPolicy............................................................................................................................................. 2-46 @Customizer............................................................................................................................................. 2-48 @DeleteAll ................................................................................................................................................ 2-50 @DiscriminatorClass............................................................................................................................... 2-52 @ExcludeDefaultMappings................................................................................................................... 2-54 @ExistenceChecking ............................................................................................................................... 2-56 @FetchAttribute ....................................................................................................................................... 2-58 @FetchGroup ............................................................................................................................................ 2-60 @FetchGroups .......................................................................................................................................... 2-62 @Field......................................................................................................................................................... 2-64 @HashPartitioning .................................................................................................................................. 2-66 @Index ....................................................................................................................................................... 2-68 @Indexes.................................................................................................................................................... 2-70 @InstantiationCopyPolicy ..................................................................................................................... 2-72 @JoinFetch................................................................................................................................................. 2-74 @JoinField................................................................................................................................................. 2-76 @JoinFields ............................................................................................................................................... 2-78 @MapKeyConvert ................................................................................................................................... 2-80 @Multitenant............................................................................................................................................ 2-82 Single-Table Multitenancy............................................................................................................... 2-84 Examples ..................................................................................................................................... 2-84 Table-Per-Tenanat Multitenancy .................................................................................................... 2-85 Examples ..................................................................................................................................... 2-85 VPD Multitenancy............................................................................................................................. 2-87 Examples ....................................................................................................................................