You need to enable JavaScript to run this app.
导航
Sugar BI
最近更新时间:2025.08.20 10:42:59首次发布时间:2024.08.14 17:34:07
复制全文
我的收藏
有用
有用
无用
无用

Sugar BI 支持以公网的方式连接 ByteHouse,连接成功后,您可以在 Sugar BI 上上进行数据的分析与展示。本文为您介绍如何在Sugar BI 中添加 ByteHouse 数据源。

背景信息

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

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

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

前提条件

获取 ByteHouse 的连接信息,请参考获取 ByteHouse 连接信息

操作步骤

  1. 登录 Sugar BI 控制台,从创建数据源入口进入添加数据源界面。
    Image

  2. 选择公网连接类型,在配置连接对话框,您可以根据业务场景,完成以下配置。
    Image

    参数

    使用 IAM 用户连接

    使用数据库用户连接

    数据源

    选择 ClickHouse。

    数据源名称

    数据源配置列表的显示名称。请输入规范的名称,不要使用特殊字符,前后不能包含空格。

    数据库地址

    部署 ByteHouse 数据库的地址,即 地址,请参考步骤二:配置网络信息

    端口

    数据库的对应的端口号,默认为 8123

    数据库

    部署 ByteHouse 数据库时自定义的数据库名称。

    用户名密码

    • 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 控制台,在租户管理 > 基本信息 > 当前环境中获取。
        使用示例如下:
        • 配置环境 ID:21xxxxxxxx::demouser::demoenv
        • 不配置环境 ID:21xxxxxxxx::demouser
    • password:数据库账号的密码由管理员创建数据库账号时自定义配置,您可联系管理员获取密码。如果密码丢失或遗忘,可通联系管理员重置密码,详情请参考重置密码
  3. 单击连接测试,进行数据源连通性测试。
    Image

  4. 测试成功后单击确定,完成数据源添加。

  5. 创建数据源后,单击预览数据,您将能够看到表格和示例数据。
    Image