@clickzetta/cz-cli-darwin-x64 0.3.1

package/bin/skills/lakehouse-doc/references/dynamictable.md

@@ -0,0 +1,56 @@
+# 动态表（Dynamic Table）
+
+>**【预览发布】本功能当前处于受邀预览阶段。如需试用，请通过官网联系方式联系云器科技。**
+
+动态表（Dynamic Table）是云器 Lakehouse 解决方案中的一项创新特性，为用户提供了一种灵活且高效的数据处理与存储方法。与传统静态表相比，动态表不直接存储数据，而是通过定义的查询语句动态生成数据。这种方式在处理大规模数据集和实现数据实时更新方面展现出显著的优势。
+
+## 动态表的核心特性
+
+1.  **查询结果即表**：动态表基于定义的查询语句动态生成数据集，每次查询都可能产生一个全新的数据集，即动态表的内容。
+2. **增量刷新机制**：动态表支持增量刷新，仅在底层数据源发生变化时触发查询语句的执行和内容的更新，大幅提升数据处理效率，尤其适用于处理大规模数据。
+3. **操作限制**：由于数据由查询生成，动态表不支持传统的`UPDATE`、`DELETE`、`INSERT`等直接数据操作，以确保数据的一致性和准确性。
+
+## 动态表的应用场景
+
+*   **数据仓库**：动态表可用于存储经过处理和转换的数据，便于后续的数据分析和报告生成。
+*   **实时数据应用**：对于需要实时数据更新的应用场景，动态表能够提供快速的数据刷新能力，保持数据的时效性。
+*   **数据ETL过程**：在数据提取、转换和加载（ETL）过程中，动态表可作为中间存储，保存转换后的数据集。
+
+## Materialized View和Dynamic Table区别
+
+从 Lakehouse 的实现机制上来看，动态表是基于传统的物化视图演进而来。虽然两者有一些共性，但在定位上存在很大区别。
+
+**物化视图：性能优化利器**
+物化视图是一种预计算并存储查询结果的特殊视图，能够显著提升查询效率。与传统视图不同，物化视图将计算结果保存在类似表的结构中，使得后续相似查询能够被优化器自动识别并直接使用预存结果，从而减少重复计算，加快查询速度。
+
+**动态表：数据加工的高效工具**
+动态表专注于数据加工，虽然也能提升查询性能，但并不依赖于查询优化器的自动重写。物化视图只有保持数据是最新的才能进行查询改写，而动态表面向加工场景，其数据可能并不是最新的。
+
+**传统物化视图在某些产品中具有以下限制，目前 Lakehouse 没有这些限制**：
+
+1.  只能基于单个基表。物化视图不能基于复杂查询（即具有联接或嵌套视图的查询）。
+
+2.  物化视图不一定是增量刷新，不同系统的实现方式各异。少量系统为了节省计算资源、加快加工速度，在部分算子中实现了增量计算。
+
+**动态表的先进特性**：
+
+1.  **增量识别与优化**：支持大数据环境下的文件粒度增量识别，实现实时增量读取和计算优化，以及写入优化。
+2.  **智能决策**：通过基于成本的优化器（Cost-Based Optimizer）智能选择全量、增量或部分增量计算，以适应不同查询需求。
+3.  **实时任务运维**：提供数据版本管理、回退和重跑等机制，为实时任务的运维提供全面支持。
+
+**数据时效性考量**：
+
+* 物化视图要求数据的即时更新，以确保查询改写的准确性。在基表数据变更时，Lakehouse 采用定时刷新机制，确保物化视图的数据始终保持最新。
+* 动态表则更注重数据加工的灵活性，根据业务定义来调整数据的滞后性，而不强制要求数据必须实时更新。
+
+## 动态表管理操作指南
+
+*   **创建动态表**：用户可以通过特定的语法定义新的动态表，并指定用于数据转换的 SQL 查询语句。具体语法和操作步骤详见 [创建动态表](create-dynamic-table.md) 文档。
+*   **删除动态表**：若动态表不再需要，可使用 `DROP TABLE` 命令将其删除。执行删除操作前，请确保数据已备份或确认不再需要，因为该操作会移除动态表的定义及其数据。具体语法和操作步骤详见 [删除Dynamic Table](drop-dynamic-table.md) 文档。
+*   **查看动态表刷新历史**：通过 `SHOW DYNAMIC TABLE REFRESH HISTORY` 命令查看指定动态表的刷新历史，可监控刷新作业的执行状态（成功与否）、运行时长、增量/全量刷新模式、处理的记录数量等信息。
+
+## 数据加工与增量计算
+
+动态表在数据加工中发挥着重要作用。通过定义查询语句，用户能够实现数据的提取、转换和加载（ETL）。同时，动态表支持增量计算，仅在数据源发生变化时触发数据更新，有效减少数据处理的时间和资源消耗。有关动态表的增量计算和数据加工的详细信息，请参阅 [数据加工与增量计算](dynamic_table_summary.md) 文档。
+
+^

package/bin/skills/lakehouse-doc/references/eco_integration/Zeppelin.md

@@ -0,0 +1,84 @@
+# 如何使用Zeppelin操作云器Lakehouse
+
+## 简介
+
+**Zeppelin** 是一款基于 Web 的 Notebook 工具，它支持多种数据处理后端和语言，可以让您轻松地进行交互式数据分析。通过使用 Zeppelin，您可以连接到云器 Lakehouse，执行 SQL 查询并创建数据驱动的交互式文档。
+
+## 准备工作
+
+1. **安装 Zeppelin**：
+   请访问 [Zeppelin 官网](https://zeppelin.apache.org/) 并按照指引完成安装。
+
+2. **配置 Zeppelin 以连接云器 Lakehouse**：
+   您需要完成以下步骤来配置 Zeppelin 的 JDBC 解释器，以便连接到云器 Lakehouse。
+
+   2.1 首先，下载云器 Lakehouse 的 [JDBC 驱动程序](../JDBC-Driver.md)。
+
+   2.2 接下来，在 Zeppelin 页面上点击右上角的“anonymous”，在弹出的下拉列表中选择“Interpreter”。
+
+   2.3 点击右上角的“+Create”按钮，创建一个新的解释器。在 Interpreter Name 字段中输入“clickzetta”，并在 Interpreter 类型下拉菜单中选择“jdbc”。
+
+   2.4 在配置页面中，填写以下信息：
+      - **default.url**：填写云器 Lakehouse JDBC 连接串，格式如下：
+        `jdbc:clickzetta://<instanceid>.api.clickzetta.com/<workspace_name>?virtualCluster=<vcluster>&schema=<schema>`
+      - **default.driver**：填写云器 Lakehouse JDBC 驱动程序的类名：
+        `com.clickzetta.client.jdbc.ClickZettaDriver`
+      - 在 Artifact 部分，点击“Add”按钮并上传先前下载的 JDBC 驱动程序 JAR 文件。
+
+   2.5 完成配置后，点击“Save”按钮保存设置，并重启名为“clickzetta”的解释器。
+
+## 创建 Notebook 并访问云器 Lakehouse
+
+1. 新建一个名为“数据探查”的 Notebook，将 Default Interpreter 设置为“clickzetta”。
+
+   ![创建 Notebook](../.topwrite/assets/image_1699930695948.png)
+
+2. 保存 Notebook 后，您可以在单元格中输入云器 Lakehouse 的 SQL 命令，然后点击“Run”按钮执行操作。
+
+   ![执行 SQL 命令](../.topwrite/assets/image_1699930908479.png)
+
+   您可以参考以下命令进行操作：
+   - [show tables](../SHOWTABLES.md)：列出当前数据库中的所有表。
+   - [select](../query-syntax.md)：查询表中的数据。
+
+## 查看当前 workspace 中的计算资源（vCluster）和数据库 schema
+
+1. 使用以下命令查看当前 workspace 中的计算资源（vCluster）列表：
+
+   ```
+   show vclusters;
+   ```
+
+   ![查看 vclusters](../.topwrite/assets/image_1699931749633.png)
+
+2. 使用以下命令查看当前 workspace 中的数据库 schema 列表：
+
+   ```
+   show schemas;
+   ```
+
+## 切换作业执行的计算资源（vCluster）和数据 schema
+
+1. 使用以下命令切换作业执行的计算资源（vCluster）：
+
+   ```
+   use vcluster <vcluster_name>;
+   ```
+
+   例如：
+   ```
+   use vcluster qiliang_ap;
+   ```
+
+2. 使用以下命令切换要访问的数据 schema：
+
+   ```
+   use schema <schema_name>;
+   ```
+
+   例如：
+   ```
+   use schema nyc_taxi_data;
+   ```
+
+现在，您已经成功配置了 Zeppelin 并开始使用它来操作云器 Lakehouse。您可以继续探索更多 SQL 命令和数据可视化功能，以便更有效地分析和呈现数据。

package/bin/skills/lakehouse-doc/references/eco_integration/airbyte.md

@@ -0,0 +1,75 @@
+# Airbyte Clickzetta Destination 插件使用指南
+
+## 引言
+
+Airbyte 是一款开源数据同步工具，它能够将各类数据源与数据仓库进行高效对接。通过 Airbyte，用户可以轻松实现数据的抽取、转换和加载（ETL），从而满足数据集成的需求。
+
+本文旨在帮助用户了解如何在 Airbyte 中配置和使用 Clickzetta Lakehouse 目标插件，实现数据的高效同步。在阅读本文前，您可能需要对 Airbyte 的基本概念有所了解。如果您还不熟悉 Airbyte，建议参考其[官方文档](https://docs.airbyte.com/category/getting-started)。
+
+## 插件特性
+
+Clickzetta Lakehouse 目标插件支持以下同步模式：
+
+1. 全量刷新同步（Full Refresh Sync）
+2. 增量追加同步（Incremental - Append Sync）
+3. 增量追加去重同步（Incremental - Append + Deduped）
+
+## 安装插件
+
+Airbyte 支持多种部署方式，包括单机和 Kubernetes（k8s）集群。在部署好 Airbyte 后，请按照以下步骤操作：
+
+1. 登录 Airbyte 控制台。
+2. 进入 Settings 页面，选择 Destinations。
+3. 点击 New connector 按钮，进入新增目标连接器界面。
+4. 填写相关信息：
+   - Connector display name：为您的连接器设置一个易于识别的名称，例如 "Clickzetta Lakehouse"。
+   - Docker repository name：输入 "clickzetta/clickzetta-airbyte"。
+   - Docker image tag：从 [Docker Hub](https://hub.docker.com/r/clickzetta/clickzetta-airbyte/tags) 查询并输入最新的镜像版本号。
+   - Connector documentation URL：可将本文的链接填写于此，以便随时查阅。
+5. 点击 Add 按钮，稍等片刻，插件即配置完成。
+
+## 配置插件
+
+在 Airbyte 中创建 Source、Destination 和 Connection 对象，具体步骤可参考 [官方文档](https://docs.airbyte.com/quickstart/set-up-a-connection)。以下是针对 Clickzetta Lakehouse 目标连接器的配置说明：
+
+1. 在 Airbyte 控制台，进入 Destination 页面。
+2. 点击 New destination 按钮，创建新的目的地对象。
+3. 选择 Clickzetta Lakehouse 连接器。
+4. 填写配置信息：
+   - Username：您的 Clickzetta Lakehouse 用户名。
+   - Password：对应的用户密码。
+   - Service：服务地址，例如 "api.clickzetta.com"。
+   - Instance：实例名称。
+   - Workspace：空间名称，如 "quickstart_ws"。
+   - VirtualCluster：集群名称，如 "default"。Airbyte 将使用此集群的计算资源执行 ELT 的 Transform SQL。
+   - Schema（可选）：默认为 "public"，如有需要可修改。
+   - Normalization：选择 "Normalized tabular data"，以便将数据还原为源表的 schema。
+   - Split size：设置 Normalization SQL 执行时的切片大小。建议保留默认值，以避免影响性能。
+
+## 使用示例
+
+以下是几个典型的使用场景，帮助您更好地理解如何使用 Clickzetta Lakehouse 目标插件：
+
+### 示例 1：全量同步数据
+
+1. 创建一个 Source 对象，连接您的数据源。
+2. 创建一个 Destination 对象，配置 Clickzetta Lakehouse 连接器。
+3. 创建一个 Connection 对象，关联 Source 和 Destination。
+4. 在 Connection 配置中，选择 Full Refresh Sync 同步模式。
+5. 启动 Connection，Airbyte 将全量同步数据至 Clickzetta Lakehouse。
+
+### 示例 2：增量同步并去重
+
+1. 按照示例 1 的步骤配置 Source、Destination 和 Connection 对象。
+2. 在 Connection 配置中，选择 Incremental - Append + Deduped 同步模式。
+3. 设置 Incremental 触发条件，例如基于时间戳或记录 ID。
+4. 启动 Connection，Airbyte 将增量同步数据，并自动去重。
+
+## 总结
+
+本文详细介绍了如何在 Airbyte 中配置和使用 Clickzetta Lakehouse 目标插件。通过遵循上述步骤和示例，您可以轻松实现数据的高效同步。
+
+## 参考资料
+
+- [Airbyte 官方文档](https://docs.airbyte.com/category/getting-started)
+- [Airbyte ELT 实现及各种同步模式解析](https://airbyte.com/tutorials/incremental-data-synchronization)

package/bin/skills/lakehouse-doc/references/eco_integration/datagrip-lakehouse.md

@@ -0,0 +1,56 @@
+# DataGrip连接云器Lakehouse
+
+本文档将指导您如何使用数据库管理工具DataGrip连接云器Lakehouse，以便进行高效的数据管理操作。
+
+## 背景信息
+
+DataGrip 是一款功能强大的商业版数据库管理工具，专为满足专业 SQL 开发人员的特定需求而设计。它支持多种数据库，包括云器Lakehouse。有关DataGrip的更多信息，请访问[官方网站](https://www.jetbrains.com/datagrip/)。
+
+## 前提条件
+
+在开始操作之前，请确保您已满足以下条件：
+
+1. 已成功开通Lakehouse服务。
+2. 已下载适用于Lakehouse的JDBC驱动程序。请参考[官方文档](../version-update)以获取驱动程序。
+3. 已下载并安装DataGrip。
+
+## 步骤一：添加云器Lakehouse驱动
+
+1. 打开DataGrip，进入主界面。
+2. 点击“New Project”，创建一个新的项目。在新项目的界面中，点击“Driver”并选择“+”按钮，添加一个新的驱动。将驱动命名为Lakehouse
+![添加Lakehouse驱动](.topwrite/assets/image_1693482390581.png)
+
+
+
+
+## 步骤二：使用DataGrip连接云器Lakehouse
+
+1. 在“Data Sources”窗口中，选择刚刚创建的Lakehouse数据源。
+2. 点击“Test Connection”按钮，确保连接正常。如果连接失败，请检查您的Lakehouse服务和JDBC驱动设置。
+3. 点击“OK”按钮，完成数据源配置。
+4. 从Lakehouse服务的首页，复制JDBC连接字符串。请参考以下示例：
+
+![Lakehouse首页JDBC地址](.topwrite/assets/image_1693482409292.png)
+
+## 步骤三：使用DataGrip管理云器Lakehouse
+
+1. 在DataGrip的左侧“Database”面板中，您可以看到所有的schema和table。
+
+![查看schema和table](.topwrite/assets/image_1693482418469.png)
+
+2. 右键点击任意一个schema或table，选择“SQL Script”以打开SQL编辑器。
+3. 在SQL编辑器中，您可以编写和执行SQL查询。例如，您可以执行以下查询以获取某个表的前10行数据：
+
+```sql
+SELECT * FROM your_table_name LIMIT 10;
+```
+
+4. 执行查询后，结果将在下方的“Results”面板中显示。您可以对结果进行排序、筛选和导出等操作。
+
+# 常见问题
+由于datagrip不同版本会存在不同的变化。有的版本点击预览表时发送SQL在schema会带上引号。您可以通过以下方式绕过，编辑数据源在options中的startup script添加,并且勾选Single session mode
+```
+set  cz.sql.double.quoted.identifiers=true;
+```
+
+![](../.topwrite/assets/image_1733814698645.png)

package/bin/skills/lakehouse-doc/references/eco_integration/datax.md

@@ -0,0 +1,154 @@
+# DataX ClickZettaWriter 插件
+
+## DataX 简介
+
+DataX 是阿里巴巴开源的数据同步工具，支持多种数据源，包括关系型数据库、HDFS、Hive、MaxCompute、HBase、FTP 和本地文件等。本文档将介绍如何使用 DataX ClickZettaWriter 插件，实现 DataX 同步数据到 ClickZetta LakeHouse。
+## 使用限制
+- 不支持vector和json类型
+
+## 准备工作
+
+1. 请确保已安装 DataX。具体安装方法，请参考 [DataX 使用指南](https://github.com/alibaba/DataX/tree/master)。
+2. 下载 DataX ClickZettaWriter 插件，下载地址：[DataX ClickzettaWriter 插件](https://autolake-dev-beijing.oss-cn-beijing.aliyuncs.com/clickzetta-tool/dataxwriter/datax.tar.gz)。将插件解压到 DataX 安装目录下的 `plugin/writer` 目录下。
+3. 在使用 DataX ClickZettaWriter 插件前，请确保在 ClickZetta LakeHouse 中已经创建了相应的表。
+
+## 使用 DataX ClickZettaWriter 插件
+
+### 1. 创建配置文件
+
+以下用例展示了如何使用 DataX ClickZettaWriter 插件将 MySQL 数据同步到 ClickZetta LakeHouse。
+
+```json
+{
+  "job": {
+    "content": [
+      {
+        "reader": {
+            "name": "mysqlreader",
+            "parameter": {
+                "column": ["*"],
+                "connection": [
+                    {
+                        "jdbcUrl": ["jdbc:mysql://mysql_host:mysql_port/database?useSSL=false"],
+                        "table": ["test_table"]
+                    }
+                ],
+                "password": "example",
+                "username": "example",
+                "where": ""
+            }
+        },
+        "writer": {
+          "name": "clickzettawriter",
+          "parameter": {
+              "column": ["*"],
+              "connection": [
+                  {
+                      "jdbcUrl": "jdbc:clickzetta://instance.service/workspace?schema=example&username=example&password=example&vcluster=example",
+                      "table": ["test_table"]
+                  }
+              ],
+              "password": "example",
+              "username": "example",
+              "preSql": [],
+              "postSql": [],
+              "writeMode": "overwrite",
+              "tableNumber": "1",
+              "partitionColumns": {
+                  "region" : "example"
+              }
+          }
+        }
+      }
+    ],
+    "setting": {
+      "speed": {
+        "channel": 1
+      }
+    }
+  }
+}
+```
+
+配置说明：
+
+* `mysqlreader`：DataX 内置的 mysqlreader 插件，用于读取 MySQL 数据。具体使用方法，请参考 [mysqlreader 插件文档](https://github.com/alibaba/DataX/blob/master/mysqlreader/doc/mysqlreader.md)。
+* `clickzettawriter` 参数说明：
+  * `jdbcUrl`：LakeHouse JDBC 连接信息。
+  * `table`：写入的表名（仅支持写入一张表）。
+  * `column`：写入的列名（`*` 星号表示所有列）。
+  * `partitionColumns`：分区列名，用于分区表写入（`column` 指定的列加上分区别必须是表的所有列）。
+  * `writeMode`：写入模式，可选值为 `append`、`overwrite` 和 `upsert`，默认为 `append`。
+  * `username`：LakeHouse 用户名。
+  * `password`：LakeHouse 密码。
+  * `preSql`：写入前执行的 SQL 语句。
+  * `postSql`：写入后执行的 SQL 语句。
+
+### 2. 执行同步任务
+
+运行以下命令以执行同步任务：
+
+```shell
+python bin/datax.py job.json
+```
+
+## 使用示例
+
+### 示例 1：同步 MySQL 数据到 ClickZetta LakeHouse
+
+以下配置文件示例将 MySQL 中的 `test_table` 数据同步到 ClickZetta LakeHouse 的 `example_table`。
+
+```json
+{
+    "job": {
+        "content": [
+            {
+                "reader": {
+                    "name": "mysqlreader",
+                    "parameter": {
+			"column": ["*"],
+               		"connection": [
+                  	  {
+                        	"jdbcUrl": ["jdbc:mysql://mysql_host:mysql_port/database?useSSL=false"],
+                      		"table": ["test_table"]
+                    }
+                ],
+                "password": "example",
+                "username": "example",
+                "where": ""
+                    }
+                },
+                "writer": {
+                	          "name": "clickzettawriter",
+          "parameter": {
+              "column": ["*"],
+              "connection": [
+                  {
+                      "jdbcUrl": "jdbc:clickzetta://your_instance_name.api.clickzetta.com/your_workspace_name?schema=sample&username=your_user_name&password=your_password&vcluster=your_vcluster_name",
+                      "table": ["example_table"]
+                  }
+              ],
+                      "partitionColumns": {
+                        "region" : "example"
+                      },
+              "password": "your_password",
+              "preSql": [],
+              "session": [],
+              "username": "your_user_name",
+              "writeMode": "append",
+              "tableNumber": "1"
+          }
+        }
+      }
+    ],
+    "setting": {
+      "speed": {
+        "channel": 1
+       }
+    }
+  }
+}
+        
+```
+
+^

package/bin/skills/lakehouse-doc/references/eco_integration/dbeaver-lakehouse.md

@@ -0,0 +1,67 @@
+# DBeaver连接云器Lakehouse
+
+本文档将指导您如何通过数据库管理工具DBeaver连接并管理云器Lakehouse中的数据。DBeaver是一款功能强大的多平台数据库工具，适用于开发人员、数据库管理员、分析师以及所有需要使用数据库的人员。本文档将详细介绍如何配置DBeaver以连接Lakehouse，并提供一些实际使用示例。
+
+## 背景信息
+
+DBeaver是一款免费的数据库管理工具，支持多种数据库，如MySQL、PostgreSQL、Oracle等。更多DBeaver信息，请参见[DBeaver官网](https://dbeaver.io/)。
+
+## 前提条件
+
+在开始操作前，请确保您已满足以下条件：
+
+1. 已成功开通Lakehouse服务。
+2. 已下载适用于Lakehouse的JDBC驱动。关于如何下载和安装驱动，请参见[Java SDK文档](<../version-update.md>)。
+3. 已下载并安装DBeaver。关于如何下载和安装DBeaver，请参见[DBeaver下载页面](https://dbeaver.io/download/)。
+4. 已安装适用于您的操作系统的DBeaver版本。本文中的DBeaver示例为`dbeaver-ce-23.1.4-macos-x86_64`。
+
+## 步骤一：配置DBeaver连接Lakehouse驱动
+
+1. 启动DBeaver并进入主界面。在顶部菜单栏中，点击“数据库”->“驱动管理器”。
+
+![驱动管理器界面](.topwrite/assets/image_1693482257812.png)
+
+2. 在驱动管理器界面中，点击左下角的“新建驱动”按钮。
+
+![新建驱动按钮](.topwrite/assets/image_1693482268306.png)
+
+3. 在弹出的对话框中，点击“设置”按钮，填入以下信息：
+   - 驱动名称：`Clickzetta`
+   - 类名：`com.clickzetta.client.jdbc.ClickZettaDriver`
+   - URL模板：`jdbc:clickzetta://{instanceName}.{service}/{workspaceName}?virtualCluster={您的Virtual Cluster名称}`
+
+![配置驱动信息](.topwrite/assets/image_1693482279541.png)
+
+4. 点击“选择库”，将已下载的Lakehouse JDBC驱动（`*.jar-with-dependencies.jar`）添加到驱动中，并点击“确定”。
+
+![添加JDBC驱动](.topwrite/assets/image_1693482290529.png)
+
+5. 在顶部菜单栏中，点击“新建连接”，选择“全部”，在搜索框中输入刚才新建的驱动名称`Clickzetta`，然后点击“下一步”。
+
+![新建连接](.topwrite/assets/image_1693482299012.png)
+
+6. 在“连接配置”界面中，选择“URL”，从Lakehouse首页复制JDBC连接字符串并粘贴到相应的输入框中。同时，填写您的用户名和密码。
+
+![连接配置](.topwrite/assets/image_1693482307635.png)
+
+关于如何获取Lakehouse首页的JDBC连接字符串，请参见[Lakehouse文档](<../version-update.md>)。
+
+## 步骤二：使用DBeaver查询分析Lakehouse数据
+
+成功连接DBeaver和Lakehouse后，您可以在DBeaver左侧的“连接”面板中找到新建的Lakehouse连接。接下来，您可以通过SQL管理Lakehouse中的数据。
+
+1. 右键点击新建的Lakehouse连接，选择“新建SQL编辑器”。
+
+![新建SQL编辑器](.topwrite/assets/image_1693482322444.png)
+
+2. 在SQL编辑器中，编写您需要执行的查询语句。例如，查询某个表的前10条记录：
+
+```sql
+SELECT * FROM your_table_name LIMIT 10;
+```
+
+![编写查询语句](.topwrite/assets/image_1693482333626.png)
+
+3. 执行查询，并查看结果。您还可以对查询结果进行排序、筛选等操作。
+
+通过以上步骤，您可以轻松地使用DBeaver连接并管理Lakehouse中的数据。更多关于DBeaver的高级功能和使用技巧，请参见[DBeaver官方文档](https://dbeaver.io/docs/)。

package/bin/skills/lakehouse-doc/references/eco_integration/dbt.md

@@ -0,0 +1,139 @@
+# dbt ClickZetta adapter 使用指南
+
+## dbt 简介
+
+dbt（Data Build Tool）是一款开源的数据建模工具，旨在将软件工程的方法引入数据建模开发过程。dbt 支持多种数据源，使得数据开发人员能够实现跨平台、质量可控的数据开发。dbt 拥有活跃的社区，提供了丰富的扩展组件，如数据质量、与其他系统集成等，让数据开发变得更加简便。
+
+云器推出了 `dbt-clickzetta` 适配器，以支持 dbt 版本 1.5+。本文将结合 dbt 标准示例 [Jaffle Shop](https://github.com/dbt-labs/jaffle-shop-classic)，详细介绍适配器的安装和使用方法。
+
+## 准备环境
+
+1. 安装 dbt-clickzetta 适配器（已集成 dbt-core 和 dbt-extractor）：
+   ```shell
+   pip install dbt-clickzetta
+   ```
+2. 准备 dbt 项目：
+   ```shell
+   git clone https://github.com/dbt-labs/jaffle-shop-classic.git
+   ```
+3. 在版本控制系统中，管理和编辑项目。
+
+## 配置
+
+在 dbt 项目根目录（即 `jaffle_shop` 目录）编辑 `profiles.yml` 文件，如下所示：
+
+```yaml
+jaffle_shop:
+  target: prod
+  outputs:
+    prod:
+      type: clickzetta
+      service: region_id.api.clickzetta.com
+      instance: instance_name
+      username: user_name
+      password: password
+      workspace: workspace_name
+      schema: jaffle_shop
+      vcluster: default
+```
+
+参数说明：
+
+* 官方指定的 dbt profile 参数（如上述示例中的 jaffle\_shop、target 等），请参考 [dbt 官方文档](https://docs.getdbt.com/docs/core/connect-data-platform/connection-profiles)。
+* dbt-clickzetta 插件识别的参数包括：
+  * type: 固定为 clickzetta
+  * service: ClickZetta Lakehouse 服务地址
+  * instance: 实例名称
+  * username: 用户名
+  * password: 密码
+  * workspace: 工作空间名称
+  * schema: Schema 名称
+  * vcluster: 计算集群名称
+
+为方便使用 `dbt` 命令，可将 `profiles.yml` 文件拷贝到用户目录下：
+
+```shell
+mkdir ~/.dbt/ && cp profiles.yml ~/.dbt/
+```
+
+运行 `dbt debug` 以验证配置是否正确。
+
+## 运行 dbt 项目
+
+### 1. 上传数据
+
+运行 `dbt seed`，将项目中的 CSV 数据上传到 ClickZetta Lakehouse。
+
+### 2. 运行模型
+
+使用 `dbt run`，dbt 将根据 models 目录中的文件描述自动生成 SQL 并执行。
+
+### 3. 验证产出
+
+运行 `dbt test`，对产出表进行验证。测试是您对 dbt 项目中的模型和其他资源（例如源、种子和快照）所做的断言。当您运行 `dbt test` 时，dbt 会告诉您项目中的每个测试是否通过或失败。
+
+### 4. 生成并查看报告
+
+运行 `dbt docs generate` 生成项目的文档网站，然后运行 `dbt docs serve` 启动本地 HTTP 服务。在浏览器中打开 `http://localhost:8080` 即可查看报告页面。
+
+#### 查看报告
+
+![dbt docs 截图](dbt_docs_screenshot.png)
+
+#### 查看数据血缘
+
+![数据血缘截图](../.topwrite/assets/image_1697458411669.png)
+
+## 更多示例
+
+### 示例 1：创建模型
+
+在 `models` 目录下创建一个新文件 `example_model.sql`，并添加以下内容：
+
+```sql
+CREATE VIEW example_model AS
+SELECT
+  customers.first_name,
+  customers.last_name,
+  SUM(orders.total) AS total_spent
+FROM
+  {{ ref('customers') }} customers
+JOIN
+  {{ ref('orders') }} orders
+ON
+  customers.id = orders.customer_id
+GROUP BY
+  customers.first_name,
+  customers.last_name;
+```
+
+### 示例 2：运行特定模型
+
+运行 `dbt run-operation example_model` 来执行特定模型。
+
+### 示例 3：使用测试
+
+在 `models` 目录下的 `schema.yml` 文件中添加测试：
+
+```yaml
+models:
+  - name: stg_customers
+    columns:
+      - name: customer_id
+        tests:
+          - unique
+          - not_null
+```
+
+运行 `dbt test` 来执行测试。
+
+### 示例 4：使用钩子（Hook）
+
+在 `models` 目录下的 `schema.yml` 文件中添加钩子：
+
+```yaml
+models:
+  - name: stg_orders
+```
+
+^