Using DBeaver

DBeaver is a free open source multi-platform, cross-platform database tool for developers, SQL programmers, and database administrators. DBeaver supports various databases including PostgreSQL, MariaDB, MySQL, YugabyteDB. In addition, there are plugins and extensions for other databases that support the JDBC driver. DBeaver Enterprise Edition supports non-JDBC data sources and allows you to explore Yugabyte YCQL tables.

DBeaver

Prerequisites

Before you can start using DBeaver with YCQL, you need to perform the following:

Create a YCQL connection

You can create a connection as follows:

  • Launch DBeaver.

  • Navigate to Database > New Database Connection to open the Connect to a database window shown in the following illustration.

  • In the Select your database list, select NoSQL > Yugabyte CQL, and then click Next.

    DBeaver Select Database

  • Use Connection Settings to specify the following:

    • Host: localhost
    • Port: 9042
    • Keyspace: system
    • User: leave blank if YCQL authentication is not enabled. If enabled, enter username.
    • Password: leave blank if YCQL authentication is not enabled. If enabled, enter the password.
    • Select Show all databases.
  • Click Test Connection to verify that the connection is successful, as shown in the following illustration:

    DBeaver Test Connection

The Database Navigator should display "system".

You can expand the list to see all keyspaces available in YugabyteDB cluster, as shown in the following illustration:

DBeaver

What's Next

For sample data to explore YCQL using DBeaver, see JSON support.