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

背景信息

ByteHouse 支持通过 IAM 用户或数据库用户连接 DBeaver。IAM 用户与数据库用户二者差异说明如下，您可按需选择。

• IAM 用户为火山引擎访问控制（IAM）中创建的用户，其权限由 IAM 权限策略及您授予的 ByteHouse 资源和数据权限决定。IAM 用户可访问 ByteHouse 控制台，也支持通过 CLI、连接驱动、生态工具、API 等方式访问 ByteHouse。
• 数据库用户为 ByteHouse 中创建的数据库级别用户，可为其授予环境、资源和数据权限。数据库用户不可访问 ByteHouse 控制台，但支持通过 CLI、连接驱动、生态工具、API 等方式访问 ByteHouse。

更多 IAM 用户和数据库用户的介绍请参见以下文档：

• ByteHouse权限管控概述
• 管理 IAM 用户
• 管理数据库用户

准备工作

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

   注意

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

2. 点击 这里 获取 ByteHouser JDBC Driver 最新版本的 jar 文件。
3. 您可以在 租户管理-参数设置 页面设置默认连接的计算组/数据库。
   

配置 ByteHouse 驱动

1. 启动 DBeaver，在 数据库 页签下，选择 驱动管理器 。
   
2. 点击“新建”。
   
3. 在设置页签下，如图输入以下连接信息：
   
   • 类名： com.bytedance.bytehouse.jdbc.ByteHouseDriver。
   • URL 模板： jdbc:bytehouse://{host}:{port}/?secure=true。其中，{HOST}:{PORT}字段取决于集群所在区域，请参见步骤二：配置网络信息获取相关信息。
   • 默认端口：19000。
4. 切换到”库“页签，单击 添加文件，选择前面准备的 ByteHouse JDBC Driver 文件。
   
5. 切换到”高级参数“页签下，将下图中的两项配置去掉勾选。

6. 点击确定保存。

连接到 ByteHouse

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

2. 填写以下连接信息字段：
   

   参数	使用 IAM 用户连接	使用数据库用户连接
   主机	配置为 ByteHouse 的网络域名，您可以在 ByteHouse 控制台的租户管理 > 基本信息 > 网络信息中获取。详情请参见步骤二：配置网络信息。
   端口	数据库端口号，配置为固定取值：19000。
   用户名 & 密码	用户名默认为 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 控制台，在租户管理 > 基本信息 > 当前环境中获取。 使用示例如下： 配置环境 ID：21xxxxxxxx::demouser::demoenv 不配置环境 ID：21xxxxxxxx::demouser 密码：数据库账号的密码由管理员创建数据库账号时自定义配置，您可联系管理员获取密码。如果密码丢失或遗忘，可通联系管理员重置密码，详情请参考重置密码。

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

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