Note: This ORM/SQL annotation is silently ignored by ObjectDB

369 words

javax.persistence.SecondaryTable - JPA annotation

javax.persistence
Annotation SecondaryTable

Target:
Classes
Specifies a secondary table for the annotated entity class. Specifying one or more secondary tables indicates that the data for the entity class is stored across multiple tables.

If no SecondaryTable annotation is specified, it is assumed that all persistent fields or properties of the entity are mapped to the primary table. If no primary key join columns are specified, the join columns are assumed to reference the primary key columns of the primary table, and have the same names and types as the referenced primary key columns of the primary table.

Example 1: Single secondary table with a single primary key column.

    @Entity
    @Table(name="CUSTOMER")
    @SecondaryTable(name="CUST_DETAIL", 
        pkJoinColumns=@PrimaryKeyJoinColumn(name="CUST_ID"))
    public class Customer { ... }

Example 2: Single secondary table with multiple primary key columns.

    @Entity
    @Table(name="CUSTOMER")
    @SecondaryTable(name="CUST_DETAIL",
        pkJoinColumns={
            @PrimaryKeyJoinColumn(name="CUST_ID"),
            @PrimaryKeyJoinColumn(name="CUST_TYPE")})
    public class Customer { ... }

Since:
JPA 1.0
String catalog
(Optional) The catalog of the table.
(Optional) The catalog of the table.

Defaults to the default catalog.

Default value:
""
Since:
JPA 1.0
String name
(Required) The name of the table.
(Required) The name of the table.
Since:
JPA 1.0
(Optional) The columns that are used to join with the primary table.
(Optional) The columns that are used to join with the primary table.

Defaults to the column(s) of the same name(s) as the primary key column(s) in the primary table.

Default value:
{}
Since:
JPA 1.0
String schema
(Optional) The schema of the table.
(Optional) The schema of the table.

Defaults to the default schema for user.

Default value:
""
Since:
JPA 1.0
(Optional) Unique constraints that are to be placed on the table.
(Optional) Unique constraints that are to be placed on the table. These are typically only used if table generation is in effect. These constraints apply in addition to any constraints specified by the Column and JoinColumn annotations and constraints entailed by primary key mappings.

Defaults to no additional constraints.

Default value:
{}
Since:
JPA 1.0

This documentation page is derived (with some adjustments) from the open source JPA 2 RI (EclipseLink)
and is available under the terms of the Eclipse Public License, v. 1.0 and Eclipse Distribution License, v. 1.0.
Object Relational Mapping (ORM) JPA 2 providers include Hibernate, EclipseLink, TopLink, OpenJPA and DataNucleus.
Object DB is not an ORM JPA implementation but an Object Database for Java with built in JPA 2 support.