此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring Data Cassandra 4.4.0！spring-doc.cn

特定于 Cassandra 的查询方法

本章介绍特定于 Cassandra 的查询方法。本文档使用命令式类型。通过使用反应式返回类型，相同的语义也适用于反应式存储库。

您通常在存储库上触发的大多数数据访问操作都会导致对 Apache Cassandra 数据库执行查询。定义这样的查询就是在 repository 接口上声明一个方法。下面的示例显示了许多这样的方法声明：spring-doc.cn

PersonRepository 与查询方法

Imperativespring-doc.cn
Reactivespring-doc.cn

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	该方法显示具有给定 . 该查询是通过解析约束的方法名称派生的，该约束可以与 . 因此，方法名称会导致查询表达式。`lastnameAndSELECT * FROM person WHERE lastname = 'lastname'`
2	将分页应用于查询。您可以为方法签名配备一个参数，并让该方法返回一个实例，然后我们会自动相应地对查询进行分页。`PageableSlice`
3	将滚动应用于查询。滚动将 Cassandra 的 Cookie 包装进来，并允许动态限制。您还可以用于静态限制。`PagingStateCassandraScrollPositionfindTop…`
4	传递对象会在执行之前将查询选项应用于结果查询。`QueryOptions`
5	将动态排序应用于查询。您可以将参数添加到方法签名中，Spring Data 会自动将 Sequences 应用于查询。`Sort`
6	将动态结果限制应用于查询。可以使用限制查询结果。`SELECT … LIMIT`
7	显示您可以使用中注册的实例基于非基元类型的属性进行查询。如果找到多个匹配项，则引发。`ConverterCustomConversionsIncorrectResultSizeDataAccessException`
8	使用关键字将查询限制为仅第一个结果。与前面的方法不同，如果找到多个匹配项，此方法不会引发异常。`First`
9	使用 Java 8 在迭代流时读取和转换单个元素。`Stream`
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	对具有给定 . 查询是通过解析约束的方法名称来派生的，约束可以与和连接。因此，方法名称会导致查询表达式。`firstnameAndOrSELECT * FROM person WHERE firstname = :firstname`
2	从给定发出后，对具有给定的所有人员的查询。`firstnamefirstnamePublisher`
3	为给定条件查找单个实体。完成 on non-unique 结果。`IncorrectResultSizeDataAccessException`
4	与前面的查询不同，即使查询生成更多结果行，也始终会发出第一个实体。
5	一种带有注释的查询方法，它允许服务器端筛选。`@AllowFiltering`

查询非主键属性需要二级索引。

下表显示了可在查询方法中使用的关键字的简短示例：spring-doc.cn

表 1.查询方法支持的关键字
关键词	样本	逻辑结果
`After`spring-doc.cn	`findByBirthdateAfter(Date date)`spring-doc.cn	`birthdate > date`spring-doc.cn
`GreaterThan`spring-doc.cn	`findByAgeGreaterThan(int age)`spring-doc.cn	`age > age`spring-doc.cn
`GreaterThanEqual`spring-doc.cn	`findByAgeGreaterThanEqual(int age)`spring-doc.cn	`age >= age`spring-doc.cn
`Before`spring-doc.cn	`findByBirthdateBefore(Date date)`spring-doc.cn	`birthdate < date`spring-doc.cn
`LessThan`spring-doc.cn	`findByAgeLessThan(int age)`spring-doc.cn	`age < age`spring-doc.cn
`LessThanEqual`spring-doc.cn	`findByAgeLessThanEqual(int age)`spring-doc.cn	`age ⇐ age`spring-doc.cn
`Between`spring-doc.cn	`findByAgeBetween(int from, int to)`和`findByAgeBetween(Range<Integer> range)`spring-doc.cn	`age > from AND age < to`和下限 / 上限（ / & / ）根据`>>=<⇐Range`spring-doc.cn
`In`spring-doc.cn	`findByAgeIn(Collection ages)`spring-doc.cn	`age IN (ages…)`spring-doc.cn
`Like`, ,`StartingWithEndingWith`spring-doc.cn	`findByFirstnameLike(String name)`spring-doc.cn	`firstname LIKE (name as like expression)`spring-doc.cn
`Containing`在字符串上spring-doc.cn	`findByFirstnameContaining(String name)`spring-doc.cn	`firstname LIKE (name as like expression)`spring-doc.cn
`Containing`在集合上spring-doc.cn	`findByAddressesContaining(Address address)`spring-doc.cn	`addresses CONTAINING address`spring-doc.cn
`(No keyword)`spring-doc.cn	`findByFirstname(String name)`spring-doc.cn	`firstname = name`spring-doc.cn
`IsTrue`,`True`spring-doc.cn	`findByActiveIsTrue()`spring-doc.cn	`active = true`spring-doc.cn
`IsFalse`,`False`spring-doc.cn	`findByActiveIsFalse()`spring-doc.cn	`active = false`spring-doc.cn

仓库删除查询

上表中的关键字可以结合使用，以创建删除匹配文档的查询。delete…Byspring-doc.cn

Imperativespring-doc.cn
Reactivespring-doc.cn

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 而不返回值 using .voidspring-doc.cn

查询选项

您可以通过传递对象来指定查询方法的查询选项。这些选项适用于实际查询执行之前的查询。被视为非查询参数，不被视为查询参数值。查询选项适用于派生存储库方法和字符串存储库方法。QueryOptionsQueryOptions@Queryspring-doc.cn

要静态设置一致性级别，请使用 query methods（对查询方法）的注释。每次执行查询时，都会将声明的一致性级别应用于查询。以下示例将一致性级别设置为：@ConsistencyConsistencyLevel.LOCAL_ONEspring-doc.cn

Imperativespring-doc.cn
Reactivespring-doc.cn

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 文档包括对可用一致性级别的良好讨论。spring-doc.cn

您可以通过在 CQL API 实例上配置以下参数来控制提取大小、一致性级别和重试策略默认值：、和。如果未设置特定查询选项，则默认值适用。CqlTemplateAsyncCqlTemplateReactiveCqlTemplate