仓库查询关键字

支持的查询方法主题关键字

下表列出了 Spring Data 仓库查询派生机制通常支持的用于表达谓词的主题关键字。请查阅特定存储的文档以获取受支持关键字的确切列表，因为此处列出的某些关键字可能在特定存储中不受支持。

表 1. 查询主题关键字
关键字	描述
`find…By`, `read…By`, `get…By`, `query…By`, `search…By`, `stream…By`	通用查询方法，通常返回仓库类型、`Collection` 或 `Streamable` 的子类型，或结果包装器，如 `Page`、`GeoResults` 或任何其他特定存储的结果包装器。可以用作 `findBy…`、`findMyDomainTypeBy…` 或与附加关键字组合使用。
`exists…By`	Exists 投影，通常返回 `boolean` 结果。
`count…By`	Count 投影，返回数值结果。
`delete…By`, `remove…By`	删除查询方法，返回无结果（`void`）或删除计数。
`…First<number>…`, `…Top<number>…`	将查询结果限制为前 `<number>` 个结果。此关键字可以出现在主题中 `find`（以及其他关键字）和 `by` 之间的任何位置。
`…Distinct…`	使用 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`, (或无关键字)
`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`）。