Cassandra.ToolsAboutKnowledge Base

Spring Data Cassandra

datastax (103739) datastax/spring-data-cassandra (0)
License:Apache 2.0

== Features

  • Build repositories based on common Spring Data interfaces
  • Support for synchronous, reactive, and asynchronous data operations
  • Support for XML based Keyspace creation and CQL Table creation
  • JavaConfig and XML Support for all Cluster and Session Capabilities
  • Exception Translation to the familiar Spring DataAccessException hierarchy
  • Convenient QueryBuilders to eliminate the need to learn CQL
  • Automatic implementation of Repository interfaces including support for custom query methods
  • Based on the 3.x DataStax CQL Java Driver

== Code of Conduct

This project is governed by the[Spring Code of Conduct]. By participating, you are expected to uphold this code of conduct. Please report unacceptable behavior to

== Getting Started

Here is a quick teaser of an application using Spring Data Repositories in Java:


public interface PersonRepository extends CrudRepository<Person, Long> {

List findByLastname(String lastname);

List findByFirstnameLike(String firstname); }

@Service public class MyService {

private final PersonRepository repository;

public MyService(PersonRepository repository) { this.repository = repository; }

public void doWork() {


Person person = new Person();

List<Person> lastNameResults = repository.findByLastname("Adams");
List<Person> firstNameResults = repository.findByFirstnameLike("M*");

} }

@Configuration @EnableCassandraRepositories class ApplicationConfig extends AbstractCassandraConfiguration {

@Override public String getContactPoints() { return "localhost"; }

@Override protected String getKeyspaceName() { return "springdata"; } }

=== Maven configuration

Add the Maven dependency:

[source,xml] spring-data-cassandra ${version}.RELEASE ----

If you'd rather like the latest snapshots of the upcoming major version, use our Maven snapshot repository and declare the appropriate dependency version.

[source,xml] spring-data-cassandra ${version}.BUILD-SNAPSHOT spring-libs-snapshot Spring Snapshot Repository ----

== Getting Help

Having trouble with Spring Data? We’d love to help!

== Reporting Issues

Spring Data uses JIRA as issue tracking system to record bugs and feature requests. If you want to raise an issue, please follow the recommendations below:

  • Before you log a bug, please search the[issue tracker] to see if someone has already reported the problem.
  • If the issue doesn’t already exist,[create a new issue].
  • Please provide as much information as possible with the issue report, we like to know the version of Spring Data that you are using and JVM version.
  • If you need to paste code, or include a stack trace use JIRA {code}…{code} escapes before and after your text.
  • If possible try to create a test-case or project that replicates the issue. Attach a link to your code or a compressed file containing your code.

== Building from Source

You don’t need to build from source to use Spring Data (binaries in[]), but if you want to try out the latest and greatest, Spring Data can be easily built with the[maven wrapper]. You also need JDK 1.8.


$ ./mvnw clean install

If you want to build with the regular mvn command, you will need[Maven v3.5.0 or above].

Also see link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] if you wish to submit pull requests, and in particular please sign the[Contributor’s Agreement] before your first non-trivial change.

== Initial Contributors

Spring Data for Apache Cassandra was initially created and supported by the following companies and individuals:

=== Building reference documentation

Building the documentation builds also the project without running tests.


$ ./mvnw clean install -Pdistribute

The generated documentation is available from target/site/reference/html/index.html.

== Examples

== License

Spring Data for Apache Cassandra is Open Source software released under the[Apache 2.0 license].

© 2020 Anant Corporation, All Rights Reserved. All logos, trademarks and registered trademarks are the property of their respective owners.