ByteHouse云数仓版
ByteHouse云数仓版
- 文档首页
ByteHouse云数仓版用户指南生态工具BI工具FineBI连接配置
文档反馈
问问助手本文介绍如何在 Fine BI 上安装不同的 ByteHouse 驱动，并完成连接配置。
ByteHouse 支持通过 IAM 用户或数据库用户连接 FineBI。IAM 用户与数据库用户二者差异说明如下，您可按需选择。
- IAM 用户为火山引擎访问控制（IAM）中创建的用户，其权限由 IAM 权限策略及您授予的 ByteHouse 资源和数据权限决定。IAM 用户可访问 ByteHouse 控制台，也支持通过 CLI、连接驱动、生态工具、API 等方式访问 ByteHouse。
- 数据库用户为 ByteHouse 中创建的数据库级别用户，可为其授予环境、资源和数据权限。数据库用户不可访问 ByteHouse 控制台，但支持通过 CLI、连接驱动、生态工具、API 等方式访问 ByteHouse。
更多 IAM 用户和数据库用户的介绍请参见以下文档：
已按照环境准备安装好 Fine BI，并配置好了数据源。
使用 IAM 用户连接 ByteHouse
驱动程序类 | 连接字符串 | 端口 Port | 其他配置 | |
|---|---|---|---|---|
MySQL JDBC Driver5 | 系统自带驱动 | 自动生成 | 3306 | Your_Database?enabledTLSProtocols=TLSv1.2,TLSv1.3 |
MySQL JDBC Driver8 |
| 自动生成 | 3306 | 无 |
ClickHouse JDBC Driver |
| jdbc:clickhouse://<host>:8123/<database_name>?user=bytehouse&password=<API_Key>&ssl=true&compress=0&server_version=54021&server_time_zone=Asia/Shanghai | 8123 | 无 |
ByteHouse JDBC Driver |
| jdbc:bytehouse://<host>:19000/<database_name>?user=bytehouse&password=<API_Key>&secure=true&compress=true | 19000 | 无 |
ByteHouse HTTP JDBC Driver |
| jdbc:clickhouse://<host>:8123/<database_name>?user=bytehouse&password=<API_Key>&ssl=true&compress=false&server_version=54021&server_time_zone=Asia/Shanghai | 8123 | 无 |
参数说明：
使用 IAM 账号连接时，通用参数配置详情如下，详情请参见步骤三：获取 ByteHouse 连接串信息。
<user>为bytehouse。<password>即 API Key，可在 ByteHouse 控制台 > 租户管理 > 连接信息中获取 API Key。详情请参见获取 API Key。<Host>配置为 ByteHouse 的公网连接域名，您可以在 ByteHouse 控制台的 租户管理 > 基本信息 > 网络信息中查看对应信息。详情请参见步骤二：配置网络信息。- SSL Tunnel：开启。
使用数据库用户连接 ByteHouse
驱动程序类 | 连接字符串 | 端口 Port | 其他配置 | |
|---|---|---|---|---|
MySQL JDBC Driver5 | 系统自带驱动 | 自动生成 | 3306 | Your_Database**?enabledTLSProtocols=TLSv1.2,TLSv1.3** |
MySQL JDBC Driver8 |
| 自动生成 | 3306 | 无 |
ClickHouse JDBC Driver |
| jdbc:clickhouse://<host>:8123/<database_name>?user={accountID_or_accountName}::{username}[::{envID}]&password= | 8123 | 无 |
ByteHouse JDBC Driver |
| jdbc:bytehouse://<host>:19000/<database_name>?user={accountID_or_accountName}::{username}[::{envID}]&password= | 19000 | 无 |
ByteHouse HTTP JDBC Driver |
| jdbc:clickhouse://<host>:8123/<database_name>?user={accountID_or_accountName}::{username}[::{envID}]&password= | 8123 | 无 |
参数说明：
使用数据库账号连接时，通用参数配置详情如下。
<user>由{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
- 配置环境 ID：
<password>即数据库账号的密码由管理员创建数据库账号时自定义配置，您可联系管理员获取密码。如果密码丢失或遗忘，可通联系管理员重置密码，详情请参考重置密码。<Host>配置为 ByteHouse 的公网连接域名，您可以在 ByteHouse 控制台的 租户管理 > 基本信息 > 网络信息中查看对应信息。详情请参见步骤二：配置网络信息。- SSL Tunnel：开启。
通过 MySQL JDBC Driver5 连接
- 登录 Fine BI 控制台，点击「管理系统>数据连接>数据连接管理>新建数据连接」可创建新的数据连接，选择系统自带的 MySQL 驱动。
- 根据 连接信息 中提供的配置信息，输入数据库对应的信息。
通过 MySQL JDBC Driver8 连接
- 登录 Fine BI 控制台，点击「管理系统 > 数据连接 > 数据连接管理 > 新建数据连接」可创建新的数据连接，选择之前已经定义好的数据库类型「MySQL」。
- 根据 连接信息 中提供的配置信息，输入数据库对应的信息。
通过 ClickHouse JDBC Driver 连接
- 登录 Fine BI 控制台，点击「管理系统 > 数据连接 > 数据连接管理 > 新建数据连接」可创建新的数据连接，选择之前已经定义好的数据库类型「ClickHouse」。
- 根据 连接信息 中提供的配置信息，输入数据库对应的信息。
通过 ByteHouse TCP JDBC Driver 连接
- 登录 Fine BI 控制台，点击「管理系统 > 数据连接 > 数据连接管理 > 新建数据连接」可创建新的数据连接，选择之前已经定义好的数据库类型「ByteHouse」。
- 根据 连接信息 中提供的配置信息，输入数据库对应的信息。
通过 ByteHouse HTTP JDBC Driver 连接
- 登录 Fine BI 控制台，点击「管理系统 > 数据连接 > 数据连接管理 > 新建数据连接」可创建新的数据连接，选择之前已经定义好的数据库类型「ByteHouseHTTP」。
- 根据 连接信息 中提供的配置信息，输入数据库对应的信息。