@Target(value=TYPE) @Retention(value=RUNTIME) public @interface SecondaryTable
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 { ... }
Modifier and Type | Required Element and Description |
---|---|
String |
name
(Required) The name of the table.
|
Modifier and Type | Optional Element and Description |
---|---|
String |
catalog
(Optional) The catalog of the table.
|
ForeignKey |
foreignKey
(Optional) Used to specify or control the generation of a foreign key constraint for the columns
corresponding to the pkJoinColumns element when table generation is in effect.
|
Index[] |
indexes
(Optional) Indexes for the table.
|
PrimaryKeyJoinColumn[] |
pkJoinColumns
(Optional) The columns that are used to join with
the primary table.
|
String |
schema
(Optional) The schema of the table.
|
UniqueConstraint[] |
uniqueConstraints
(Optional) Unique constraints that are to be placed on the
table.
|
public abstract String name
public abstract String catalog
Defaults to the default catalog.
public abstract String schema
Defaults to the default schema for user.
public abstract PrimaryKeyJoinColumn[] pkJoinColumns
Defaults to the column(s) of the same name(s) as the primary key column(s) in the primary table.
public abstract UniqueConstraint[] uniqueConstraints
Column
and JoinColumn
annotations and constraints entailed by primary key mappings.
Defaults to no additional constraints.
public abstract Index[] indexes
public abstract ForeignKey foreignKey
Copyright © 2017 JBoss by Red Hat. All rights reserved.