ScyllaDB University LIVE, FREE Virtual Training Event | March 21
Register for Free
ScyllaDB Documentation Logo Documentation
  • Server
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
  • Resources
    • ScyllaDB University
    • Community Forum
    • Tutorials
Download
ScyllaDB Docs ScyllaDB Documentation Get Started with ScyllaDB Develop with ScyllaDB Install a Driver

Install a Driver¶

To interact with ScyllaDB, you need to install the appropriate drivers for your programming language. These drivers facilitate communication between the application and the ScyllaDB database, enabling data manipulation and retrieval.

Rust developers can use specialized drivers that provide asynchronous, non-blocking access to ScyllaDB. These drivers are designed to leverage Rust’s performance and safety features, ensuring efficient and secure database operations.

The installation typically involves adding the driver as a dependency in your Cargo.toml file and configuring it to connect to your ScyllaDB instance.

Run the following Cargo command in the project directory:

cargo add scylla

Or add the relevant version to your Cargo.toml following instructions on crates.io.

  • See the Rust Driver documentation for details.

  • Learn how to use the Rust Driver on ScyllaDB University.

For Python developers, ScyllaDB has forked the Python client driver for CQL, adding enhanced capabilities that take advantage of ScyllaDB’s architecture.

pip is the suggested tool for installing packages. It will install the Python driver and all required Python dependencies. Run the following command:

pip install scylla-driver
  • See the Python Driver documentation for details.

  • Learn how to use Python with ScyllaDB on ScyllaDB University.

For Java developers, ScyllaDB has forked the Java client driver for CQL, adding enhanced capabilities that take advantage of ScyllaDB’s architecture.

Maven is the suggested tool for managing dependencies, and the driver artifacts are published in Maven central, under the group id com.scylladb. You should include the following dependencies:

<dependency>
  <groupId>com.scylladb</groupId>
  <artifactId>java-driver-core</artifactId>
  <version>${driver.version}</version>
</dependency>

<dependency>
  <groupId>com.scylladb</groupId>
  <artifactId>java-driver-query-builder</artifactId>
  <version>${driver.version}</version>
</dependency>

<dependency>
  <groupId>com.scylladb</groupId>
  <artifactId>java-driver-mapper-runtime</artifactId>
  <version>${driver.version}</version>
</dependency>
  • See the Java Driver documentation for details.

  • Learn how to use Java with ScyllaDB on ScyllaDB University.

For Golang developers, ScyllaDB has forked the GoCQL client driver for CQL, adding enhanced capabilities that take advantage of ScyllaDB’s architecture.

This is a drop-in replacement for gocql, and it reuses the github.com/gocql/gocql import path.

To install the driver:

  1. Add the following line to your project go.mod file:

    replace github.com/gocql/gocql => github.com/scylladb/gocql latest
    
  2. Run:

    go mod tidy
    
  • See the Go Driver documentation for details.

  • Learn how to use Go with ScyllaDB on ScyllaDB University.

For JavaScript developers, ScyllaDB can use the Cassandra driver for CQL. yarn is the suggested tool for installing packages and required dependencies.

Run the following command:

yarn install cassandra-driver
  • Alternatively, you can use npm to install packages with the same name.

  • Learn how to use Node.js with ScyllaDB on ScyllaDB University.

See ScyllaDB CQL Drivers for a full list of drivers supported by ScyllaDB.

Was this page helpful?

PREVIOUS
Run ScyllaDB
NEXT
Connect an Application
  • Create an issue
  • Edit this page
ScyllaDB Documentation
  • Get Started with ScyllaDB
    • Why ScyllaDB?
    • Develop with ScyllaDB
      • Run ScyllaDB
      • Install a Driver
      • Connect an Application
      • Tutorials and Example Projects
    • Query Data
      • CQL
      • Schema
      • Inserting Data
      • Reading Data
      • Updating Data
      • Deleting Data
    • Data Modeling
      • Query Design
      • Schema Design
      • Data Modeling Best Practices
    • Learn to Use ScyllaDB
  • Versioning and Support Policy
    • ScyllaDB Version Support
Docs Tutorials University Contact Us About Us
© 2025, ScyllaDB. All rights reserved. | Terms of Service | Privacy Policy | ScyllaDB, and ScyllaDB Cloud, are registered trademarks of ScyllaDB, Inc.
Last updated on 07 May 2025.
Powered by Sphinx 7.4.7 & ScyllaDB Theme 1.8.6
OSZAR »