Client drivers for YCQL YCQL

This page documents a preview version. v2.23 Preview
Preview includes features under active development and is for development and testing only.
For production, use the latest stable version (v2024.1).

The following client drivers are supported for use with the YugabyteDB Cloud Query Language (YCQL) API, a SQL-based, semi-relational API, with roots in the Apache Cassandra Query Language (CQL).

For tutorials on building a sample application with the following client drivers, click the relevant link included below for each driver.

Use YugabyteDB client drivers

You should always use the YugabyteDB YCQL client drivers. Using generic Cassandra drivers can lead to errors and performance issues.

C/C++

YugabyteDB C/C++ Driver for YCQL

The YugabyteDB C++ Driver for YCQL is based on the DataStax C++ Driver for Apache Cassandra.

For details, see the README in our GitHub repository.

For a tutorial on building a sample C++ application with this driver, see Build a C++ application.

C#

YugabyteDB C# Driver for YCQL

The YugabyteDB C# Driver for YCQL is based on a fork of the DataStax C# Driver for Apache Cassandra.

For details, see the README in our GitHub repository.

For a tutorial on building a sample C# application with this driver, see Connect an application.

Go

YugabyteDB Go Driver for YCQL

The YugabyteDB Go Driver for YCQL is based on a fork of GoCQL.

For details, see the README in our GitHub repository.

For a tutorial on building a sample Go application with this driver, see Connect an application.

Java

YugabyteDB Java Driver for YCQL 3.10

The YugabyteDB Java Driver for YCQL, version 3.10.0-yb-x, is based on the DataStax Java Driver for Apache Cassandra v.3.10 and requires the Maven dependency shown below.

For details, see the v3.10 README in our GitHub repository.

For a tutorial on building a sample Java application with this driver, see Connect an application.

To build Java applications with this driver, you must add the following Maven dependency to your application:

<dependency>
  <groupId>com.yugabyte</groupId>
  <artifactId>cassandra-driver-core</artifactId>
  <version>3.10.3-yb-2</version>
</dependency>

For details, see the Maven repository contents.

YugabyteDB Java Driver for YCQL 4.15

The YugabyteDB Java Driver for YCQL, version 4.15.0-yb-1, is based on the DataStax Java Driver for Apache Cassandra (v4.15) and requires the Maven dependency shown below.

For details, see the v4.15 README in our GitHub repository.

For a tutorial on building a sample Java application with this driver, see Connect an application.

To build Java applications with this driver, you must add the following Maven dependency to your application:

<dependency>
  <groupId>com.yugabyte</groupId>
  <artifactId>java-driver-core</artifactId>
  <version>4.15.0-yb-1</version>
</dependency>

For details, see the Maven repository contents.

Node.js

YugabyteDB Node.js driver for YCQL

The YugabyteDB Node.js driver for YCQL is based on a fork of the DataStax Node.js Driver for Apache Cassandra.

For details, see the README in our GitHub repository.

For a tutorial on building a sample Node.js application with this driver, see Connect an application.

Python

YugabyteDB Python Driver for YCQL

The YugabyteDB Python Driver for YCQL is based on a fork of the DataStax Python Driver for Apache Cassandra.

For details, see the README in our GitHub repository.

For a tutorial on building a sample Python application with this driver, see Connect an application.

Ruby

YugabyteDB Ruby Driver for YCQL

The YugabyteDB Ruby Driver for YCQL is based on a fork of the DataStax Ruby Driver for Apache Cassandra.

For details, see the README in our GitHub repository.

For a tutorial on building a sample Ruby application with this driver, see Connect an application.

Scala

YugabyteDB Java Driver for YCQL

The YugabyteDB Java Driver for YCQL is based on a fork of the DataStax Java Driver for Apache Cassandra and can be used to build Scala applications when you add the sbt (Scala build tool) dependency shown below to your application.

For details, see the README in our GitHub repository.

To build a Scala application with the YugabyteDB Java Driver for YCQL, you must add the following sbt dependency to your application:

libraryDependencies += "com.yugabyte" % "cassandra-driver-core" % "3.8.0-yb-5"

For a tutorial on building a sample Scala application with this driver, see Connect an application.