DBeaver 社区版是一个免费的跨平台数据库工具,适用于开发人员、数据库管理员和数据分析师。DBeaver 支持所有流行的SQL数据库,如 MySQL、MariaDB、PostgreSQL、SQLite 系列等。
准备工作
- 请通过 官方网站 提前下载并安装好 DBeaver 。
注意
推荐使用 24.2.2 及以上版本的 DBeaver,以获得更好的兼容性。
- 您可以在 租户管理-参数设置 页面设置默认连接的计算组/数据库。

使用限制
数据库用户功能为 Beta 功能,如需使用数据库用户连接,请联系提交工单或联系 ByteHouse 团队获取白名单权限。
连接到 ByteHouse
点击 数据库 - 新建数据库连接,并在页面中选择 “MySQL”,单击 下一步。

填写以下字段:

参数 | 使用 IAM 用户连接 | 使用数据库用户连接 |
---|
Server Host | 配置为 ByteHouse 的网络域名,您可以在 ByteHouse 控制台的租户管理>基本信息>网络信息中获取。详情请参见步骤二:配置网络信息。 |
Port | 数据库端口号,配置为固定取值:3306。 |
Username & Password | 【推荐】方式一:
使用 API Key 作为 Username 和 Password。详情请参见获取 API Key。 - Username 为 API Key 的前半部分,比如获取的 API Key xxxx.yyyy,则 User 需填写 xxxx。
- Password 为 API Key 的前半部分,比如获取的 API Key xxxx.yyyy,则 User 需填写 yyyy。
方式二: - Username 默认为
bytehouse 。 - Password 为 <API_Key>,可以在 ByteHouse 控制台>租户管理>连接信息中获取的 API Key。详情请参见获取 API Key。
| - Username 配置为
{accountID_or_accountName}::{username}[::{envID}] ,详情请参见步骤三:获取 ByteHouse 连接串信息:
- accountID_or_accountName:指火山引擎用户账号 ID 或名称,可登录 ByteHouse 控制台,单击右上角个人中心查看并复制账号 ID 或名称。
- username:登录 ByteHouse 数据库账号用户名。可在 ByteHouse 控制台>权限管理>用户>查看数据库用户名。
- envID:可选配置,数据库所在的环境名称。如果使用 default 环境,可不配置,如需使用其他环境,需指定环境名称。您可登录 ByteHouse 控制台,在租户管理>基本信息>**当前环境 **中获取。
- Password:数据库账号的密码由管理员创建数据库账号时自定义配置,您可联系管理员获取密码。如果密码丢失或遗忘,可通联系管理员重置密码,详情请参考重置密码。
|
切换到 SSL 页面,启用 SSL 功能,勾选“启用SSL”、“要求SSL”,去勾选“验证服务器证书”。
单击左下角“测试连接”,若显示 已连接 则设置成功。

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