存储库查询关键字

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

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

表 1. 查询主题关键字
关键字 描述

find…By, read…By, get…By, query…By, search…By, stream…By

一般查询方法,通常返回存储库类型、CollectionStreamable 子类型,或结果包装器,例如 PageGeoResults 或任何其他特定于存储的结果包装器。可以用作 findBy…findMyDomainTypeBy… 或与其他关键字结合使用。

exists…By

存在投影,通常返回 boolean 结果。

count…By

计数投影,返回数值结果。

delete…By, remove…By

删除查询方法,不返回结果 (void) 或返回删除计数。

…First<number>…, …Top<number>…

将查询结果限制为前 <number> 个结果。此关键字可以出现在 find(和其他关键字)和 by 之间的主题的任何位置。

…Distinct…

使用 distinct 查询仅返回唯一结果。请查阅特定存储的文档,了解该功能是否受支持。此关键字可以出现在 find(和其他关键字)和 by 之间的主题的任何位置。

支持的查询方法谓词关键字和修饰符

下表列出了 Spring Data 存储库查询推导机制通常支持的谓词关键字。但是,请查阅特定存储的文档以获取支持关键字的精确列表,因为此处列出的某些关键字可能在特定存储中不受支持。

表 2. 查询谓词关键字
逻辑关键字 关键字表达式

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

除了过滤器谓词之外,还支持以下修饰符列表

表 3. 查询谓词修饰符关键字
关键字 描述

IgnoreCase, IgnoringCase

与谓词关键字一起使用,用于不区分大小写的比较。

AllIgnoreCase, AllIgnoringCase

忽略所有合适属性的大小写。在查询方法谓词中的某个地方使用。

OrderBy…

指定一个静态排序顺序,后跟属性路径和方向(例如 OrderByFirstnameAscLastnameDesc)。