パッケージ jakarta.persistence
パッケージ jakarta.persistence
Jakarta Persistence は、永続性およびオブジェクト / リレーショナルマッピングの管理用の API です。
- クラス説明エンティティクラス、マッピングされたスーパークラス、埋め込み可能なクラス、そのようなクラスの特定の属性に適用されるアクセス型を指定するために使用されます。
Access
アノテーションとともに使用して、エンティティクラス、マップされたスーパークラス、埋め込み可能なクラス、そのようなクラスの特定の属性に適用するアクセス型を指定します。エンティティ関連のマッピングをオーバーライドするために使用されます。複数の関連プロパティまたはフィールドのマッピングをオーバーライドするために使用されます。AttributeConverter<X,Y> カスタム属性コンバーターによって実装されるインターフェース。エンティティグラフの属性ノードを表します。Basic
(明示的またはデフォルト)プロパティまたはフィールド、またはId
プロパティまたはフィールドのマッピングをオーバーライドするために使用されます。複数のプロパティまたはフィールドのマッピングをオーバーライドするために使用されます。永続フィールドまたはプロパティを単一のデータベース列にマッピングする最も単純な型。2 次キャッシュと対話するために使用されるインターフェース。エンティティをキャッシュするかどうか、キャッシュが有効であるかどうか、persistence.xml
キャッシュ要素の値がSharedCacheMode.ENABLE_SELECTIVE
またはSharedCacheMode.DISABLE_SELECTIVE
である場合を指定します。EntityManager.find(java.lang.Class<T>, java.lang.Object)
メソッドおよびクエリの実行を介してデータベースからデータを読み取るときに、EntityManager
が 2 次キャッシュと対話する方法を指定します。データベースからデータを読み取るとき、およびデータベースにデータを書き込むときに、EntityManager
が 2 次キャッシュと対話する方法を指定します。関連付けられたエンティティに伝播される一連のカスケード可能な操作を定義します。スキーマ生成が有効なときに、列またはテーブルに SQL チェック制約を指定するために使用されます。基本型または埋め込み型のコレクションのマッピングに使用されるテーブルを指定します。アノテーション付きの永続プロパティまたはフィールドによってマップされる列を指定します。SqlResultSetMapping
、NamedNativeQuery
、またはConstructorResult
アノテーションと組み合わせて使用され、SQL クエリの SELECT リストの列をマップします。ネイティブデータベース接続を利用する実行可能なアクション。ConnectionFunction<C,T> ネイティブデータベース接続を利用して結果を計算する関数。制約の適用を制御するために使用されます。SqlResultSetMapping
またはNamedNativeQuery
アノテーションと組み合わせて使用され、SQL クエリの SELECT 句をコンストラクターにマップします。フィールドまたはプロパティの値を基本型に変換する方法を指定します。これにより、autoApply=false
で定義されたコンバーターの有効化、autoApply=true
で定義されたコンバーターの使用のオーバーライド、または埋め込み型または継承されたフィールドまたはプロパティで指定されたコンバーターの使用のオーバーライドが行われます。マッピングされたスーパークラス。アノテーションが付けられたクラスがコンバーターであることを宣言し、コンバーターが自動的に適用されるかどうかを指定します。Convert
アノテーションをグループ化するために使用されます。識別列のサポートされている型を定義します。アノテーション付きエンティティ型の識別子列の値を指定します。基本型または埋め込み可能なクラスのインスタンスのコレクションを宣言します。エンティティの ID を共有し、所有するエンティティの組み込み部分としてインスタンスが格納される型を宣言します。値が埋め込み可能クラスのインスタンスであるエンティティの永続フィールドまたはプロパティを宣言します。エンティティクラスまたはマップされたスーパークラスのアノテーション付き永続フィールドまたはプロパティがエンティティの複合主キーであることを指定します。アノテーションが付けられたクラスがエンティティであることを宣言します。EntityManager.persist(Object)
が呼び出され、エンティティがすでに存在する場合、永続化プロバイダーによってスローされます。EntityGraph<T>この型は、エンティティおよびエンティティの関連のグラフの属性ノードと境界を定義するためのテンプレートとして使用されるエンティティグラフのルートを表します。エンティティまたはマップされたスーパークラスに使用されるコールバックリスナークラスを指定します。永続コンテキストと対話するために使用されるインターフェース。永続化ユニットと対話し、EntityManager
の新しいインスタンスを作成するために使用されるインターフェース。EntityManager.getReference
によって取得されたエンティティ参照にアクセスしたが、エンティティが存在しない場合に、永続性プロバイダーによってスローされます。SqlResultSetMapping
またはNamedNativeQuery
アノテーションと組み合わせて使用され、SQL クエリの SELECT 句をエンティティ結果にマップします。リソースローカルエンティティマネージャーでトランザクションを制御するために使用されるインターフェース。永続的なプロパティまたはフィールドを列挙型として永続化する必要があることを指定します。Javaenum
型のアノテーション付きフィールドが列挙マッピングのデータベース列値のソースであることを指定します。列挙型のマッピングに使用できるオプションを列挙します。エンティティクラス(またはマッピングされたスーパークラス)とそのサブクラスのデフォルトリスナーの呼び出しを除外することを指定します。エンティティクラス(またはマップされたスーパークラス)とそのサブクラスのスーパークラスリスナーの呼び出しを除外することを指定します。データベースからデータを取得するための戦略を定義します。SQL クエリの SELECT リストで指定された列をエンティティクラスのプロパティまたはフィールドにマッピングするために、EntityResult
アノテーションと組み合わせて使用されます。EntityManager.find(java.lang.Class<T>, java.lang.Object)
の動作に影響を与えるオプション。EntityManager
によって認識されるフラッシュモードを列挙します。スキーマ生成が有効な場合の外部キー制約の処理を指定します。生成される主キーの生成戦略を指定します。定義された主キー生成戦略を列挙します。Graph<T>EntityGraph
とSubgraph
に共通の操作を宣言します。エンティティの主キーを識別します。フィールドまたはプロパティがアノテーション付きエンティティクラスの識別子フィールドまたはプロパティにマップされる複合主キー型を指定します。スキーマ生成で使用され、インデックスの作成を指定します。アノテーション付きエンティティクラスから派生するエンティティクラス階層の継承マッピング戦略を指定します。エンティティ継承をマッピングするためのオプションを列挙しました。エンティティの関連付けまたは要素コレクションに参加するための列を指定します。複合外部キーのマッピングを指定します。中間結合テーブルへの関連付けのマッピングを指定します。アノテーション付きの永続プロパティまたはフィールドをラージオブジェクトとしてデータベースネイティブのラージオブジェクト (LOB) 型に永続化する必要があることを指定します。エンティティインスタンスで取得できる楽観的ロックまたは悲観的ロックの種類を列挙します。トランザクションのロールバックに至らない悲観的なロックの競合が発生した場合に、永続化プロバイダーによってスローされます。多対多の多重度を持つ多値の関連付けを指定し、結合テーブルと呼ばれる中間テーブルにマッピングします。多対 1 の多重度を持つ別のエンティティクラスへの単一値の関連付けを指定します。マップキー自体がプライマリキーであるか、マップの値であるエンティティの永続フィールドまたはプロパティである場合、型Map
SE の関連付けのマップキーを指定します。型Map
SE の関連付けのマップキーの型を指定します。マップキーが基本型であるマップのキー列のマッピングを指定します。基本型が列挙型であるマップキーの列挙型を指定します。マップキーであるエンティティへのマッピングを指定します。エンティティを参照する複合マップキーをサポートします。使用すべきではありません。それ自体はエンティティではないが、そのマッピングがそれを継承するエンティティによって継承されるクラスを宣言します。NamedAttributeNode
はNamedEntityGraph
のメンバー要素です。名前付きエンティティグラフを定義します。NamedEntityGraph
アノテーションをグループ化するために使用されます。複数のネイティブ SQL 名前付きクエリを宣言します。名前付きネイティブ SQL クエリと、オプションでネイティブ SQL クエリの結果のマッピングを宣言します。複数の名前付き Jakarta Persistence クエリ言語クエリを宣言します。Jakarta Persistence クエリ言語で記述された名前付きクエリを宣言します。複数の名前付きストアドプロシージャクエリを指定します。ストアドプロシージャ、そのパラメーター、その結果の型を宣言し、名前を付けます。NamedSubgraph
はNamedEntityGraph
のメンバー要素です。Query.getSingleResult()
またはTypedQuery.getSingleResult()
が実行され、クエリの結果が複数ある場合に、永続化プロバイダーによってスローされます。Query.getSingleResult()
またはTypedQuery.getSingleResult()
が実行され、返される結果がない場合に永続プロバイダーによってスローされます。1 対多の多重度を持つ多値の関連付けを指定します。1 対 1 の多重度を持つ別のエンティティクラスへの単一値の関連付けを指定します。楽観的なロックの競合が発生したときに永続化プロバイダーによってスローされます。関連またはコレクションが取得される時点での、コレクション値の関連または要素コレクションの要素の順序を指定します。リストの永続的な順序を維持するために使用される列を指定します。Parameter<T>クエリパラメーターオブジェクトの型。ストアドプロシージャクエリのパラメーターのモードを指定します。Java SE 環境でEntityManagerFactory
を取得するために使用されるブートストラップクラス。永続化ユニットの構成を表し、プログラムによるEntityManagerFactory
の作成を可能にします。コンテナー管理のEntityManager
とそれに関連する永続コンテキストへの依存関係を表します。1 つ以上のPersistenceContext
アノテーションを宣言します。PersistenceContext
でトランザクションスコープまたは拡張永続コンテキストのどちらを使用するかを指定します。問題が発生したときに永続化プロバイダーによってスローされます。単一のコンテナーまたは永続プロバイダーのプロパティを説明します。EntityManagerFactory
とそれに関連する永続性ユニットへの依存関係を表します。1 つ以上のPersistenceUnit
アノテーションを宣言します。Jakarta Persistence でのトランザクション管理に対して可能なアプローチを列挙します。永続性ユニットを管理するアプリケーションと永続性プロバイダー間のユーティリティインターフェース。アプリケーションと永続性プロバイダー間のユーティリティインターフェース。悲観的なロックの競合が発生した場合に、永続化プロバイダーによってスローされます。悲観的ロックのjakarta.persistence.lock.scope
プロパティの値を定義します。対応するライフサイクルイベントのコールバックメソッドを指定します。対応するライフサイクルイベントのコールバックメソッドを指定します。対応するライフサイクルイベントのコールバックメソッドを指定します。対応するライフサイクルイベントのコールバックメソッドを指定します。対応するライフサイクルイベントのコールバックメソッドを指定します。対応するライフサイクルイベントのコールバックメソッドを指定します。対応するライフサイクルイベントのコールバックメソッドを指定します。別のテーブルに結合するための外部キーとして使用される主キー列を指定します。PrimaryKeyJoinColumn
アノテーションをグループ化します。クエリの実行を制御するために使用されるインターフェース。NamedQuery
またはNamedNativeQuery
アノテーションにクエリプロパティまたはヒントを提供するために使用されます。クエリがタイムアウトし、ステートメントのみがロールバックされたときに永続化プロバイダーによってスローされます。EntityManager.refresh(java.lang.Object)
の動作に影響を与えるオプション。EntityTransaction.commit()
が失敗したときに永続化プロバイダーによってスローされます。schema validation
が失敗した場合にスローされます。アノテーション付きエンティティクラスのセカンダリテーブルを指定します。エンティティに複数のセカンダリテーブルを指定します。GeneratedValue
アノテーションにジェネレーター要素が指定されている場合に、名前で参照できる主キージェネレーターを定義します。SequenceGenerator
アノテーションをグループ化するために使用されます。プロバイダーが永続性ユニットに 2 次キャッシュを使用する方法を指定します。ネイティブ SQL クエリまたはストアドプロシージャの結果セットの列のマッピングを指定します。1 つ以上のSqlResultSetMapping
アノテーションを定義するために使用されます。名前付きストアドプロシージャクエリのパラメーターを宣言します。ストアドプロシージャクエリの実行を制御するために使用されるインターフェース。Subgraph<T>この型は、マネージド型に対応する属性ノードのサブグラフを表します。永続コンテキストを常に現在のトランザクションと自動的に同期させるか、EntityManager.joinTransaction()
メソッドを使用して永続コンテキストを現在のトランザクションに明示的に結合する必要があるかを指定します。アノテーション付きエンティティ型によってマップされるプライマリテーブルを指定します。GeneratedValue
アノテーションにジェネレーター要素が指定されている場合に、名前で参照できる主キージェネレーターを定義します。TableGenerator
アノテーションをグループ化するために使用されます。使用すべきではありません。新しく作成したコードでは、java.time
SE で定義された日付 / 時刻型を使用する必要があります。使用すべきではありません。新しく作成したコードでは、java.time
SE で定義された日付 / 時刻型を使用する必要があります。データベースリクエストのタイムアウトを指定します。トランザクションが必要であるがアクティブではないときに永続性プロバイダーによってスローされます。アノテーション付きのプロパティまたはフィールドが永続的ではないことを指定します。クエリ結果タプルの要素を抽出するためのインターフェース。TupleElement<X>TupleElement
インターフェースは、クエリ結果タプルで返される要素を定義します。TypedQuery<X>型付きクエリの実行を制御するために使用されるインターフェース。NamedQuery
またはNamedNativeQuery
アノテーションを介して宣言された名前付きクエリへの参照。プライマリテーブルまたはセカンダリテーブルの生成された DDL に一意の制約を含めることを指定します。プロバイダーが永続性ユニットに使用する検証モード。エンティティクラスのバージョンフィールドまたはプロパティを宣言します。これは、楽観的ロックの失敗を検出し、楽観的トランザクションの整合性を確保するために使用されます。
java.time
SE で定義された日付 / 時刻型を使用する必要があります。