Download ScyllaDB JDBC Driver

Download the ScyllaDB JDBC driver, copy the JDBC URL into DbSchema, and start designing schemas with ER diagrams — free Community Edition.

About the ScyllaDB JDBC driver

A JDBC driver is a Java .jar library that lets applications connect to ScyllaDB. DbSchema uses JDBC to reverse engineer schemas, run SQL, and generate documentation. Driver files are usually published by the database vendor or an open-source project.

JDBC URL format

Host, port, database name, and SSL options are passed in a URL starting with jdbc:. Each ScyllaDB driver uses its own syntax — see the connection details below.

The ScyllaDB JDBC driver

ScyllaDB is a high-performance, Cassandra-compatible NoSQL database written in C++, offering significantly lower latency and higher throughput than Apache Cassandra due to its shard-per-core architecture. It is used for high-throughput workloads like ad targeting, IoT telemetry, and real-time leaderboards.

ScyllaDB is wire-compatible with Cassandra. For connecting we use our own open-source JDBC driver, available on GitHub.

The ScyllaDB JDBC URL

• Required File(s): scylladb-driver.jar
• Java Driver Class: com.dbschema.ScyllaDB.JdbcDriver
• JDBC URL: jdbc:scylladb://host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[keyspace];dataCenter[&options]]
• Website: DbSchema.com

The driver is written on top of the native ScyllaDB Java Driver. For connecting to multiple hosts you can pass an URL like: jdbc:scylladb://host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[keyspace];dataCenter[&options]]

Find the DataCenter using nodetool status or nodetool -h ::FFFF:127.0.0.1 status

Connecting to ScyllaDB with SSL

Connecting using SSL is possible setting the parameters: javax.net.ssl.trustStore=/path/to/client.truststore&javax.net.ssl.trustStorePassword=password123& javax.net.ssl.keyStore=/path/to/client.keystore&javax.net.ssl.keyStorePassword=password123
These parameters can be also set in DbSchema.vmoptions file in the installation folder or ./DbSchema.app/Contents/vmoptions.txt on Mac OS, and add:

    -Djavax.net.ssl.trustStore=/path/to/client.truststore
    -Djavax.net.ssl.trustStorePassword=password123
    # If you're using client authentication:
    -Djavax.net.ssl.keyStore=/path/to/client.keystore
    -Djavax.net.ssl.keyStorePassword=password123
    

Downloading the ScyllaDB JDBC Driver

Download ScyllaDB JDBC Driver

The driver archive is a zip file. Unzip the downloaded archive to get the driver files. The driver source code can be found on GitHub repository. Check the GitHub link for details on how to use the driver and configure SSL.

The driver is written on top of the standard DataStax Java driver.

Connecting to a ScyllaDB Cluster

ScyllaDB keeps Cassandra's configuration model, so the same two settings decide whether a driver gets in — and the URL needs the same datacenter name.

1. Bind the client interface. In scylla.yaml, rpc_address is the address the native transport offers to drivers; listen_address beside it carries traffic between nodes and is not the one clients use. Where rpc_address is 0.0.0.0, broadcast_rpc_address has to name a reachable address, since that is what the cluster advertises to drivers.
2. Find the datacenter name. The URL carries ;dc=. Read the real value from nodetool status, or nodetool -h ::FFFF:127.0.0.1 status on an IPv6 listener — the driver uses it to decide which nodes count as local.
3. Give the URL more than one contact point. The host field takes a comma-separated list, so the connection survives a single node being down.
4. Open port 9042 in the server's firewall. The database listens on port 9042 unless it was installed with a different one. A host firewall on the server blocks incoming connections on that port until a rule allows them. The firewall guide has the commands for Windows, ufw, firewalld and iptables.
5. Connect from DbSchema. In the Connection Dialog choose Remote computer or custom port, fill in the server host and the port, then press Test Connection to check that the server answers before you connect.

On ScyllaDB Cloud there is nothing to bind: add your address to the cluster's allowed IP list, take the contact points and credentials from the console, and keep the connection on TLS with the Use SSL entry in the Connection Mode combo.

DbSchema and ScyllaDB

ScyllaDB is wire-compatible with Cassandra, so DbSchema connects using the Cassandra JDBC driver. Use DbSchema to browse ScyllaDB keyspaces, tables, and materialized views as visual schemas.