DBeaver Community Edition is a free cross-platform Database tool for developers, administrators, and Data Analysts. DBeaver supports all popular SQL databases, such as MySQL, MariaDB, PostgreSQL, SQLite, and others.

Prerequisites #

• Please download and install DBeaver ahead of time through the official website.

• You can set the default connection compute group/Database on the Tenant manage-Parameter setting Page.
  

Usage Limitations #

It is recommended to use MySQL to connect with ByteHouse Cloud Data Warehouse versions above 2.2.0 for a better experience. You can see the current Service Version number on the ByteHouse Console-Tenant management Page.

Connect to ByteHouse #

1. Click Database - New Database Connection, select "MySQL" on the page, and click Next.
   
2. Fill in the following fields:
   1. Host, Port: Depending on the region where the cluster is located, refer to 支持的地域及可用区Get.
   2. Username: Default is bytehouse.
   3. Password: That is <API_KEY>, refer to 获取 API Key.

3. Switch to the SSL page, activate the SSL function, check "Activate SSL" "Require SSL", and uncheck "Verify server certificate".

4. Click on the lower left "test connection", if it displays Connected then the setup is successful.

5. Click Complete, you can then operate the ByteHouse database on the DBeaver homepage.