TableGenerator (javax.persistence-api 2.2 API)

@Repeatable(value=TableGenerators.class)
 @Target(value={TYPE,METHOD,FIELD})
 @Retention(value=RUNTIME)
public @interface TableGenerator

GeneratedValueアノテーションにgenerator要素が指定されたときに、名前で参照される主キージェネレーターを定義します。テーブルジェネレーターはエンティティクラスまたは主キーのフィールドまたはプロパティで指定できます。ジェネレーター名のスコープは、永続化ユニット(すべてのジェネレーターの型全体)に対してグローバルです。

    Example 1:
    
    @Entity public class Employee {
        ...
        @TableGenerator(
            name="empGen", 
            table="ID_GEN", 
            pkColumnName="GEN_KEY", 
            valueColumnName="GEN_VALUE", 
            pkColumnValue="EMP_ID", 
            allocationSize=1)
        @Id
        @GeneratedValue(strategy=TABLE, generator="empGen")
        int id;
        ...
    }
    
    Example 2:
    
    @Entity public class Address {
        ...
        @TableGenerator(
            name="addressGen", 
            table="ID_GEN", 
            pkColumnName="GEN_KEY", 
            valueColumnName="GEN_VALUE", 
            pkColumnValue="ADDR_ID")
        @Id
        @GeneratedValue(strategy=TABLE, generator="addressGen")
        int id;
        ...
    }

導入されたバージョン:: Java Persistence 1.0
関連項目:: GeneratedValue

必須要素のサマリー

必須要素
修飾子とタイプ	必須要素と説明
`java.lang.String`	`name` (必須) 1つ以上のクラスがID値のジェネレーターとして参照できるジェネレーターの一意な名前。

任意要素のサマリー

任意要素
修飾子とタイプ	任意要素と説明
`int`	`allocationSize` (オプション) ジェネレーターが生成した値からID番号を割り当てるときにインクリメントする量。
`java.lang.String`	`catalog` (オプション) テーブルの含まれるカタログ。
`Index[]`	`indexes` (オプション) テーブルのためのインデックス。
`int`	`initialValue` (オプション) 生成された最後の値を格納するカラムを初期化するために使用される初期値。
`java.lang.String`	`pkColumnName` (オプション) テーブル内の主キーのカラムの名前。
`java.lang.String`	`pkColumnValue` (オプション) 生成された値のセットをテーブルに格納されている可能性のある他のものと区別するジェネレーターテーブルの主キーの値。
`java.lang.String`	`schema` (オプション) テーブルの含まれるスキーマ。
`java.lang.String`	`table` (オプション) 生成されたID値を格納するテーブルの名前。
`UniqueConstraint[]`	`uniqueConstraints` (オプション) テーブルに配置される固有の制約。
`java.lang.String`	`valueColumnName` (オプション) 生成された最後の値を格納するカラムの名前。

- 要素の詳細
  - name
```
public abstract java.lang.String name
```
    (必須) 1つ以上のクラスがID値のジェネレーターとして参照できるジェネレーターの一意な名前。
- - table
```
public abstract java.lang.String table
```
    (オプション) 生成されたID値を格納するテーブルの名前。
    デフォルトでは永続化プロバイダによって指定された名前になります。
    
    デフォルト:
    
    ""
- - catalog
```
public abstract java.lang.String catalog
```
    (オプション) テーブルの含まれるカタログ。
    デフォルトでは既定のカタログです。
    
    デフォルト:
    
    ""
- - schema
```
public abstract java.lang.String schema
```
    (オプション) テーブルの含まれるスキーマ。
    デフォルトではユーザーにとっての規定のスキーマです。
    
    デフォルト:
    
    ""
- - pkColumnName
```
public abstract java.lang.String pkColumnName
```
    (オプション) テーブル内の主キーのカラムの名前。
    デフォルトでは永続化プロバイダによって選ばれます。
    
    デフォルト:
    
    ""
- - valueColumnName
```
public abstract java.lang.String valueColumnName
```
    (オプション) 生成された最後の値を格納するカラムの名前。
    デフォルトでは永続化プロバイダによって選ばれます。
    
    デフォルト:
    
    ""
- - pkColumnValue
```
public abstract java.lang.String pkColumnValue
```
    (オプション) 生成された値のセットをテーブルに格納されている可能性のある他のものと区別するジェネレーターテーブルの主キーの値。
    デフォルトでは永続化プロバイダによって選ばれた値がジェネレーターテーブルの主キーのカラムに格納されます
    
    デフォルト:
    
    ""
- - initialValue
```
public abstract int initialValue
```
    (オプション) 生成された最後の値を格納するカラムを初期化するために使用される初期値。
    
    デフォルト:
    
    0
- - allocationSize
```
public abstract int allocationSize
```
    (オプション) ジェネレーターが生成した値からID番号を割り当てるときにインクリメントする量。
    
    デフォルト:
    
    50
- - uniqueConstraints
```
public abstract UniqueConstraint[] uniqueConstraints
```
    (オプション) テーブルに配置される固有の制約。これらはテーブルの生成が有効な場合にのみ使用されます。これらの制約は主キーの制約とは別に適用されます。
    デフォルトでは追加の制約はありません。
    
    デフォルト:
    
    {}
- - indexes
```
public abstract Index[] indexes
```
    (オプション) テーブルのためのインデックス。これらはテーブルの生成が有効な場合にのみ使用されます。主キー索引は自動的に作成されるため、主キーの索引を指定する必要はないことに注意してください。
    
    導入されたバージョン:
    
    Java Persistence 2.1
    
    デフォルト:
    
    {}

注釈型 TableGenerator

必須要素のサマリー

任意要素のサマリー

要素の詳細

name

table

catalog

schema

pkColumnName

valueColumnName

pkColumnValue

initialValue

allocationSize

uniqueConstraints

indexes