此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Data Cassandra 4.4.0! |
特定于 Cassandra 的查询方法
本章介绍特定于 Cassandra 的查询方法。 本文档使用命令式类型。 通过使用反应式返回类型,相同的语义也适用于反应式存储库。 |
您通常在存储库上触发的大多数数据访问作都会导致对 Apache Cassandra 数据库执行查询。 定义这样的查询就是在 repository 接口上声明一个方法。 下面的示例显示了许多这样的方法声明:
-
Imperative
-
Reactive
interface PersonRepository extends CrudRepository<Person, String> {
List<Person> findByLastname(String lastname); (1)
Slice<Person> findByFirstname(String firstname, Pageable pageRequest); (2)
Window<Person> findByFirstname(String firstname, CassandraScrollPosition pos, Limit limit); (3)
List<Person> findByFirstname(String firstname, QueryOptions opts); (4)
List<Person> findByFirstname(String firstname, Sort sort); (5)
List<Person> findByFirstname(String firstname, Limit limit); (6)
Person findByShippingAddress(Address address); (7)
Person findFirstByShippingAddress(Address address); (8)
Stream<Person> findAllBy(); (9)
@AllowFiltering
List<Person> findAllByAge(int age); (10)
}
1 | 该方法显示具有给定lastname .
该查询是通过解析约束的方法名称得出的,约束可以与And .
因此,方法名称会生成SELECT * FROM person WHERE lastname = 'lastname' . |
2 | 将分页应用于查询。
您可以为方法签名配备Pageable 参数,并让该方法返回一个Slice 实例,并且我们会自动相应地对查询进行分页。 |
3 | 将滚动应用于查询。
滚动包装 Cassandra 的PagingState 到CassandraScrollPosition 并允许动态限制。
您还可以使用findTop… 对于静态限制。 |
4 | 传递QueryOptions Object 在执行查询之前将查询选项应用于结果查询。 |
5 | 将动态排序应用于查询。
您可以添加Sort 参数添加到您的方法签名中,并且 Spring Data 会自动将 Sequences 应用于查询。 |
6 | 将动态结果限制应用于查询。
可以使用SELECT … LIMIT . |
7 | 显示您可以使用Converter 注册的实例CustomConversions .
抛出IncorrectResultSizeDataAccessException 如果找到多个匹配项。 |
8 | 使用First keyword 将查询限制为仅第一个结果。
与前面的方法不同,如果找到多个匹配项,此方法不会引发异常。 |
9 | 使用 Java 8Stream 在迭代流时读取和转换单个元素。 |
10 | 显示带有@AllowFiltering 以允许服务器端筛选。 |
interface ReactivePersonRepository extends ReactiveSortingRepository<Person, Long> {
Flux<Person> findByFirstname(String firstname); (1)
Flux<Person> findByFirstname(Publisher<String> firstname); (2)
Mono<Person> findByFirstnameAndLastname(String firstname, String lastname); (3)
Mono<Person> findFirstByFirstname(String firstname); (4)
@AllowFiltering
Flux<Person> findByAge(int age); (5)
}
1 | 对具有给定firstname .
查询是通过解析约束的方法名称来派生的,约束可以与And 和Or .
因此,方法名称会生成SELECT * FROM person WHERE firstname = :firstname . |
2 | 对具有给定firstname 一旦firstname 从给定的Publisher . |
3 | 为给定条件查找单个实体。
完成IncorrectResultSizeDataAccessException 在非唯一结果上。 |
4 | 与前面的查询不同,即使查询生成更多结果行,也始终会发出第一个实体。 |
5 | 一个带有@AllowFiltering ,它允许服务器端筛选。 |
查询非主键属性需要二级索引。 |
下表显示了可在查询方法中使用的关键字的简短示例:
关键词 | 样本 | 逻辑结果 |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
仓库删除查询
上表中的关键字可以与delete…By
创建删除匹配文档的查询。
-
Imperative
-
Reactive
interface PersonRepository extends Repository<Person, String> {
void deleteWithoutResultByLastname(String lastname);
boolean deleteByLastname(String lastname);
}
interface PersonRepository extends Repository<Person, String> {
Mono<Void> deleteWithoutResultByLastname(String lastname);
Mono<Boolean> deleteByLastname(String lastname);
}
Delete 查询返回查询是否已应用,或者 terminate 而不返回值 usingvoid
.
查询选项
您可以通过传递QueryOptions
对象。
这些选项适用于实际查询执行之前的查询。QueryOptions
被视为非查询参数,不被视为查询参数值。
查询选项适用于派生和字符串@Query
repository 方法。
要静态设置一致性级别,请使用@Consistency
对 Query Methods 的注释。
每次执行查询时,都会将声明的一致性级别应用于查询。
以下示例将一致性级别设置为ConsistencyLevel.LOCAL_ONE
:
-
Imperative
-
Reactive
interface PersonRepository extends CrudRepository<Person, String> {
@Consistency(ConsistencyLevel.LOCAL_ONE)
List<Person> findByLastname(String lastname);
List<Person> findByFirstname(String firstname, QueryOptions options);
}
interface PersonRepository extends ReactiveCrudRepository<Person, String> {
@Consistency(ConsistencyLevel.LOCAL_ONE)
Flux<Person> findByLastname(String lastname);
Flux<Person> findByFirstname(String firstname, QueryOptions options);
}
DataStax Cassandra 文档包括对可用一致性级别的良好讨论。
您可以通过在 CQL API 实例上配置以下参数来控制获取大小、一致性级别和重试策略默认值:CqlTemplate ,AsyncCqlTemplate 和ReactiveCqlTemplate .
如果未设置特定查询选项,则默认值适用。 |