DBeaver

DBeaver supports connecting to Databend using a built-in driver categorized under Analytical, available starting from version 24.3.1.

Prerequisites

• DBeaver 24.3.1 or later version installed
• For self-hosted Databend: Docker installed (if using Docker deployment)

User Authentication

If you are connecting to a self-hosted Databend instance, you can use the admin users specified in the databend-query.toml configuration file, or you can connect using an SQL user created with the CREATE USER command.

For connections to Databend Cloud, you can use the default cloudapp user or an SQL user created with the CREATE USER command. Please note that the user account you use to log in to the Databend Cloud console cannot be used for connecting to Databend Cloud.

Connecting to Self-Hosted Databend

1

Start Databend (Docker)

Run the following command to launch a Databend instance:

note

If no custom values for QUERY_DEFAULT_USER or QUERY_DEFAULT_PASSWORD are specified when starting the container, a default root user will be created with no password.

docker run -d --name databend \
  -p 3307:3307 -p 8000:8000 -p 8124:8124 -p 8900:8900 \
  datafuselabs/databend:nightly

2

Configure Connection

1. In DBeaver, go to Database > New Database Connection to open the connection wizard, then select Databend under the Analytical category.

2. Enter root for the Username (or your configured username).

3. Click Test Connection to verify the connection. If this is your first time connecting to Databend, you will be prompted to download the driver. Click Download to proceed.

Once the download is complete, the test connection should succeed:

Connecting to Databend Cloud

1

Obtain Connection Information

Log in to Databend Cloud to obtain connection information. For more information, see Connecting to a Warehouse.

note

If your user or password contains special characters, you need to provide them separately in the corresponding fields (e.g., the Username and Password fields in DBeaver). In this case, Databend will handle the necessary encoding for you. However, if you're providing the credentials together (e.g., as user:password), you must ensure that the entire string is properly encoded before use.

2

Configure Connection

1. In DBeaver, go to Database > New Database Connection to open the connection wizard, then select Databend under the Analytical category.

2. In the Main tab, enter the Host, Port, Username, and Password based on the connection information obtained in the previous step.

3. In the Driver properties tab, enter the Warehouse name based on the connection information obtained in the previous step.

4. In the SSL tab, select the Use SSL checkbox.

5. Click Test Connection to verify the connection. If this is your first time connecting to Databend, you will be prompted to download the driver. Click Download to proceed. Once the download is complete, the test connection should succeed: