javax.persistence

注釈型 SecondaryTable

@Repeatable(value=SecondaryTables.class)
 @Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface SecondaryTable

アノテーションの付いたエンティティクラスのセカンダリテーブルを指定します。 ひとつ以上のセカンダリテーブルを指定することでエンティティクラスのデータが複数のテーブルにまたがって保管されることを示します。

SecondaryTableが指定されてない場合は、エンティティのすべての永続化フィールドもしくはプロパティはプライマリテーブルにマップされるものとみなされます。 主キー結合カラムが指定されていない場合、結合カラムはプライマリテーブルの主キーのカラムを参照し、プライマリテーブルで参照された主キーのカラムと同じ名前と型を持つと見なされます。

    Example 1: 単一の主キーのカラムの単一のセカンダリテーブル

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


    Example 2: 複合主キーを使用した単一のセカンダリテーブル

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

導入されたバージョン:

Java Persistence 1.0

必須要素のサマリー

必須要素

修飾子とタイプ	必須要素と説明
java.lang.String	name (必須) テーブルの名前。

任意要素のサマリー

任意要素

修飾子とタイプ	任意要素と説明
java.lang.String	catalog (オプション) テーブルの含まれるカタログ。
ForeignKey	foreignKey (オプション) テーブルの生成が有効なときにpkJoinColumns要素に対応するカラムの外部キー制約の生成を指定または制御するために使用されます。
Index[]	indexes (オプション) テーブルのインデックス。
PrimaryKeyJoinColumn[]	pkJoinColumns (オプション) プライマリテーブルとの結合に使われるカラム。
java.lang.String	schema (オプション) テーブルの含まれるスキーマ。
UniqueConstraint[]	uniqueConstraints (オプション) テーブルに配置されるユニーク制約。

要素の詳細

name

public abstract java.lang.String name

(必須) テーブルの名前。

catalog

public abstract java.lang.String catalog

(オプション) テーブルの含まれるカタログ。

デフォルトでは既定のカタログです。

デフォルト:

""

schema

public abstract java.lang.String schema

(オプション) テーブルの含まれるスキーマ。

デフォルトではユーザーにとっての規定のスキーマです。

デフォルト:

""

pkJoinColumns

public abstract PrimaryKeyJoinColumn[] pkJoinColumns

(オプション) プライマリテーブルとの結合に使われるカラム。

デフォルトではプライマリテーブルの(複数単数問わず)主キーのカラムと同じ名前のカラムになります。

デフォルト:

{}

foreignKey

public abstract ForeignKey foreignKey

(オプション) テーブルの生成が有効なときにpkJoinColumns要素に対応するカラムの外部キー制約の生成を指定または制御するために使用されます。 この要素とpkJoinColumns要素のいずれかにおいてのforeignKey要素が同時に指定されている場合の動作は未定義です。 いずれの場所にも外部キーアノテーション要素が指定されていない場合、永続化プロバイダのデフォルトの外部キー方式が適用されるでしょう。

導入されたバージョン:

Java Persistence 2.1

デフォルト:

@javax.persistence.ForeignKey(javax.persistence.ConstraintMode.PROVIDER_DEFAULT)

uniqueConstraints

public abstract UniqueConstraint[] uniqueConstraints

(オプション) テーブルに配置されるユニーク制約。 これらは通常、テーブルの生成が有効な場合にのみ使用されます。 これらの制約は、ColumnおよびJoinColumn アノテーションで指定された制約および主のマッピングによって作られる制約とは別に適用されます。

デフォルトでは追加の制約はありません。

デフォルト:

{}

indexes

public abstract Index[] indexes

(オプション) テーブルのインデックス。 これらはテーブルの生成が有効な場合にのみ使用されます。

導入されたバージョン:

Java Persistence 2.1

デフォルト:

{}