パッケージ jakarta.persistence

アノテーションインターフェース TableGenerator

@RepeatableSE(TableGenerators.class) @TargetSE({TYPESE,METHODSE,FIELDSE,PACKAGESE}) @RetentionSE(RUNTIMESE) public @interface TableGenerator
GeneratedValue アノテーションにジェネレーター要素が指定されている場合に名前で参照できる主キージェネレーターを定義します。テーブルジェネレーターは、エンティティクラスまたは主キーフィールドまたはプロパティで指定できます。ジェネレーター名のスコープは、永続性ユニットに対してグローバルです（すべてのジェネレーター型にわたって）。

名前が明示的に指定されておらず、アノテーションがエンティティクラスまたはエンティティクラスの主キー属性に存在する場合、名前はデフォルトでエンティティの名前になります。

名前が明示的に指定されておらず、アノテーションがパッケージ記述子に存在する場合、アノテーションが付けられたパッケージ内のプログラム要素の GeneratedValue アノテーションに strategy=TABLE とデフォルトのジェネレーター名がある場合、そのアノテーションはデフォルトのジェネレーターを生成するためのレシピを定義します。このデフォルトのジェネレーターの名前はデフォルトのジェネレーター名であり、その他のプロパティはパッケージ TableGenerator アノテーションのメンバーによって決定されます。

例 1:

例 2:

導入:
1.0
関連事項:

  • オプション要素の概要

    オプション要素
    修飾子と型
    オプションの要素
    説明
    int
    allocationSize
    （オプション）ジェネレーターから ID 番号を割り当てるときにインクリメントする量。
    StringSE
    catalog
    （オプション）テーブルのカタログ。
    Index[]
    indexes
    （オプション）テーブルのインデックス。
    int
    initialValue
    （オプション）最後に生成された値を格納する列を初期化するために使用される初期値。
    StringSE
    name
    (オプション) ID 値のジェネレーターとして 1 つ以上のクラスから参照できる一意のジェネレーター名。
    StringSE
    options
    (オプション) このテーブルを作成する生成された DDL ステートメントに追加される SQL フラグメント。
    StringSE
    pkColumnName
    （オプション）テーブルの主キー列の名前。
    StringSE
    pkColumnValue
    （オプション）この生成された値のセットを、テーブルに格納される可能性のある他の値と区別する、ジェネレーターテーブルの主キー値。
    StringSE
    schema
    （オプション）テーブルのスキーマ。
    StringSE
    table
    (オプション) 生成された ID 値を保管するテーブルの名前。
    UniqueConstraint[]
    uniqueConstraints
    （オプション）テーブルに配置される一意の制約。
    StringSE
    valueColumnName
    （オプション）最後に生成された値を格納する列の名前。

  • 要素の詳細

    • name

      StringSE name
      (オプション) ID 値のジェネレーターとして 1 つ以上のクラスから参照できる一意のジェネレーター名。

      アノテーションがエンティティクラスまたは主キー属性に発生する場合、デフォルトはエンティティの名前になります。

      デフォルト:
      ""

    • table

      StringSE table
      (オプション) 生成された ID 値を保管するテーブルの名前。

      デフォルトは、永続性プロバイダーによって選択された名前です。

      デフォルト:
      ""

    • catalog

      StringSE catalog
      （オプション）テーブルのカタログ。

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

      デフォルト:
      ""

    • schema

      StringSE schema
      （オプション）テーブルのスキーマ。

      デフォルトはユーザーのデフォルトスキーマです。

      デフォルト:
      ""

    • pkColumnName

      StringSE pkColumnName
      （オプション）テーブルの主キー列の名前。

      デフォルトはプロバイダーが選択した名前です。

      デフォルト:
      ""

    • valueColumnName

      StringSE valueColumnName
      （オプション）最後に生成された値を格納する列の名前。

      デフォルトはプロバイダーが選択した名前です。

      デフォルト:
      ""

    • pkColumnValue

      StringSE pkColumnValue
      （オプション）この生成された値のセットを、テーブルに格納される可能性のある他の値と区別する、ジェネレーターテーブルの主キー値。

      デフォルトは、ジェネレーターテーブルの主キー列に格納するプロバイダーが選択した値です。

      デフォルト:
      ""

    • initialValue

      int initialValue
      （オプション）最後に生成された値を格納する列を初期化するために使用される初期値。
      デフォルト:
      0

    • allocationSize

      int allocationSize
      （オプション）ジェネレーターから ID 番号を割り当てるときにインクリメントする量。
      デフォルト:
      50

    • uniqueConstraints

      UniqueConstraint[] uniqueConstraints
      （オプション）テーブルに配置される一意の制約。これらは、テーブル生成が有効な場合にのみ使用されます。これらの制約は、主キーの制約に加えて適用されます。

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

      デフォルト:
      {}

    • indexes

      Index[] indexes
      (オプション) テーブルのインデックス。これらは、テーブル生成が有効な場合にのみ使用されます。主キーのインデックスは自動的に作成されるため、主キーのインデックスを指定する必要はないことに注意してください。
      導入:
      2.1
      デフォルト:
      {}

    • options

      StringSE options
      (オプション) このテーブルを作成する生成された DDL ステートメントに追加される SQL フラグメント。
      導入:
      3.2
      デフォルト:
      ""