Getting Started With DBeaver on a Distributed SQL Database

If you’re a database developer, you know that you need different SQL statements for creating schemas, ad-hoc querying, initiating backups, or troubleshooting. For these scenarios, finding the right graphical tool can speed up these tasks and make you more productive. Over the years, the PostgreSQL community has developed several open-sourced graphical tools for managing PostgreSQL databases, visualizing the datasets it contains, and running queries. You can find a comprehensive list of tools on the PostgreSQL wiki here.

This post is the first in a series of on-going articles that will show you how to work with Yugabyte DB using popular PostgreSQL GUI tools.

What’s YugaByte DB? It’s a high performance distributed SQL database for global, internet-scale apps. YugaByte DB is a PostgreSQL-compatible database. Similar to Google Spanner, YugaByte DB gives you all the scalability characteristics of NoSQL, without sacrificing the ACID transactions or strong consistency you are accustomed to with PostgreSQL.

What Is DBeaver?

DBeaver is a free multi-platform database management tool for developers, SQL programmers, DBAs and analysts. It is written in Java and supports a variety of databases including MySQL, PostgreSQL, MariaDB, and even YugaByte DB. In addition to the databases mentioned, there are plugins and extensions for many other data products that support the JDBC driver.

In a nutshell, DBeaver gives you all the must-have features you’d expect from any database GUI tool, including:

• A connection and metadata browser
• SQL query editor and executor
• A rich in-line data editor
• Entity-relationship (ER) diagrams.

DBeaver is intuitive, and there are a lot of helpful tips that can aid you in configuring and exploring your database seamlessly.

Prerequisites

Before we get into DBeaver, you’ll need to setup YugaByte DB and install a sample database. For the purposes of this post, we’ll be using the northwind sample database. The instructions for how to get up and running in just a few minutes can be found in our previous post, “The Northwind PostgreSQL Sample Database Running on a Distributed SQL Database.”

Please note that for the purposes of this post, we’ll be focused on getting up and running on a Mac, but DBeaver supports all the major operating platforms.

Installing DBeaver

Download and Install DBeaver

The first thing to do is download the latest version of DBeaver. DBeaver comes in two editions — Community and Enterprise. In this blog, we are installing DBeaver community edition version 6.1.3 using the Mac OS X pkg installer + JRE.

Working With DBeaver

Launching DBeaver

Once you are installed, let’s launch DBeaver and configure a connection to YugaBye DB. If it is a fresh install, DBeaver will walk you through a wizard to get your connection set up, as shown below.

For the purposes of this how-to, I’ve selected the northwind sample database. You will need to change the port assignment from the default 5432 to 5433. Just like a regular PostgreSQL server, password authentication for the postgres user is disabled, hence no password should be specified.

It’s always a good idea to test the connection before proceeding.

Database Navigator

After the connection is set up, you should be able to explore YugaByte DB (aka “PostgreSQL — northwind”) using the database navigator as shown below:

Working With the Northwind Sample Database

That’s it! You are ready to start exploring the northwind database running on a distributed SQL backend using DBeaver.

View Database Objects

By expanding out northwind > schemas > public > tables, you can quickly visualize all the tables in the northwind database.

Querying Data

You can quickly view and edit the data in a table by right-clicking on the table and selecting view data.

If you want to try your hand at writing your own SQL queries, you can do so by clicking on the SQL Editor button. You can now create, run, and view the results of your query in this window.

There’s a ton more development and administrative capabilities inside of DBeaver. Make sure to check out the DBeaver.io site to dig into how all their various features work.