Skip to content

‣ DBSchema

📖 Reference Documentations and resources
  1. 📖 Astra Docs - Reference documentation
  2. DBSchema Tutorials

Overview

DbSchema is a universal database designer for out-of-the-box schema management and documentation, sharing the schema in the team, and deploying on different databases. Visual tools can help developers, database administrators, and decision-makers to query, explore and manage the data.

DBSchema uses the Astra JDBC Driver to connect to Cassandra as the storage backend. The Java driver itself supports connections to Astra DB natively.

Prerequisites

This article assumes you have installed the latest version of DBSchema on your laptop or PC.

Installation and Setup

✅ Step 1: JDBC Driver

Download Astra JDBC connector jar from Github

✅ Step 2: Establish the Connection

  1. Open DB Schema
  2. Select Connect to the Database
  3. Select Start

  4. In the Choose your database menu, select Cassandra.

  5. Select Next.

  6. Select JDBC Driver edit option. This is the button on the right hand side of the JDBC driver line, with the key icon.

  7. In the JDBC Driver Manager, select New.

  8. In the Add RDBMS window, enter Astra and select OK

  9. Select OK in the confirmation message.

  10. Upload the Astra JDBC Driver.

  11. Select Open
  12. Once you upload the Astra JDBC Driver, you will see Astra in the Choose your Database window. Select Next.

  1. In the connection window, select the JDBC Driver "astra-jdbc-connector-5.0.jar com.datastax.astra.jdbc.AstraJdbcDriver. Under JDBC URL select "Edit Manually".

  2. In the Astra Connection Dialog, add JDBC URL as

    jdbc:astra://<database_name>/<keyspace_name>?token=<application_token>
    
    with the following variables:

    • database_name: The name or ID for the database you want to connect to
    • keyspace_name: The keyspace you want to use
    • application_token: Generated from Astra DB console. See Manage application tokens.
  3. Select Connect

  4. In the Select Schemas/Catalogs, select the keyspace to which you want to connect.

  5. Select OK.

✅ Step 3: Final Test

Now that your connection is working, you can create tables, introspect your keyspaces, view your data in the DBSchema GUI, and more.

To learn more about DBSchema, see Quick start with DBSchema


Last update: 2023-10-13