リポジトリクエリキーワード

サポートされているクエリメソッドの件名キーワード

次の表に、述語を表現するために Spring Data リポジトリのクエリ導出メカニズムで一般的にサポートされているサブジェクトキーワードを示します。ここにリストされている一部のキーワードは特定のストアでサポートされていない可能性があるため、サポートされているキーワードの正確なリストについては、ストア固有のドキュメントを参照してください。

表 1: 件名のキーワードを照会する
キーワード	説明
`find…By`, `read…By`, `get…By`, `query…By`, `search…By`, `stream…By`	通常、リポジトリ型、`Collection` または `Streamable` サブ型、`Page`、`GeoResults` などの結果ラッパーまたはその他のストア固有の結果ラッパーを返す一般的なクエリメソッド。`findBy …`、`findMyDomainTypeBy …` として、または追加のキーワードと組み合わせて使用できます。
`exists…By`	射影が存在し、通常は `boolean` の結果を返します。
`count…By`	数値結果を返す射影をカウントします。
`delete…By`, `remove…By`	結果なし（`void`）または削除カウントのいずれかを返すクエリメソッドを削除します。
`…First<number>…`, `…Top<number>…`	クエリ結果を結果の最初の `<number>` に制限します。このキーワードは、`find` （および他のキーワード）と `by` の間の件名の任意の場所で使用できます。
`…Distinct…`	一意のクエリを使用して、一意の結果のみを返します。その機能がサポートされているかどうかは、ストア固有のドキュメントを参照してください。このキーワードは、`find` （および他のキーワード）と `by` の間の件名の任意の場所で使用できます。

予約メソッド

次の表は、事前定義された機能 ( CrudRepository で定義) を使用する予約済みメソッドの一覧です。これらのメソッドは、リポジトリプロキシのバッキング (ストア固有) 実装で直接呼び出されます。"クエリメソッドの定義" も参照してください。

表 2: 予約メソッド
`deleteAllById(Iterable<ID> identifiers)`
`deleteById(ID identifier)`
`existsById(ID identifier)`
`findAllById(Iterable<ID> identifiers)`
`findById(ID identifier)`

サポートされているクエリメソッドの述語キーワードと修飾子

次の表に、Spring Data リポジトリクエリ派生メカニズムで一般的にサポートされている述語キーワードを示します。ただし、ここにリストされている一部のキーワードは特定のストアでサポートされていない可能性があるため、サポートされているキーワードの正確なリストについては、ストア固有のドキュメントを参照してください。

表 3: 述語キーワードのクエリ
論理キーワード	キーワード表現
`AND`	`And`
`OR`	`Or`
`AFTER`	`After`, `IsAfter`
`BEFORE`	`Before`, `IsBefore`
`CONTAINING`	`Containing`, `IsContaining`, `Contains`
`BETWEEN`	`Between`, `IsBetween`
`ENDING_WITH`	`EndingWith`, `IsEndingWith`, `EndsWith`
`EXISTS`	`Exists`
`FALSE`	`False`, `IsFalse`
`GREATER_THAN`	`GreaterThan`, `IsGreaterThan`
`GREATER_THAN_EQUALS`	`GreaterThanEqual`, `IsGreaterThanEqual`
`IN`	`In`, `IsIn`
`IS`	`Is`, `Equals`, (or no keyword)
`IS_EMPTY`	`IsEmpty`, `Empty`
`IS_NOT_EMPTY`	`IsNotEmpty`, `NotEmpty`
`IS_NOT_NULL`	`NotNull`, `IsNotNull`
`IS_NULL`	`Null`, `IsNull`
`LESS_THAN`	`LessThan`, `IsLessThan`
`LESS_THAN_EQUAL`	`LessThanEqual`, `IsLessThanEqual`
`LIKE`	`Like`, `IsLike`
`NEAR`	`Near`, `IsNear`
`NOT`	`Not`, `IsNot`
`NOT_IN`	`NotIn`, `IsNotIn`
`NOT_LIKE`	`NotLike`, `IsNotLike`
`REGEX`	`Regex`, `MatchesRegex`, `Matches`
`STARTING_WITH`	`StartingWith`, `IsStartingWith`, `StartsWith`
`TRUE`	`True`, `IsTrue`
`WITHIN`	`Within`, `IsWithin`

フィルター述語に加えて、次の修飾子のリストがサポートされています。

表 4: 述語修飾子キーワードのクエリ
キーワード	説明
`IgnoreCase`, `IgnoringCase`	大文字と小文字を区別しない比較のために、述語キーワードとともに使用されます。
`AllIgnoreCase`, `AllIgnoringCase`	すべての適切なプロパティの大文字と小文字を区別しません。クエリメソッド述語のどこかで使用されます。
`OrderBy…`	静的な並べ替え順序を指定し、その後にプロパティのパスと方向を指定します（例: `OrderByFirstnameAscLastnameDesc`）。