How to Connect to a ClickHouse Server Using DBeaver: Step-by-Step Guide?

  

If you're working with ClickHouse, a fast open-source columnar database management system, and want to use a user-friendly SQL client for querying and exploring your data, DBeaver is a great choice.

 

This post will walk you through the step-by-step process to connect your local ClickHouse server with DBeaver.

 

Prerequisites

Before we begin, make sure you have the following installed:

·      DBeaver (Community or Enterprise Edition)

·      A running instance of ClickHouse (either local or remote)

 

Step-by-Step Procedure to Connect ClickHouse with DBeaver

1. Launch DBeaver

Open DBeaver on your machine.

 

2. Start a New Database Connection

Navigate to the top menu:

File →New

 

In the "Select a wizard" window, choose Database Connection and click on the Next button.

 

3. Search for ClickHouse Driver

In the "Connect to a database" screen, type clickhouse in the search bar. Select the ClickHouse option from the list.

 

Click Next.

 

4. Configure Connection Details

Fill in the connection settings as follows:

 

·      Host: localhost (or your ClickHouse server IP/hostname)

·      Port: 8123 (default ClickHouse HTTP port)

·      Database/Schema: Leave this blank if you're unsure, it connect to default database by default

·      Username/Password: Leave blank if no credentials are configured. Otherwise, enter your configured ClickHouse username and password

 

Click Finish to proceed.

 

5. Download the ClickHouse Driver

Once the connection is added, the instance details are added in DBeaver left navigation bar. Click on the Clickhouse instance and try to expand, DBeaver will automatically attempt to download the required JDBC drivers.

 

A "Driver Settings" window will appear. Click on the Download button to fetch the drivers.

 

Note: This step is only required the first time you connect to ClickHouse using DBeaver.

 

6. Explore Your Database

After successful driver download and authentication, your ClickHouse instance will appear in the Database Navigator panel on the left. Expand it to browse tables, run queries, and interact with your data.

 

Right click on the Clickhouse server -> SQL Editor -> Open SQL script.

 

It opens ‘Choose SQL script’ window, click on New script button.

 

Execute following statement to list all the databases.

SHOW DATABASES;

 

   

You now have a fully functional connection to ClickHouse through DBeaver. You can:

·      Write and execute SQL queries

·      Explore databases, tables, and columns

·      Export data or generate ER diagrams

 

 

 

Previous                                                    Next                                                    Home