Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/apache/cassandra-java-driver

Java Driver for Apache Cassandra®
https://github.com/apache/cassandra-java-driver

Last synced: 4 days ago
JSON representation

Java Driver for Apache Cassandra®

Awesome Lists containing this project

README 

        
# 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.



[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.cassandra/java-driver-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.cassandra/java-driver-core)



*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 latest version through [DataStax Docs] or via the release tags, e.g. 

[4.17.0](https://github.com/datastax/java-driver/tree/4.17.0).*



A modern, feature-rich and highly tunable Java client library for [Apache Cassandra®] \(2.1+) and 

[DataStax Enterprise] \(4.7+), and [DataStax Astra], using exclusively Cassandra's binary protocol

and Cassandra Query Language (CQL) v3.



[DataStax Docs]: http://docs.datastax.com/en/developer/java-driver/

[Apache Cassandra®]: http://cassandra.apache.org/



## Getting the driver



The driver artifacts are published in Maven central, under the group id [com.datastax.oss]; there

are multiple modules, all prefixed with `java-driver-`.



```xml



  org.apache.cassandra

  java-driver-core

  ${driver.version}



  org.apache.cassandra

  java-driver-query-builder

  ${driver.version}



  org.apache.cassandra

  java-driver-mapper-runtime

  ${driver.version}



```



Note that the query builder is now published as a separate artifact, you'll need to add the

dependency if you plan to use it.



Refer to each module's manual for more details ([core](manual/core/), [query

builder](manual/query_builder/), [mapper](manual/mapper)).



[com.datastax.oss]: http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.datastax.oss%22



## Compatibility



The driver is compatible with Apache Cassandra® 2.1 and higher, DataStax Enterprise 4.7 and

higher, and DataStax Astra.



It requires Java 8 or higher.



Disclaimer: Some DataStax/DataStax Enterprise products might partially work on big-endian systems,

but DataStax does not officially support these systems.



## Migrating from previous versions



Java Driver 4 is **not binary compatible** with previous versions. However, most of the concepts

remain unchanged, and the new API will look very familiar to 2.x and 3.x users.



See the [upgrade guide](upgrade_guide/) for details.



## Error Handling



See the [Cassandra error handling done right blog](https://www.datastax.com/blog/cassandra-error-handling-done-right) for error handling with the Java Driver for Apache Cassandra™.



## Useful links



* [Manual](manual/)

* [API docs]

* Bug tracking: [JIRA].  Make sure to select the "Client/java-driver" component when filing new tickets!

* [Mailing list]

* [Changelog]

* [FAQ]



[API docs]: https://docs.datastax.com/en/drivers/java/4.17

[JIRA]: https://issues.apache.org/jira/issues/?jql=project%20%3D%20CASSANDRA%20AND%20component%20%3D%20%22Client%2Fjava-driver%22%20ORDER%20BY%20key%20DESC

[Mailing list]: https://groups.google.com/a/lists.datastax.com/forum/#!forum/java-driver-user

[Changelog]: changelog/

[FAQ]: faq/



## License



© The Apache Software Foundation



Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at



http://www.apache.org/licenses/LICENSE-2.0



Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.



----



Apache Cassandra, Apache, Tomcat, Lucene, Solr, Hadoop, Spark, TinkerPop, and Cassandra are 

trademarks of the [Apache Software Foundation](http://www.apache.org/) 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.