DBeaver

DBeaver is a free (and open source) multi-platform, cross-platform database tool for developers, SQL programmers, database administrators, and analysts. DBeaver is written in Java, based on the Eclipse platform, and supports supports any database that ha a JDBC driver, including PostgreSQL, MariaDB, and MySQL. And, using the PostgreSQL JDBC driver, you can use DBeaver with YugabyteDB.

The DBeaver Community Edition includes these features:

• Open source
• Connection and metadata browser
• SQL query editor and executor
• Rich in-line data editor
• Entity relationship (ER) diagrams

The DBeaver Enterprise Edition adds support for non-JDBC data sources, including MongoDB, Cassandra, and Redis.

Before you begin

Before getting started with DBeaver, make sure you meet the following prerequisites.

YugabyteDB

Your YugabyteDB cluster should be up and running. If you’re new to YugabyteDB, create a local cluster in less than five minutes following the steps in Quick Start.

Java Runtime Environment (JRE)

DBeaver requires a Java runtime (or JDK) for Java 8 or later. Some of the installers include a JRE, accessible only to DBeaver.

JDK and JRE installers for Linux, macOS, and Windows can be downloaded from OpenJDK, AdoptOpenJDK, or Azul Systems.

PostgreSQL JDBC driver

The PostgreSQL JDBC driver can be used with DBeaver to work with YugabyteDB databases.

To connect DBeaver to a YugabyteDB cluster, you need the PostgreSQL JDBC driver installed. To download the current version that supports Java 8 or later, go to the PostgreSQL JDBC Driver download page.

Install DBeaver

• Download the distribution package for the operating system on your client computer from the DBeaver downloads page.
• Install DBeaver following the steps on the DBeaver Installation page.

Configure DBeaver

Configure the JDBC driver

• Start the DBeaver application. The DBeaver application window appears.

• On the menu, select Database > Driver Manager. The Driver Manager window appears.

• Select PostgreSQL and then click Copy. The Create new driver window appears with a copy of the default PostgreSQL driver settings.

• Make the following changes in the Settings:

  • DriverName: YugabyteDB — Default name is “PostgreSQL”, but using “YugabyteDB” might help you not confuse this driver’s settings with PostgreSQL connections using the PostgreSQL port of 5432.
  • Driver Type: PostgreSQL (selected)
  • Class Name: org.postgresql.Driver
  • URL Template: jdbc.postgresql://{host}[:{port}/[{database}] (read-only)
  • Default Port: 5433 (Default is 5432)

• In the Libraries tab, select the PostgreSQL JDBC driver JAR file to be used.

• Click OK. The Create new driver window closes.

• Verify that the new “YugabyteDB” driver appears in the Driver Manager listing and then click Close.

Create a database connection

• On the DBeaver menu, select Database > New Connection. The Connect to database window appears.

• In the Select your database listing, select YugabyteDB and then click Next.

• In the Connection Settings, add the following settings:

  • Host: localhost
  • Port: 5433
  • Database: Clear the default value (postgres)
  • User: yugabyte (default is postgres)
  • Password: Leave blank if YSQL authentication is not enabled. If enabled, add the password for yugabyte (default is yugabyte).
  • Show all databases: Select this option.

• Click Test Connection to verify that the connection is successful.

• Click Finish.

• In the DBeaver application, you should now see “Yugabyte - localhost” in the Database Navigator panel.

You can now expand the listing and see a listing of all databases available to the yugabyte user.

What’s next

DBeaver has lots of features for developers and administrators to explore. For help using DBeaver, see the DBeaver.io website and the DBeaver documentation.

If you’re looking for sample databases to explore YugabyteDB using DBeaver, see Sample data.