> ## 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.

> Luzmo 是一个嵌入式分析平台，提供原生 ClickHouse 集成，专为软件和 SaaS 应用而打造。

# Luzmo 与 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 />

<Steps>
  <Step title="设置 ClickHouse 连接" id="1-setup-a-clickhouse-connection">
    要连接到 ClickHouse，请前往 **Connections 页面**，选择 **New Connection**，然后在 New Connection 连接弹窗中选择 ClickHouse。

    <Image img="https://mintcdn.com/private-7c7dfe99/etDiFo_9fGSe5rMN/images/integrations/data-visualization/luzmo_01.webp?fit=max&auto=format&n=etDiFo_9fGSe5rMN&q=85&s=967e6102cd8c64b737019bc319980003" size="md" alt="Luzmo 界面显示“Create a New Connection”对话框，且已选中 ClickHouse" border width="720" height="497" data-path="images/integrations/data-visualization/luzmo_01.webp" />

    系统会要求你提供 **host**、**username** 和 **password**：

    <Image img="https://mintcdn.com/private-7c7dfe99/etDiFo_9fGSe5rMN/images/integrations/data-visualization/luzmo_02.webp?fit=max&auto=format&n=etDiFo_9fGSe5rMN&q=85&s=0441f2efee476fc353d914bc808a73e8" size="md" alt="Luzmo 连接配置表单，显示 ClickHouse host、username 和 password 字段" border width="462" height="454" data-path="images/integrations/data-visualization/luzmo_02.webp" />

    * **Host**：这是暴露你的 ClickHouse 数据库的主机地址。请注意，为了通过网络安全传输数据，这里仅允许使用 `https`。host URL 的格式应为：`https://url-to-clickhouse-db:port/database`
      默认情况下，插件会连接到 `default` 数据库和 443 端口。你也可以在 `/` 后指定数据库，以配置要连接的数据库。
    * **Username**：用于连接到你的 ClickHouse 集群的用户名。
    * **Password**：用于连接到你的 ClickHouse 集群的密码

    请参阅我们开发者文档中的示例，了解如何通过 API [创建到 ClickHouse 的连接](https://developer.luzmo.com/api/createAccount?exampleSection=AccountCreateClickhouseRequestBody)。
  </Step>

  <Step title="添加数据集" id="2-add-datasets">
    连接到 ClickHouse 后，你可以按照[这里](https://academy.luzmo.com/article/ldx3iltg)的说明添加数据集。你可以选择 ClickHouse 中一个或多个可用数据集，并在 Luzmo 中将它们[关联](https://academy.luzmo.com/article/gkrx48x5)起来，以确保它们可以在同一个仪表盘中配合使用。另请参阅这篇关于[为分析准备数据](https://academy.luzmo.com/article/u492qov0)的文章。

    如需了解如何使用我们的 API 添加数据集，请参阅[开发者文档中的这个示例](https://developer.luzmo.com/api/createDataprovider?exampleSection=DataproviderCreateClickhouseRequestBody)。

    现在，你可以使用这些数据集构建精美的 (嵌入式) 仪表盘，甚至为能够回答客户问题的 AI 数据分析师 ([Luzmo IQ](https://luzmo.com/iq)) 提供支持。

    <Image img="https://mintcdn.com/private-7c7dfe99/etDiFo_9fGSe5rMN/images/integrations/data-visualization/luzmo_03.webp?fit=max&auto=format&n=etDiFo_9fGSe5rMN&q=85&s=4b66ae70e426978f43f8d82e1abed64c" size="md" alt="Luzmo 仪表盘示例，展示了多个基于 ClickHouse 数据的可视化" border width="956" height="693" data-path="images/integrations/data-visualization/luzmo_03.webp" />
  </Step>
</Steps>

<div id="usage-notes">
  ## 使用说明
</div>

1. Luzmo ClickHouse 连接器使用 HTTP API 接口 (通常运行在 8123 端口) 进行连接。
2. 如果您使用采用 `Distributed` 表引擎的表，且 `distributed_product_mode` 设置为 `deny`，某些 Luzmo 图表 可能无法正常工作。不过，这通常只会在您将该表关联到另一张表，并在图表中使用该关联时发生。在这种情况下，请确保将 `distributed_product_mode` 设置为 ClickHouse 集群中其他适合您的选项。如果您使用的是 ClickHouse Cloud，则可以放心忽略此设置。
3. 例如，为确保只有 Luzmo 应用能够访问您的 ClickHouse 实例，强烈建议您将 [Luzmo 的静态 IP 地址范围](https://academy.luzmo.com/article/u9on8gbm) 加入**白名单**。我们还建议使用技术用途的只读用户。
4. ClickHouse 连接器当前支持以下数据类型：

   | ClickHouse 类型 | Luzmo 类型  |
   | ------------- | --------- |
   | UInt          | numeric   |
   | Int           | numeric   |
   | Float         | numeric   |
   | Decimal       | numeric   |
   | Date          | datetime  |
   | DateTime      | datetime  |
   | String        | hierarchy |
   | Enum          | hierarchy |
   | FixedString   | hierarchy |
   | UUID          | hierarchy |
   | Bool          | hierarchy |
