DBeaver Documentation

DOWNLOAD pdf

Clickhouse

Note: This driver is available in Lite, Enterprise, Ultimate and Team editions only.

Overview

This guide provides instructions on how to set up and use ClickHouse with DBeaver.

Before you start, you must create a connection in DBeaver and select ClickHouse. If you have not done this, please refer to our Database Connection article.

DBeaver interacts with the ClickHouse server using a specific driver. It supports all versions of ClickHouse, but the correct driver must be selected: use ClickHouse (Legacy) for driver version 21.3 and earlier, and ClickHouse for driver version 21.3 and later. If you have not yet created a connection in DBeaver, please refer to our Creating a Connection article for guidance.

Setting up

This section provides an overview of DBeaver's settings for establishing a direct connection and the configuration of secure connections using SSH, proxies, SSL, and the setup of ODBC/JDBC drivers for ClickHouse.

ClickHouse connection settings

In this subsection, we will outline the settings for establishing a direct connection to a ClickHouse database using DBeaver. Correctly configuring your connection ensures seamless interaction between DBeaver and your ClickHouse database.

The page of the connection settings requires you to fill in specific fields to establish the initial connection.

Field Description
Connect by (Host/URL) Choose whether you want to connect using a host or a URL.
Driver Type Select the appropriate driver for your ClickHouse database.
JDBC URL If you are connecting via URL, enter the URL of your ClickHouse database here. This field is disabled if you're connecting via the host.
Host If you are connecting via Host, enter the host address of your ClickHouse database here.
Database/Schema Enter the name of the ClickHouse database you want to connect to.
Port Enter the port number for your ClickHouse database. The default ClickHouse port is 8123.
Authentication Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles:

- Native Database Authentication
- DBeaver Profile Authentication

You can also read about security in DBeaver PRO.
Connection Details Provide additional connection details if necessary.
Driver Name This field will be auto-filled based on your selected driver type.
Driver Settings If there are any specific driver settings, configure them here.

Connection details

The Connection Details section in DBeaver allows you to customize your experience while working with ClickHouse database. This includes options for adjusting the Navigator View, setting up Security measures, applying Filters, configuring Connection Initialization settings, and setting up Shell Commands. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles:

ClickHouse driver properties

The settings for ClickHouse Driver properties enable you to adjust the performance of ClickHouse ClickHouse JDBC and ODBC driver. These adjustments can influence the efficiency, compatibility, and features of your ClickHouse database.

For a complete walkthrough on setting up ClickHouse JDBC and ODBC drivers properties, you can refer to the official ClickHouse JDBC documentation and ClickHouse ODBC documentation. These guides detail each driver's properties and how they can be used to optimize ClickHouse database connections.

You can customize the ClickHouse driver in DBeaver via the Edit Driver page, accessible by clicking on the Driver Settings button on the first page of the driver settings. This page offers a range of settings that can influence your ClickHouse database connections. For a comprehensive guide on these settings, please refer to our Database drivers article.

ODBC and JDBC driver configuration

DBeaver provides extensive capabilities for managing ClickHouse database connections via ODBC/JDBC drivers. This functionality enables you to connect to your ClickHouse database using native ODBC drivers, offering an alternative when specific DBeaver drivers are not available.

This process is similar across most databases that support ODBC/JDBC drivers. For a comprehensive, step-by-step guide on how to install the driver manager, set up drivers, configure data sources, and establish connections in DBeaver, you can refer to our ODBC Driver Configuration article.

Secure connection configurations

DBeaver supports secure connections to your ClickHouse database. Guidance on configuring such connections, specifically SSH, Proxy, Kubernetes, and SSL connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles:

Powering ClickHouse with DBeaver

DBeaver provides a host of features designed for ClickHouse databases. This includes the ability to view and manage databases, along with numerous unique capabilities aimed at optimizing database operations.

ClickHouse database objects

DBeaver lets you view and manipulate a wide range of ClickHouse database objects. DBeaver has extensive support for various ClickHouse metadata types, allowing you to interact with a wide variety of database objects, such as:

  • Schemas

    • Tables
      • Columns
    • Views
    • Procedures

ClickHouse features in DBeaver

DBeaver is not limited to typical SQL tasks. It also includes numerous unique features specifically for ClickHouse. Beyond regular SQL operations, DBeaver provides a range of ClickHouse-specific capabilities, such as:

Category Feature
Data Types ClickHouse data types such as Nested and Array
Database Management ClickHouse Procedures

Additional features compatible with ClickHouse, but not exclusive to it:

Category Feature
Data Transfer Data Import
Data Export
Schema Management Schema Compare
Mock Data Generation Mock data generation guide
Data Visualization Query Execution plan

Note: As a column-oriented database management system, ClickHouse does not include support for referential integrity, such as foreign keys. This particular limitation means that Entity-Relationship (ER) diagrams, which are typically valuable in visualizing and enforcing database relationships, become less applicable and effective in the context of ClickHouse databases.

Did we resolve your issue?