javax.persistence
Annotation Type SecondaryTable


@Target(value=TYPE)
@Retention(value=RUNTIME)
public @interface SecondaryTable

The SecondaryTable annotation is used to specify 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.

Since:
EJB 3.0 version.
Author:
Florent Benoit
See Also:
EJB 3.0 specification

Required Element Summary
 java.lang.String name
          (Required) The name of the table.
 
Optional Element Summary
 java.lang.String catalog
          (Optional) The catalog of the table.
 PrimaryKeyJoinColumn[] pkJoinColumns
          (Optional) The columns that are used to join with the primary table.
 java.lang.String schema
          (Optional) The schema of the table.
 UniqueConstraint[] uniqueConstraints
          (Optional) Unique constraints that are to be placed on the table.
 

Element Detail

name

public abstract java.lang.String name
(Required) The name of the table.

catalog

public abstract java.lang.String catalog
(Optional) The catalog of the table.

Default:
""

schema

public abstract java.lang.String schema
(Optional) The schema of the table.

Default:
""

pkJoinColumns

public abstract PrimaryKeyJoinColumn[] pkJoinColumns
(Optional) The columns that are used to join with the primary table.

Default:
{}

uniqueConstraints

public abstract UniqueConstraint[] uniqueConstraints
(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 Join- Column annotations and constraints entailed by primary key mappings.

Default:
{}