You need to enable JavaScript to run this app.
文档中心
ByteHouse云数仓版

ByteHouse云数仓版

复制全文
下载 pdf
Smartbi
连接配置
复制全文
下载 pdf
连接配置

本文介绍如何在 Smartbi 上安装不同的 ByteHouse 驱动,并完成连接配置。

背景信息

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

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

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

前提条件
  1. 已按照环境准备安装好 Smartbi,并为 ByteHouse 导入了数据。
  2. 获取用于连接 ByteHouse 的驱动程序,您可以选择以下其中一项:
    1. MySQL JDBC Driver (Smartbi 自带)
    2. ClickHouse JDBC Driver
    3. ByteHouse JDBC Driver:请使用最新版本。
    4. ClickHouse 数据源

配置驱动
  1. 按需准备以下驱动之一:
    1. ClickHouse JDBC Driver: 新建 Clickhouse 文件夹,并将对应的 JDBC Driver jar 文件拷贝到目录下。
    2. ByteHouse JDBC Driver: 新建 Bytehouse 文件夹,并将对应的 JDBC Driver jar 文件拷贝到目录下。
  2. 将需要使用驱动文件夹分别拷贝到以下目录下:
    • {Smartbi}/Tomcat/bin/dynamicLibraryPath
      Image
    • {Smartbi}/smartbiOLAP/dynamicLibraryPath
      Image

连接信息

使用 IAM 账号连接 ByteHouse

驱动程序类

连接字符串

驱动存放目录

MySQL JDBC Driver

com.mysql.jdbc.Driver

jdbc:mysql://<HOST>:3306/<database_name>?useOldAliasMetadataBehavior=true&useUnicode=true&characterEncoding=UTF8&zeroDateTimeBehavior=convertToNull&useCursorFetch=true&defaultFetchSize=-2147483648

自带

ClickHouse JDBC Driver

com.clickhouse.jdbc.ClickHouseDriver

jdbc:clickhouse://<host>:8123/<database_name>?user=bytehouse&password=<API_Key>&ssl=true&compress=0&server_version=54021&server_time_zone=Asia/Shanghai

ClickHouse

ByteHouse JDBC Driver

com.bytedance.bytehouse.jdbc.ByteHouseDriver

jdbc:bytehouse://<host>:19000/<database_name>?user=bytehouse&password=<API_Key>&secure=true&compress=true

ByteHouse

ClickHouse

ru.yandex.clickhouse.ClickHouseDriver

jdbc:clickhouse://:8123/<database_name>?socket_timeout=1000000&ssl=true&compress=0

参数说明:
使用 IAM 账号连接时,通用参数配置详情如下,详情请参见步骤三:获取 ByteHouse 连接串信息

  • bytehouse
  • 即 <API_Key>,可在 ByteHouse 控制台 > 租户管理 > 连接信息中获取 API Key。详情请参见获取 API Key
  • return (<Host> 配置为 ByteHouse 的网络域名,您可以在 ByteHouse 控制台的 **租户管理** > **基本信息** > **网络信息**中查看对应信息。详情请参见[步骤二:配置网络信息](/docs/6517/1121919#52c08d82)。
    )
  • SSL Tunnel:开启。

使用数据库账号连接 ByteHouse

驱动程序类

连接字符串

驱动存放目录

MySQL JDBC Driver

com.mysql.jdbc.Driver

jdbc:mysql://<HOST>:3306/<database_name>?useOldAliasMetadataBehavior=true&useUnicode=true&characterEncoding=UTF8&zeroDateTimeBehavior=convertToNull&useCursorFetch=true&defaultFetchSize=-2147483648

自带

ClickHouse JDBC Driver

com.clickhouse.jdbc.ClickHouseDriver

jdbc:clickhouse://<host>:8123/<database_name>?user={accountID_or_accountName}::{username}[::{envID}]&password=&ssl=true&compress=0&server_version=54021&server_time_zone=Asia/Shanghai

ClickHouse

ByteHouse JDBC Driver

com.bytedance.bytehouse.jdbc.ByteHouseDriver

jdbc:bytehouse://<host>:19000/<database_name>?user={accountID_or_accountName}::{username}[::{envID}]&password=&secure=true&compress=true

ByteHouse

ClickHouse

ru.yandex.clickhouse.ClickHouseDriver

jdbc:clickhouse://:8123/<database_name>?socket_timeout=1000000&ssl=true&compress=0

参数说明:
使用数据库账号连接时,通用参数配置详情如下。

  • {accountID_or_accountName}::{username}[::{envID}] 构成,详情请参见步骤三:获取 ByteHouse 连接串信息
    • {accountID_or_accountName}:指用户账号或名称,可登录 ByteHouse 控制台,单击右上角个人中心查看并复制账号ID 或名称。
    • {username}:登录 ByteHouse 数据库账号用户名。可在 ByteHouse 控制台 > 权限管理 > 用户 > 查看数据库用户名
    • {envID}:可选配置,数据库所在的环境名称。如果使用 default 环境,可不配置;如需使用其他环境,需指定环境名称,配置时无需添加[]。您可登录 ByteHouse 控制台,在租户管理 > 基本信息 > 当前环境中获取。
      使用示例如下:
      • 配置环境 ID:21xxxxxxxx::demouser::demoenv
      • 不配置环境 ID:21xxxxxxxx::demouser
  • 即数据库账号的密码由管理员创建数据库账号时自定义配置,您可联系管理员获取密码。如果密码丢失或遗忘,可通联系管理员重置密码,详情请参考重置密码
  • return (<Host>  配置为 ByteHouse 的网络域名,您可以在 ByteHouse 控制台的 **租户管理** > **基本信息** > **网络信息**中查看对应信息。详情请参见[步骤二:配置网络信息](/docs/6517/1121919#52c08d82)。
    )
  • SSL Tunnel:开启。

配置数据连接

通过 MySQL JDBC Driver 连接

  1. 登录 Smartbi 企业报表分析平台,选择 数据连接>关系数据库 ,点击 MySQL 图标进入数据库连接界面。如下图所示:
    Image
  2. 根据 连接信息 中提供的配置信息,输入数据库对应的信息。如下图所示:
    Image

通过 ClickHouse JDBC Driver 连接

  1. 登录 Smartbi 企业报表分析平台,选择 数据连接 > 所有数据库 ,点击 ByteHouse **** 图标进入数据库连接界面。如下图所示:
    Image
  2. 根据 连接信息 中提供的配置信息,输入数据库对应的信息。其中“选择驱动类型-自定义” 选 Clickhouse。如下图所示:
    Image

通过 ByteHouse TCP JDBC Driver 连接

  1. 登录 Smartbi 企业报表分析平台,选择 数据连接 > 所有数据库 ,点击 ByteHouse **** 图标进入数据库连接界面。如下图所示:
    Image
  2. 根据 连接信息 中提供的配置信息,输入数据库对应的信息。其中“选择驱动类型-自定义” 选 Bytehouse。如下图所示:

通过 ClickHouse 数据源直接连接

  1. 登录 Smartbi 企业报表分析平台,选择 数据连接 > 所有数据库 ,单击 ClickHouse 图标进入数据库连接界面。如下图所示:

  2. 根据 连接信息 中提供的配置信息,输入数据库对应的信息。其中“选择驱动程序” 选“产品内置”。如下图所示:
    Image

连接测试
  1. 信息正确输入后,点击 测试连接 ,若出现如下图的 测试通过 弹出框,则表示可以成功连接上数据库。如下图所示:
    Image
  2. 测试连接成功后,点击右下角的 保存 按钮,选择数据源的保存位置,保存成功后,该数据连接即添加成功。如下图所示:
    Image
  3. 数据库连接成功后,可以参考 Smartbi 官方快速入门使用数据查询和管理。
最近更新时间:2025.08.20 10:42:59
这个页面对您有帮助吗?
有用
有用
无用
无用