> ## Documentation Index
> Fetch the complete documentation index at: https://clickhouse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> Databrain 是一个嵌入式分析平台，可与 ClickHouse 无缝集成，用于构建面向客户的仪表盘、指标和数据可视化。

# 将 Databrain 连接到 ClickHouse

export const CommunityMaintainedBadge = () => {
  return <div className="CommunityMaintainedBadge">
            <div className="CommunityMaintainedIcon">
            <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" fill="currentColor" viewBox="0 0 256 256">
                <path d="M244.8,150.4a8,8,0,0,1-11.2-1.6A51.6,51.6,0,0,0,192,128a8,8,0,0,1-7.37-4.89,8,8,0,0,1,0-6.22A8,8,0,0,1,192,112a24,24,0,1,0-23.24-30,8,8,0,1,1-15.5-4A40,40,0,1,1,219,117.51a67.94,67.94,0,0,1,27.43,21.68A8,8,0,0,1,244.8,150.4ZM190.92,212a8,8,0,1,1-13.84,8,57,57,0,0,0-98.16,0,8,8,0,1,1-13.84-8,72.06,72.06,0,0,1,33.74-29.92,48,48,0,1,1,58.36,0A72.06,72.06,0,0,1,190.92,212ZM128,176a32,32,0,1,0-32-32A32,32,0,0,0,128,176ZM72,120a8,8,0,0,0-8-8A24,24,0,1,1,87.24,82a8,8,0,1,0,15.5-4A40,40,0,1,0,37,117.51,67.94,67.94,0,0,0,9.6,139.19a8,8,0,1,0,12.8,9.61A51.6,51.6,0,0,1,64,128,8,8,0,0,0,72,120Z"></path>
            </svg>
        </div>
            由社区维护
        </div>;
};

export const Image = ({img, alt, size = "lg"}) => {
  const normalizedSize = ["sm", "md", "lg"].includes(size) ? size : "lg";
  return <div className={`ch-image-${normalizedSize}`}>
      <Frame>
        <img src={img} alt={alt} />
      </Frame>
    </div>;
};

<CommunityMaintainedBadge />

[Databrain](https://usedatabrain.com) 是一个嵌入式分析平台，可让您构建并与客户共享交互式仪表盘、指标和数据可视化内容。Databrain 通过 HTTPS 接口连接到 ClickHouse，让您能够借助现代化、易于使用的界面，轻松可视化和分析 ClickHouse 数据。

<Image size="md" img="https://mintcdn.com/private-7c7dfe99/PWQnWTwcu17exYX2/images/integrations/data-visualization/databrain_01.webp?fit=max&auto=format&n=PWQnWTwcu17exYX2&q=85&s=80e4fec7929d62f4a07f36d009cd8d37" alt="显示 ClickHouse 数据可视化的 Databrain 仪表盘界面" border width="3408" height="1820" data-path="images/integrations/data-visualization/databrain_01.webp" />

<br />

本指南将逐步介绍如何将 Databrain 连接到您的 ClickHouse 实例。

<div id="pre-requisites">
  ## 前提条件
</div>

* 一个部署在您自有基础设施上或 [ClickHouse Cloud](https://clickhouse.com/) 上的 ClickHouse 数据库。
* 一个 [Databrain 账户](https://app.usedatabrain.com/users/sign-up)。
* 一个用于连接数据源的 Databrain 工作区。

<div id="steps-to-connect-databrain-to-clickhouse">
  ## 将 Databrain 连接到 ClickHouse 的步骤
</div>

<Steps>
  <Step title="收集连接信息" id="1-gather-your-connection-details">
    要通过 HTTP(S) 连接到 ClickHouse，你需要以下信息：

    | Parameter(s)              | Description                                |
    | ------------------------- | ------------------------------------------ |
    | `HOST` and `PORT`         | 通常，使用 TLS 时端口为 8443；不使用 TLS 时端口为 8123。     |
    | `DATABASE NAME`           | 默认情况下，存在一个名为 `default` 的数据库。请使用你要连接的数据库名称。 |
    | `USERNAME` and `PASSWORD` | 默认情况下，用户名为 `default`。请根据你的使用场景使用相应的用户名。    |

    你的 ClickHouse Cloud 服务的连接信息可在 ClickHouse Cloud 控制台中查看。
    选择一个服务，然后点击 **Connect**：

    <div className="ch-image-md">
      <Frame>
        <img src="https://mintcdn.com/private-7c7dfe99/CFFsa2agBPbviR4r/images/_snippets/cloud-connect-button.webp?fit=max&auto=format&n=CFFsa2agBPbviR4r&q=85&s=ec0a298a33ca841e947fa5e8bae47362" alt="ClickHouse Cloud 服务连接按钮" width="998" height="932" data-path="images/_snippets/cloud-connect-button.webp" />
      </Frame>
    </div>

    选择 **HTTPS**。连接信息会显示在示例 `curl` 命令中。

    <div className="ch-image-md">
      <Frame>
        <img src="https://mintcdn.com/private-7c7dfe99/CFFsa2agBPbviR4r/images/_snippets/connection-details-https.webp?fit=max&auto=format&n=CFFsa2agBPbviR4r&q=85&s=cb0fbd98aa2b5b7ca484c9f53395ee07" alt="ClickHouse Cloud HTTPS 连接信息" width="1320" height="1184" data-path="images/_snippets/connection-details-https.webp" />
      </Frame>
    </div>

    如果你使用的是自管理 ClickHouse，则连接信息由你的 ClickHouse 管理员配置。
  </Step>

  <Step title="允许 Databrain IP 地址（如有需要）" id="2-allow-databrain-ip-addresses">
    如果您的 ClickHouse 实例启用了 IP filtering，则需要将 Databrain 的 IP 地址加入白名单。

    对于 ClickHouse Cloud 用户：

    1. 在 ClickHouse Cloud 控制台中导航到您的 service
    2. 前往 **Settings** → **Security**
    3. 将 Databrain 的 IP 地址添加到 allow list

    <Tip>
      当前需要加入白名单的 IP 地址列表，请参阅 [Databrain 的 IP 白名单文档](https://docs.usedatabrain.com/guides/datasources/allow-access-to-our-ip)。
    </Tip>
  </Step>

  <Step title="在 Databrain 中将 ClickHouse 添加为数据源" id="3-add-clickhouse-as-a-data-source">
    1. 登录 Databrain 账户，并进入要添加数据源的工作区。

    2. 在导航菜单中点击 **Data Sources**。

    <Image size="md" img="https://mintcdn.com/private-7c7dfe99/PWQnWTwcu17exYX2/images/integrations/data-visualization/databrain_02.webp?fit=max&auto=format&n=PWQnWTwcu17exYX2&q=85&s=afa8be9262fbc8bace0e29c3446925a8" alt="Databrain 数据源菜单" border width="3420" height="1830" data-path="images/integrations/data-visualization/databrain_02.webp" />

    3. 点击 **Add a Data Source** 或 **Connect Data Source**。

    4. 在可用连接器列表中选择 **ClickHouse**。

    <Image size="md" img="https://mintcdn.com/private-7c7dfe99/PWQnWTwcu17exYX2/images/integrations/data-visualization/databrain_03.webp?fit=max&auto=format&n=PWQnWTwcu17exYX2&q=85&s=55c156b47f08a4bc2c9b8e2b2eb50078" alt="显示 ClickHouse 选项的 Databrain 连接器选择界面" border width="1920" height="917" data-path="images/integrations/data-visualization/databrain_03.webp" />

    5. 填写连接信息：
       * **Destination Name**：为此连接输入一个便于识别的名称 (例如："Production ClickHouse" 或 "Analytics DB")
       * **Host**：输入 ClickHouse 主机 URL (例如：`https://your-instance.region.aws.clickhouse.cloud`)
       * **Port**：输入 `8443` (ClickHouse 默认的 HTTPS 端口)
       * **Username**：输入 ClickHouse 用户名
       * **Password**：输入 ClickHouse 密码

    <Image size="md" img="https://mintcdn.com/private-7c7dfe99/PWQnWTwcu17exYX2/images/integrations/data-visualization/databrain_04.webp?fit=max&auto=format&n=PWQnWTwcu17exYX2&q=85&s=b2b574e85c4094bde4df8260aa5a969a" alt="Databrain ClickHouse 连接表单，显示配置字段" border width="1917" height="914" data-path="images/integrations/data-visualization/databrain_04.webp" />

    6. 点击 **Test Connection**，验证 Databrain 是否可以连接到您的 ClickHouse 实例。

    7. 连接成功后，点击 **Save** 或 **Connect** 以添加数据源。
  </Step>

  <Step title="配置用户权限" id="4-configure-user-permissions">
    确保您用于连接的 ClickHouse 用户具有所需权限：

    ```sql theme={null}
    -- 授予读取 schema 信息的权限
    GRANT SELECT ON information_schema.* TO your_databrain_user;

    -- 授予对您的 database 和表的只读权限
    GRANT SELECT ON your_database.* TO your_databrain_user;
    ```

    将 `your_databrain_user` 和 `your_database` 替换为您的实际用户名和数据库名称。
  </Step>
</Steps>

<div id="using-databrain-with-clickhouse">
  ## 将 Databrain 与 ClickHouse 配合使用
</div>

<div id="explore-your-data">
  ### 探索您的数据
</div>

1. 连接后，前往 Databrain 中的工作区。

2. 您会在数据浏览器中看到列出的 ClickHouse 表。

<Image size="md" img="https://mintcdn.com/private-7c7dfe99/PWQnWTwcu17exYX2/images/integrations/data-visualization/databrain_05.webp?fit=max&auto=format&n=PWQnWTwcu17exYX2&q=85&s=5b9a984052f45b47abb2d2e32f0b8479" alt="显示 ClickHouse 表的 Databrain 数据浏览器" border width="1919" height="920" data-path="images/integrations/data-visualization/databrain_05.webp" />

3. 点击某个表以查看其 schema 并预览数据。

<div id="create-metrics-and-visualizations">
  ### 创建指标和可视化
</div>

1. 点击 **Create Metric**，开始基于 ClickHouse 数据构建可视化。

2. 选择 ClickHouse 数据源，并选择要可视化的表。

3. 使用 Databrain 的直观界面来：
   * 选择维度和度量
   * 应用过滤器和聚合
   * 选择可视化类型 (柱状图、折线图、饼图、表等)
   * 添加自定义 SQL 查询以进行高级分析

4. 保存指标，以便在各个仪表盘中重复使用。

<div id="build-dashboards">
  ### 创建仪表盘
</div>

1. 点击 **Create Dashboard** 开始创建仪表盘。

2. 通过拖放已保存的指标，将其添加到仪表盘中。

3. 自定义仪表盘的布局和外观。

<Image size="md" img="https://mintcdn.com/private-7c7dfe99/PWQnWTwcu17exYX2/images/integrations/data-visualization/databrain_06.webp?fit=max&auto=format&n=PWQnWTwcu17exYX2&q=85&s=54ce6587126ab9eb24a8c7a2dac0fac0" alt="包含多个 ClickHouse 可视化图表的 Databrain 仪表盘" border width="1918" height="888" data-path="images/integrations/data-visualization/databrain_06.webp" />

4. 与团队共享仪表盘，或将其嵌入到应用程序中。

<div id="advanced-features">
  ### 高级功能
</div>

Databrain 在与 ClickHouse 配合使用时提供多项高级功能：

* **自定义 SQL 控制台**：直接针对你的 ClickHouse 数据库编写并执行自定义 SQL 查询
* **多租户和单租户**：连接你的 ClickHouse 数据库，支持单租户和多租户架构
* **报告调度**：安排自动生成报告，并通过电子邮件发送给相关人员
* **AI 驱动的洞察**：使用 AI 从你的数据中生成摘要和洞察
* **嵌入式分析**：将仪表盘和指标直接嵌入你的应用程序
* **语义层**：创建可复用的数据模型和业务逻辑

<div id="troubleshooting">
  ## 故障排查
</div>

<div id="connection-fails">
  ### 连接失败
</div>

如果您无法连接到 ClickHouse：

1. **验证凭据**：再次确认您的用户名、密码和主机 URL 是否正确
2. **检查端口**：确保 HTTPS 使用端口 `8443` (如果未使用 SSL，则 HTTP 使用端口 `8123`)
3. **IP 白名单**：确认 Databrain 的 IP 地址已加入您在 ClickHouse 防火墙/安全设置中的白名单
4. **SSL/TLS**：如果您使用 HTTPS，请确保 SSL/TLS 已正确配置
5. **用户权限**：确认该用户对 `information_schema` 和目标数据库具有 SELECT 权限

<div id="slow-query-performance">
  ### 慢查询性能
</div>

如果查询运行较慢：

1. **优化查询**：高效使用过滤器和聚合
2. **创建 materialized view**：对于经常访问的聚合结果，可考虑在 ClickHouse 中创建 materialized view
3. **使用适当的数据类型**：确保 ClickHouse schema 使用最佳数据类型
4. **索引优化**：利用 ClickHouse 的主键和跳数索引

<div id="learn-more">
  ## 了解更多
</div>

如需进一步了解 Databrain 的功能以及如何构建强大的分析能力，请参阅：

* [Databrain 文档](https://docs.usedatabrain.com/)
* [ClickHouse 集成指南](https://docs.usedatabrain.com/guides/datasources/connecting-data-sources-to-databrain/clickhouse)
* [创建仪表盘](https://docs.usedatabrain.com/getting-started/core-concepts/dashboards)
* [构建指标](https://docs.usedatabrain.com/getting-started/core-concepts/metrics)
