导航
DBeaver（TCP）
最近更新时间：2025.06.12 18:11:04首次发布时间：2023.09.12 16:58:48
DBeaver 社区版是一个免费的跨平台数据库工具，适用于开发人员、数据库管理员和数据分析师。DBeaver 支持所有流行的SQL数据库，如 MySQL、MariaDB、PostgreSQL、SQLite 系列等。
说明
当前 TCP 模式下不支持分页，如果在工具中预览数据且数据量较大的情况预览将会比较慢。
这种情况下建议使用 HTTP 协议的方式进行连接，参考DBeaver（ClickHouse）。
使用限制
数据库用户功能为 Beta 功能，如需使用数据库用户连接，请联系提交工单或联系 ByteHouse 团队获取白名单权限。
准备工作
- 请通过 官方网站 提前下载并安装好 DBeaver 。
注意
推荐使用 24.2.2 及以上版本的 DBeaver，以获得更好的兼容性。
- 点击 这里 获取 ByteHouser JDBC Driver 最新版本的 jar 文件。
- 您可以在 租户管理-参数设置 页面设置默认连接的计算组/数据库。
配置 ByteHouse 驱动
- 启动 DBeaver，在 数据库 页签下，选择 驱动管理器 。
- 点击“新建”。
- 在设置页签下，如图输入以下连接信息：
- 类名：
com.bytedance.bytehouse.jdbc.ByteHouseDriver。 - URL 模板：
jdbc:bytehouse://{host}:{port}/?secure=true。其中，{HOST}:{PORT}字段取决于集群所在区域，请参见步骤二：配置网络信息获取相关信息。 - 默认端口：
19000。
- 类名：
- 切换到”库“页签，单击 添加文件，选择前面准备的 ByteHouse JDBC Driver 文件。
- 切换到”高级参数“页签下，将下图中的两项配置去掉勾选。
注意
如果忽略此项，查询行数较多的表时可能会出现报错，如：SQL错误[396]: DB::ExceptionDB::Exception: Limit for result exceeded, max rows: 200.00, current rows: 8.19 thousand SQLSTATE: 54000. Stack trace:...
6. 点击确定保存。
连接到 ByteHouse
点击 数据库 - 新建数据库连接，并在页面中选择 “ByteHouse”，单击 下一步。
填写以下连接信息字段：
参数
使用 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 控制台，在租户管理>基本信息>**当前环境 **中获取。
- 密码：数据库账号的密码由管理员创建数据库账号时自定义配置，您可联系管理员获取密码。如果密码丢失或遗忘，可通联系管理员重置密码，详情请参考重置密码。
- 用户名默认为
单击左下角“测试连接”，若显示 已连接 则设置成功。
单击 完成 ，即可在 DBeaver 程序主页中操作 ByteHouse 数据库。