ScyllaDB JDBC Driver & How to Connect

DbSchema is connecting to ScyllaDB using JDBC Drivers.

  1. What are JDBC Drivers
  2. What is the JDBC URL
  3. Download the ScyllaDB JDBC Driver
  4. How to Connect using the DbSchema ScyllaDB

What are JDBC Drivers?

JDBC drivers are Java library files with the extension '.jar', used by Java applications to connect to the database. Usually they are provided by the same company which developed the database software. DbSchema is an ScyllaDB Client which already includes the ScyllaDB JDBC driver. DbSchema can configure the ScyllaDB JDBC URL and test the connectivity.

What is the JDBC URL?

The URL is a string (text) with a specific format containing information about the host where the database is running, the port, username, database name, etc. The URL format is specific to each driver. Any wrong character in the URL may make the database connectivity fail. Therefore we recommend installing DbSchema and try to get connected, and you will find the JDBC URL in the connection dialog.

Driver Information

For connecting to Cassandra we wrote our own open-source JDBC driver, available on GitHub.

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

The driver is wrote 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 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
This 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 and Testing the Driver Binaries

Download Cassandra JDBC Driver

The driver files are compressed in 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.

for any issues with the driver, you can write to us.

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

Connect to ScyllaDB using DbSchema

DbSchema is using JDBC Drivers to connect to the database. Installing the application you can easy set up a connection. DbSchema will build the JDBC URL for you.
  1. 1 Download DbSchema. DbSchema has a free community edition. No email or registration is required.
  2. 2 Choose to connect to the database, and choose ScyllaDB. Connect to database
  3. 3 Connection-dialog

    At this point, DbSchema already downloads the JDBC driver into this folders:

    • C:\Users\YourUser\.DbSchema\drivers\ScyllaDB (Windows) or
    • /Users/YourUser/.DbSchema/drivers/ScyllaDB (Linux and MacOS).

    In the Connection Dialog, select the driver and the JDBC URL template. For databases using multiple possibilities to connect, may exists multiple templates. Choose if the database is running on the current machine or a different port. If is running on a different machine (remote), you need to find the host name. Hover the Host info label using the mouse to get instructions.

  4. 4 Press the Ping button to test the connectivity.
  5. 5 Edit JDBC URL In the URL combo there is an option to 'Manually Edit the URL'. Select this option to see the generated JDBC URL.
  6. 6 DbSchema Layouts After connecting, DbSchema will create the first diagrams (layouts). Double-click any table header or column to edit.
  7. 7 SQL Editor Activate the SQL Editor from the menu to edit and execute queries. For a detailed list of features, please read the DbSchema Quick Tour.