Java Driver for Apache Cassandra®

:warning: The java-driver has recently been donated by Datastax to The Apache Software Foundation and the Apache Cassandra project. Bear with us as we move assets and coordinates.

If you're reading this on github.com, please note that this is the readme for the development version and that some features described here might not yet have been released. You can find the documentation for the latest version through the Java Driver docs or via the release tags, e.g. 3.13.0.

A modern, feature-rich and highly tunable Java client library for Apache Cassandra (2.1+) and using exclusively Cassandra's binary protocol and Cassandra Query Language v3. Use the [DataStax Enterprise Java Driver][dse-driver] for better compatibility and support for DataStax Enterprise.

Features:

Sync and Async API
Simple, Prepared, and Batch statements
Asynchronous IO, parallel execution, request pipelining
Connection pooling
Auto node discovery
Automatic reconnection
Configurable load balancing and retry policies
Works with any cluster size
Query builder
Object mapper

The driver architecture is based on layers. At the bottom lies the driver core. This core handles everything related to the connections to a Cassandra cluster (for example, connection pool, discovering new nodes, etc.) and exposes a simple, relatively low-level API on top of which higher level layers can be built.

The driver contains the following modules:

driver-core: the core layer.
driver-mapping: the object mapper.
driver-extras: optional features for the Java Driver.
driver-examples: example applications using the other modules which are only meant for demonstration purposes.
driver-tests: tests for the java-driver.

Useful links:

JIRA (bug tracking): https://issues.apache.org/jira/projects/CASSJAVA
MAILING LIST: https://cassandra.apache.org/_/community.html#discussions
DOCS: the manual has quick start material and technical details about the driver and its features.
API: https://docs.datastax.com/en/drivers/java/3.11
GITHUB REPOSITORY: https://github.com/apache/cassandra-java-driver
changelog

Getting the driver

The last release of the driver is available on Maven Central. You can install it in your application using the following Maven dependency (if using DataStax Enterprise, install the [DataStax Enterprise Java Driver][dse-driver] instead):

<dependency>
  <groupId>org.apache.cassandra</groupId>
  <artifactId>cassandra-driver-core</artifactId>
  <version>3.13.0</version>
</dependency>

Note that the object mapper is published as a separate artifact:

<dependency>
  <groupId>org.apache.cassandra</groupId>
  <artifactId>cassandra-driver-mapping</artifactId>
  <version>3.13.0</version>
</dependency>

The ‘extras’ module is also published as a separate artifact:

<dependency>
  <groupId>org.apache.cassandra</groupId>
  <artifactId>cassandra-driver-extras</artifactId>
  <version>3.13.0</version>
</dependency>

We also provide a shaded JAR to avoid the explicit dependency to Netty.

Compatibility

The Java client driver 3.13.0 (branch 3.x) has been tested against Apache Cassandra 4.0.x, 4.1.x and 5.0.x. The Java driver supports Java 8 and above.

Upgrading from previous versions

If you are upgrading from a previous version of the driver, be sure to have a look at the upgrade guide.

Apache Cassandra, Apache, Tomcat, Lucene, Solr, Hadoop, Spark, TinkerPop, and Cassandra are trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries.

Binary artifacts of this product bundle Java Native Runtime libraries, which is available under the Eclipse Public License version 2.0.