cassandra-cpp
This is a maintained Rust project that exposes the DataStax cpp driver at https://github.com/datastax/cpp-driver/ in a somewhat-sane crate. It was originally a fork of https://github.com/tupshin/cassandra-rs but that is no longer maintained.
It is a wrapper around the raw driver binding crate cassandra-cpp-sys.
Getting started
Local environment
For this crate to work, you must first have installed a sufficiently-recent version of the datastax-cpp driver (at least 2.16). Follow the steps in the cpp driver docs to do so. Pre-built packages are available for most platforms.
Make sure that the driver (specifically libcassandra_static.a and libcassandra.so) are in your /usr/local/lib64/ directory
Floki
Alternatively you can use the Floki utility to create you a Dockerized compilation environment. After installing Floki, just type
floki
in the root of this project. You will be dropped into a Rust compilation environment; type cargo build as normal to build the driver.
Documentation
See the API documentation.
The Cassandra Query Language (CQL) documentation is likely to be useful.
Since this crate provides a relatively thin wrapper around the DataStax driver, you may also find the DataStax documentation and API docs useful.
Example
For a straightforward example see simple.rs.
There are additional examples included with the project in tests and
examples.
Futures (version 0.15)
Since version 0.15, this crate uses std::future, allowing your code to
use futures:0.3, async/await, etc.
Previous versions (up to 0.14) used futures:0.1. You can either remain on
the 0.14 stream, update your code to use std::future, or use a compatibility
shim (e.g., futures::compat).
Migrating from version 0.8
The API changed significantly in version 0.10.
(Version 0.9 was skipped, for consistency with the cassandra-cpp-sys version number.)
For a summary of the main changes, see CHANGELOG.
Feature flags
This crate includes the feature flag early_access_min_tls_version, which allows you to build against a version of the DataStax driver including the cass_ssl_set_min_protocol_version method, as defined in this PR. You must have a version of the driver supporting this installed locally to be able to compile (and run) with this feature flag.
When this this feature is available in the mainline driver this flag will be set to do nothing and deprecated, and the functions will be added to the main library. The flag will then be retired in the next breaking change.
License
This code is open source, licensed under the Apache License Version 2.0 as
described in LICENSE.
Contributing
Please see CONTRIBUTING.md for details on how to contribute
to this project.
Development
This crate is regularly built by Travis; to see details of the most recent builds click on the "build" badge at the top of this page.
You must have the DataStax driver installed on your system in order to build this crate.
The unit tests assume Cassandra is running on the local host accessible on the standard port. The easiest way to achieve this is using Docker and the standard Cassandra image, with
docker pull cassandra
docker run -d --net=host --name=cassandra cassandra
You should run them single-threaded to avoid the dreaded
org.apache.cassandra.exceptions.ConfigurationException: Column family ID mismatch
error. The tests share a keyspace and tables, so if run in parallel they
interfere with each other.
cargo test -- --test-threads 1
Remember to destroy the container when you're done:
docker stop cassandra
docker rm cassandra
History
This project was forked from cassandra, which was no longer being maintained.