DataStax Enterprise Ruby Driver

NOTE: The DataStax Enterprise Ruby Driver can be used solely with DataStax Enterprise. Please consult the license.

This driver is built on top of the DataStax Ruby driver for Apache Cassandra and enhanced for the adaptive data management and mixed workload capabilities provided by DSE. Therefore a lot of the underlying concepts are the same.


Driver documentation can be found here.

In particular, you’ll find our Features and API sections very enlightening.

Feedback Requested

Help us focus our efforts! Provide your input on the Ruby Driver Platform and Runtime Survey (we kept it short).

If you find an issue, please file an issue in our public JIRA. Please be sure to specify the affects-version (DSE-1.X.Y).

You can also post questions in our forum.


This driver exposes the following features of DSE 5.0:

Note that this driver is fully compatible with previous versions of DataStax Enterprise.


The driver is named dse-driver on and can easily be installed with Bundler or the gem program. It will download the appropriate Cassandra driver as well.


The driver is intended to have the same look and feel as the core driver to make upgrading from the core driver trivial. The only change is to replace references to the Cassandra module with Dse when creating the cluster object:

require 'dse'

# This returns a Dse::Cluster instance
cluster = Dse.cluster

# This returns a Dse::Session instance
session = cluster.connect
rs = session.execute('select * from system.local')

Determining driver versions

Within a script or irb, you can determine the exact versions of the dse and core drivers by accessing the VERSION constant of the appropriate module:

require 'dse'

puts "Dse Driver Version: #{Dse::VERSION}"
puts "Cassandra Driver Version: #{Cassandra::VERSION}"


Although this driver exposes new features introduced in DSE 5.0, it is fully compatible and supported for use with previous versions of DSE.


Copyright © 2016 DataStax Inc.

The full license terms are available at