Sidecar for Apache Cassandra

Clone this repo:


  1. 38cdacb CEP-28: Implement Bulk API endpoints and introduce the Sidecar Client to Support Cassandra Analytics by Dinesh Joshi · 10 days ago trunk
  2. 252d983 CASSANDRASC-48: Adding new endpoint that gives information about the release version & partitioner name of a node by jkonisa · 7 months ago
  3. 02cc654 CASSANDRASC-47: Introduce JMX foundation in Sidecar by Francisco Guerrero · 7 months ago
  4. 30c04eb CASSANDRASC-45: Delegate methods to the RateLimiter by Francisco Guerrero · 8 months ago
  5. 6e358ac CASSANDRASC-43 Add Schema API by Francisco Guerrero · 8 months ago

Apache Cassandra Sidecar [WIP]

This is a Sidecar for the highly scalable Apache Cassandra database. For more information, see the Apache Cassandra web site and CIP-1.

This is project is still WIP.


  1. Java >= 1.8 (OpenJDK or Oracle), or Java 11
  2. Apache Cassandra 4.0. We depend on virtual tables which is a 4.0 only feature.
  3. Docker for running integration tests.

Getting started: Running The Sidecar

After you clone the git repo, you can use the gradle wrapper to build and run the project. Make sure you have Apache Cassandra running on the host & port specified in conf/sidecar.yaml.

$ ./gradlew run

Configuring Cassandra Instance

While setting up cassandra instance, make sure the data directories of cassandra are in the path stored in sidecar.yaml file, else modify data directories path to point to the correct directories for stream APIs to work.


We rely on docker containers for integration tests.

The only requirement is to install and run Docker on your test machine.

CircleCI Testing

You will need to use the “Add Projects” function of CircleCI to set up CircleCI on your fork. When promoted to create a branch, do not replace the CircleCI config, choose the option to do it manually. CircleCI will pick up the in project configuration.


We warmly welcome and appreciate contributions from the community. Please see if you wish to submit pull requests.

Wondering where to go from here?