DataGrip（TCP）--ByteHouse云数仓版-火山引擎

文档中心

导航

DataGrip（TCP）

最近更新时间：2025.06.12 18:11:04首次发布时间：2023.08.10 17:06:41

DataGrip 是 JetBrains 公司专为数据库开发人员和管理员设计的一套集成开发环境（IDE）。它支持各种数据库管理系统，提供智能代码完成，并便于版本控制集成。
本文将介绍 DataGrip 如何通过 JDBC 驱动，以 TCP 的方式来连接 ByteHouse 云数仓版。

注意

当前 TCP 模式下不支持分页，如果在工具中预览数据且数据量较大的情况预览将会比较慢。
这种情况下建议使用 HTTP 协议的方式进行连接，参考DataGrip（ClickHouse）。

使用限制

数据库用户功能为 Beta 功能，如需使用数据库用户连接，请联系提交工单或联系 ByteHouse 团队获取白名单权限。

前提条件

请提前安装好 DataGrip ，并获得相应的商用授权。
点击这里获取 ByteHouser JDBC Driver 最新版本的 jar 文件。
您可以在 租户管理-参数设置 页面设置默认连接的计算组/数据库。

使用限制

当使用 Bytehouse JDBC TCP 驱动程序进行连接时，设置项 max_result_rows可能不生效。因此，分页功能没有得到很好的支持。预期返回的行可能与实际返回的行不同。

可以通过在 DataGrip 上进行如下设置可以解决此问题：

进入DataGrip-设置-数据库-数据编辑器和查看器页签。
将限制的第一项“将页面大小限制为”选项去掉勾选。
单击确定按钮保存设置。

使用 DataGrip 连接 ByteHouse

启动 DataGrip，在数据库资源管理器页签单击 + 图标，选择驱动程序。
自定义驱动名称，如“ByteHouse JDBC Driver"。 单击驱动程序文件中的 + 号，在弹出的窗口中选择自定义 JAR，选择本地下载好的 JDBC 驱动 jar文件。
在类中选择 com.bytedance.bytehouse.jdbc.ByteHouseDriver，单击应用保存。
在数据库资源管理器页签单击 + 图标，选择数据源 -> ByteHouse JDBC Driver*。*

配置数据源连接信息。您可以使用 IAM 用户或数据库用户连接，配置参数说明见下表。

参数	使用 IAM 用户连接	使用数据库用户连接
名称	自定义连接名称。
用户名&密码	登录 ByteHouse 数据库的用户名和密码。用户名默认为 `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 控制台，在租户管理>基本信息>当前环境中获取。密码：数据库账号的密码由管理员创建数据库账号时自定义配置，您可联系管理员获取密码。如果密码丢失或遗忘，可通联系管理员重置密码，详情请参考重置密码。
URL	字段格式如下： `jdbc:bytehouse://{HOST}:{PORT}/?secure=true&user=bytehouse&password={API_KEY}` `{HOST}`：配置为 ByteHouse 的网络域名，您可以在 ByteHouse 控制台的租户管理>基本信息>网络信息中查看对应信息。详情请参见步骤二：配置网络信息。 `{PORT}`：配置为 19000。	字段格式如下： `jdbc:bytehouse://{HOST}:{PORT}/?secure=true&user={accountID_or_accountName}::{username}[::{envID}]&password={password}` `{HOST}`：配置为 ByteHouse 的网络域名，您可以在 ByteHouse 控制台的租户管理>基本信息>网络信息中查看对应信息。详情请参见步骤二：配置网络信息。 `{PORT}`：配置为 19000。

参数

使用 IAM 用户连接

使用数据库用户连接

名称

自定义连接名称。

用户名&密码

用户名默认为 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 控制台，在租户管理>基本信息>**当前环境 **中获取。
密码：数据库账号的密码由管理员创建数据库账号时自定义配置，您可联系管理员获取密码。如果密码丢失或遗忘，可通联系管理员重置密码，详情请参考重置密码。

URL

字段格式如下：

jdbc:bytehouse://{HOST}:{PORT}/?secure=true&user=bytehouse&password={API_KEY}

{HOST}：配置为 ByteHouse 的网络域名，您可以在 ByteHouse 控制台的 租户管理>基本信息>网络信息 中查看对应信息。详情请参见步骤二：配置网络信息。
{PORT}：配置为 19000。

字段格式如下：

jdbc:bytehouse://{HOST}:{PORT}/?secure=true&user={accountID_or_accountName}::{username}[::{envID}]&password={password}

{HOST}：配置为 ByteHouse 的网络域名，您可以在 ByteHouse 控制台的 租户管理>基本信息>网络信息 中查看对应信息。详情请参见步骤二：配置网络信息。
{PORT}：配置为 19000。

单击测试连接，显示“成功”则可正常连接。
说明
因第三方软件对 URL 中 Password 字段包含特殊字符识别可能带来差异，如果您按上方正确设置后仍无法正确连接，请尝试在 Password 密码框中手动填写密码后再次测试连接。

参考

要了解有关 DataGrip 的更多信息，请访问 DataGrip官方文档。