DBeaver 社区版是一个免费的跨平台数据库工具，适用于开发人员、数据库管理员和数据分析师。DBeaver 支持所有流行的 SQL 数据库，如 MySQL、MariaDB、PostgreSQL、SQLite 系列等。

准备工作

• 请通过 官方网站 提前下载并安装好 DBeaver 。

  注意

  推荐使用 24.2.2 及以上版本的 DBeaver，以获得更好的兼容性。

• 您可以在 租户管理-参数设置 页面设置默认连接的计算组/数据库。
  

使用限制

• 建议在 ByteHouse 云数仓 2.2.0 以上版本使用 MySQL 方式连接，以获得更好体验。您可以在 ByteHouse 控制台-租户管理-基本信息 页面，查看当前服务版本号。
  
• 数据库用户功能为 Beta 功能，如需使用数据库用户连接，请联系提交工单或联系 ByteHouse 团队获取白名单权限。

连接到 ByteHouse

1. 点击 数据库 - 新建数据库连接，并在页面中选择 “ClickHouse”，单击 下一步。
   

2. 配置连接设置信息。
   

   参数	使用 IAM 用户连接	使用数据库用户连接
   主机	配置为 ByteHouse 的网络域名，您可以在 ByteHouse 控制台的租户管理>基本信息>网络信息中获取。详情请参见步骤二：配置网络信息。
   端口	数据库端口号，配置为固定取值：8123。
   用户名 & 密码	用户名默认为 bytehouse。 密码为 <API_Key>，可以在 ByteHouse 控制台>租户管理>连接信息中获取的 API Key。详情请参见获取 API Key。	用户名配置为 {accountID_or_accountName}::{username}[::{envID}]，详情请参见步骤三：获取 ByteHouse 连接串信息： accountID_or_accountName：指火山引擎用户账号 ID 或名称，可登录 ByteHouse 控制台，单击右上角个人中心查看并复制账号 ID 或名称。 username：登录 ByteHouse 数据库账号用户名。可在 ByteHouse 控制台>权限管理>用户>查看数据库用户名。 envID：可选配置，数据库所在的环境名称。如果使用 default 环境，可不配置，如需使用其他环境，需指定环境名称。您可登录 ByteHouse 控制台，在租户管理>基本信息>**当前环境 **中获取。 密码：数据库账号的密码由管理员创建数据库账号时自定义配置，您可联系管理员获取密码。如果密码丢失或遗忘，可通联系管理员重置密码，详情请参考重置密码。

3. 切换到 SSL 页面，启用SSL功能。
   

4. （可选）在驱动属性页签配置默认计算组。

   说明

   如果您有多个计算组，连接 ByteHouse 后使用的默认计算组，可参考本步骤设置默认计算组；如果不设置，则连接 ByteHouse 后使用控制台设置的默认计算组。

   

   • 设置 custom_settings 为 virtual_warehouse=your_virtualwarehouse_id。
   • 其中 your_virtualwarehouse_id 为连接 ByteHouse 后使用的默认计算组 ID，您可以在 ByteHouse 控制台的计算组页面查看对应计算组的 ID。

5. 单击左下角“测试连接”，若显示 已连接 则设置成功。
   

6. 单击 完成 ，即可在 DBeaver 程序主页中操作 ByteHouse 数据库。
   

常见问题：连接报错

如果您使用的 DBeaver 版本较新，可能会遇到以下报错：

您可通过配置 DBeaver 驱动管理器解决该问题，操作如下：

1. 下载 JDBC Driver v0.4.6 文件。
2. 在 DBeaver 中，通过数据库>驱动管理器路径，进入驱动管理器界面，单击 ClickHouse，单击编辑
   
3. 在编辑驱动界面，单击库页签。
   
4. 单击添加文件，上传步骤 1 中下载的 JDBC Driver v0.4.6 文件。
5. 选中 com.clickhouse:clickhouse-jdbc:RELEASE [0.x.x] ，单击删除。
6. 单击确定。