Migration Guide from 1.x to 2.x

Spring Data for Apache Cassandra 2.0 introduces a set of breaking changes when upgrading from earlier versions:spring-doc.cn

  • Merged the spring-cql and spring-data-cassandra modules into a single module.spring-doc.cn

  • Separated asynchronous and synchronous operations in CqlOperations and CassandraOperations into dedicated interfaces and templates.spring-doc.cn

  • Revised the CqlTemplate API to align with JdbcTemplate.spring-doc.cn

  • Removed the CassandraOperations.selectBySimpleIds method.spring-doc.cn

  • Used better names for CassandraRepository.spring-doc.cn

  • Removed SD Cassandra ConsistencyLevel and RetryPolicy types in favor of DataStax ConsistencyLevel and RetryPolicy types.spring-doc.cn

  • Refactored CQL specifications to value objects and configurators.spring-doc.cn

  • Refactored QueryOptions to be immutable objects.spring-doc.cn

  • Refactored CassandraPersistentProperty to single-column.spring-doc.cn

Deprecations

  • Deprecated QueryOptionsBuilder.readTimeout(long, TimeUnit) in favor of QueryOptionsBuilder.readTimeout(Duration).spring-doc.cn

  • Deprecated CustomConversions in favor of CassandraCustomConversions.spring-doc.cn

  • Deprecated BasicCassandraMappingContext in favor of CassandraMappingContext.spring-doc.cn

  • Deprecated o.s.d.c.core.cql.CachedPreparedStatementCreator in favor of o.s.d.c.core.cql.support.CachedPreparedStatementCreator.spring-doc.cn

  • Deprecated CqlTemplate.getSession() in favor of getSessionFactory().spring-doc.cn

  • Deprecated CqlIdentifier.cqlId(…) and KeyspaceIdentifier.ksId(…) in favor of the .of(…) methods.spring-doc.cn

  • Deprecated constructors of QueryOptions in favor of their builders.spring-doc.cn

  • Deprecated TypedIdCassandraRepository in favor of CassandraRepositoryspring-doc.cn

Merged Spring CQL and Spring Data Cassandra Modules

Spring CQL and Spring Data Cassandra are now merged into a single module. The standalone spring-cql module is no longer available. You can find all types merged into spring-data-cassandra. The following listing shows how to include spring-data-cassandra in your maven dependencies:spring-doc.cn

<dependencies>

  <dependency>
    <groupId>org.springframework.data</groupId>
    <artifactId>spring-data-cassandra</artifactId>
    <version>4.5.2</version>
  </dependency>

</dependencies>

With the merge, we merged all CQL packages into Spring Data Cassandra:spring-doc.cn

  • Moved o.s.d.cql into o.s.d.cassandra.core.cql.spring-doc.cn

  • Merged o.s.d.cql with o.s.d.cassandra.config and flattened the XML and Java subpackages.spring-doc.cn

  • Moved CassandraExceptionTranslator and CqlExceptionTranslator to o.s.d.c.core.cql.spring-doc.cn

  • Moved Cassandra exceptions o.s.d.c.support.exception to o.s.d.cassandra.spring-doc.cn

  • Moved o.s.d.c.convert to o.s.d.c.core.convert (affects converters).spring-doc.cn

  • Moved o.s.d.c.mapping to o.s.d.c.core.mapping (affects mapping annotations).spring-doc.cn

  • Moved MapId from o.s.d.c.repository to o.s.d.c.core.mapping.spring-doc.cn

[[revised-cqltemplate/cassandratemplate]] == Revised CqlTemplate/CassandraTemplatespring-doc.cn

We split CqlTemplate and CassandraTemplate in three ways:spring-doc.cn

  • CassandraTemplate is no longer a CqlTemplate but uses an instance that allows reuse and fine-grained control over fetch size, consistency levels, and retry policies. You can obtain the CqlOperations through CassandraTemplate.getCqlOperations(). Because of the change, dependency injection of CqlTemplate requires additional bean setup.spring-doc.cn

  • CqlTemplate now reflects basic CQL operations instead of mixing high-level and low-level API calls (such as count(…) versus execute(…)) and the reduced method set is aligned with Spring Frameworks’s JdbcTemplate with its convenient callback interfaces.spring-doc.cn

  • Asynchronous methods are re-implemented on AsyncCqlTemplate and AsyncCassandraTemplate by using ListenableFuture. We removed Cancellable and the various async callback listeners. ListenableFuture is a flexible approach and allows transition into a CompletableFuture.spring-doc.cn

Removed CassandraOperations.selectBySimpleIds()

The method was removed because it did not support complex IDs. The newly introduced query DSL allows mapped and complex id’s for single column Id’s, as the following example shows:spring-doc.cn

cassandraTemplate.select(Query.query(Criteria.where("id").in(…)), Person.class)

Better names for CassandraRepository

We renamed CassandraRepository and TypedIdCassandraRepository to align Spring Data Cassandra naming with other Spring Data modules:spring-doc.cn

  • Renamed CassandraRepository to MapIdCassandraRepositoryspring-doc.cn

  • Renamed TypedIdCassandraRepository to CassandraRepositoryspring-doc.cn

  • Introduced TypedIdCassandraRepository, extending CassandraRepository as a deprecated type to ease migrationspring-doc.cn

Removed SD Cassandra ConsistencyLevel and RetryPolicy types in favor of DataStax ConsistencyLevel and RetryPolicy types

Spring Data Cassandra ConsistencyLevel and RetryPolicy have been removed. Please use the types provided by the DataStax driver.spring-doc.cn

The Spring Data Cassandra types restricted usage of available features provided in and allowed by the Cassandra native driver. As a result, the Spring Data Cassandra’s types required an update each time newer functionality was introduced by the driver.spring-doc.cn

Refactored CQL Specifications to Value Objects and Configurators

As much as possible, CQL specification types are now value types (such as FieldSpecification, AlterColumnSpecification), and objects are constructed by static factory methods. This allows immutability for simple value objects. Configurator objects (such as AlterTableSpecification) that operate on mandatory properties (such as a table name or keyspace name) are initially constructed through a a static factory method and allow further configuration until the desired state is created.spring-doc.cn

Refactored QueryOptions to be Immutable Objects

QueryOptions and WriteOptions are now immutable and can be created through builders. Methods accepting QueryOptions enforce non-null objects, which are available from static empty() factory methods. The following example shows how to use QueryOptions.builder():spring-doc.cn

QueryOptions queryOptions = QueryOptions.builder()
		.consistencyLevel(ConsistencyLevel.ANY)
		.retryPolicy(FallthroughRetryPolicy.INSTANCE)
		.readTimeout(Duration.ofSeconds(10))
		.fetchSize(10)
		.tracing(true)
		.build();

Refactored CassandraPersistentProperty to Single-column

This change affects You only if you operate directly on the mapping model.spring-doc.cn

CassandraPersistentProperty allowed previously multiple column names to be bound for composite primary key use. Columns of a CassandraPersistentProperty are now reduced to a single column. Resolved composite primary keys map to a class through MappingContext.getRequiredPersistentEntity(…).spring-doc.cn