パッケージ org.springframework.data.jpa.repository

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

@RetentionSE(RUNTIMESE) @TargetSE({METHODSE,ANNOTATION_TYPESE}) @DocumentedSE public @interface Query
リポジトリクエリメソッドでファインダークエリを直接宣言するためのアノテーション。

ネイティブクエリを使用する場合、@NativeQuery バリアントを使用できます。

作成者:
Oliver Gierke, Thomas Darimont, Christoph Strobl, Greg Turnquist, Danny van den Elshout
関連事項:

  • オプション要素の概要

    オプション要素
    修飾子と型
    オプションの要素
    説明
    StringSE
    countName
    ページネーションが使用されているときにカウントクエリを実行するために使用される NamedQuery の名前を返します。
    StringSE
    countProjection
    ページネーション用に生成されるカウントクエリの射影部分を定義します。
    StringSE
    countQuery
    ページネーションクエリでページの要素の合計数を検索するために使用される特別なカウントクエリを定義します。
    StringSE
    name
    使用される名前付きクエリ。
    boolean
    nativeQuery
    指定されたクエリがネイティブクエリであるかどうかを構成します。
    ClassSE<? extends QueryRewriter>
    queryRewriter
    クエリが完全にアセンブルされた後にクエリ文字列に適用する必要がある QueryRewriter を定義します。
    StringSE
    value
    アノテーション付きメソッドが呼び出されたときに実行される JPA クエリを定義します。

  • 要素の詳細

    • value

      StringSE value
      アノテーション付きメソッドが呼び出されたときに実行される JPA クエリを定義します。
      デフォルト:
      ""

    • countQuery

      StringSE countQuery
      ページネーションクエリでページの要素の合計数を検索するために使用される特別なカウントクエリを定義します。何も構成されていない場合は、元のクエリまたは countProjection() クエリ (存在する場合) からカウントクエリが派生されます。
      デフォルト:
      ""

    • countProjection

      StringSE countProjection
      ページ区切り用に生成されるカウントクエリの射影部分を定義します。countQuery() も countProjection() も構成されていない場合は、元のクエリからカウントクエリが派生されます。
      戻り値:
      導入:
      1.6
      デフォルト:
      ""

    • nativeQuery

      boolean nativeQuery
      指定されたクエリがネイティブクエリであるかどうかを構成します。デフォルトは false です。
      デフォルト:
      false

    • name

      StringSE name
      使用する名前付きクエリ。定義されていない場合は、${domainClass}.${queryMethodName} という名前の NamedQuery が使用されます。
      デフォルト:
      ""

    • countName

      StringSE countName
      ページネーションが使用されているときにカウントクエリを実行するために使用される NamedQuery の名前を返します。デフォルトでは、.count がサフィックスとして設定された名前付きクエリ名になります。
      戻り値:
      関連事項:
      デフォルト:
      ""

    • queryRewriter

      ClassSE<? extends QueryRewriter> queryRewriter
      クエリが完全にアセンブルされた後にクエリ文字列に適用する必要がある QueryRewriter を定義します。
      戻り値:
      導入:
      3.0
      デフォルト:
      org.springframework.data.jpa.repository.QueryRewriter.IdentityQueryRewriter.class