@clickzetta/cz-cli-darwin-x64 0.3.1

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

@@ -0,0 +1,42 @@
+## 功能
+
+本语句用于删除已存在的物化视图，以释放相关资源。
+
+有关更多详细信息，请参阅[物化视图](<MATERIALIZEDVIEW.md>)。
+
+## 语法
+
+```SQL
+DROP MATERIALIZED VIEW [ IF EXISTS ] mv_name;
+```
+
+## 参数说明
+
+- **IF EXISTS**：可选参数，表示如果物化视图不存在，则不抛出错误。
+- **mv_name**：要删除的物化视图名称。
+
+## 示例
+
+1. 删除名为 `my_mv` 的物化视图：
+
+```SQL
+DROP MATERIALIZED VIEW my_mv;
+```
+
+2. 删除名为 `my_mv` 的物化视图，如果该视图不存在，则不抛出错误：
+
+```SQL
+DROP MATERIALIZED VIEW IF EXISTS my_mv;
+```
+
+3. 删除多个物化视图，分别为 `mv1`、`mv2` 和 `mv3`：
+
+```SQL
+DROP MATERIALIZED VIEW mv1, mv2, mv3;
+```
+
+## 注意事项
+
+- 在执行删除操作前，请确保物化视图不再被其他数据库对象引用，以免引发错误。
+- 删除物化视图可能会影响依赖于该视图的查询和应用程序。因此，在执行删除操作前，请确保已做好相应的备份和准备工作。
+- 使用 `IF EXISTS` 参数可以避免因物化视图不存在而导致的错误，建议在实际操作中使用该参数。

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

@@ -0,0 +1,56 @@
+# 从当前 workspace 删除角色
+
+## Workspace 角色管理
+
+本命令用于从当前 workspace 中删除一个角色。请注意，执行此操作后，该角色将无法再访问与之关联的资源和权限。
+
+## 语法
+
+```SQL
+DROP ROLE [IF EXISTS] role_name;
+```
+
+- `role_name`：要删除的角色名称。
+
+## 使用说明
+
+- 在执行删除操作前，请确保不再需要该角色。删除后，该角色将无法恢复。
+- 使用 `IF EXISTS` 选项可以避免在角色不存在时出现错误提示。
+- 请确保您具有足够的权限来执行此操作。
+
+## 示例
+
+1. 删除名为 `simple_role` 的角色：
+
+```SQL
+DROP ROLE simple_role;
+```
+
+2. 使用 `IF EXISTS` 选项删除名为 `temporary_role` 的角色，以避免在角色不存在时出现错误提示：
+
+```SQL
+DROP ROLE IF EXISTS temporary_role;
+```
+
+3. 删除具有特定权限的角色 `report_user`：
+
+```SQL
+DROP ROLE report_user;
+```
+
+## 注意事项
+
+- 执行此命令将永久删除角色及其关联的权限和资源。请谨慎操作。
+- 在删除角色前，请确保已将该角色的权限和资源分配给其他角色或用户，以防止数据丢失或权限问题。
+- 如果您不确定某个角色是否还在使用中，请先进行查询操作，以确保不会误删重要角色。
+# 删除 Instance Role
+
+```
+DROP INSTANCE ROLE IF EXISTS <role_name>;
+```
+
+## 使用说明
+
+- 在执行删除操作前，请确保不再需要该角色。删除后，该角色将无法恢复。
+- 使用 `IF EXISTS` 选项可以避免在角色不存在时出现错误提示。
+- 需要 INSTANCE_ADMIN 权限才可以执行此操作。

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

@@ -0,0 +1,37 @@
+### **功能概述**
+
+`DROP SCHEMA` 语句旨在删除指定的schema，并同时移除该架构下的所有数据库对象。在执行此操作前，请务必对所有关键数据进行备份，以防数据丢失。
+
+### **语法结构**
+
+```Plaintext
+DROP SCHEMA [ IF EXISTS ] schema_name;
+```
+
+### **参数详解**
+
+- `schema_name`: 指定需要删除的schema名称。
+- `IF EXISTS`: 这是一个可选参数，用于在指定的数据库架构不存在时避免报错。
+
+### **使用示例**
+
+1. 删除名为 `deprecated_schema` 的schema：
+
+   ```SQL
+   DROP SCHEMA deprecated_schema;
+   ```
+
+2. 删除同名数据库架构，但在架构不存在时不显示错误信息：
+
+   ```SQL
+   DROP SCHEMA IF EXISTS deprecated_schema;
+   ```
+
+### **注意事项**
+
+- 执行 `DROP SCHEMA` 语句将不可逆地删除整个架构及其包含的所有对象（如表、视图、索引等）。因此，在执行此操作前，请确保已对所有重要数据进行了备份。
+- 该操作只能由拥有相应权限的用户执行。如果您没有足够的权限，操作将会失败并报错。
+
+### **权限要求**
+
+执行 `DROP SCHEMA` 语句的用户必须具备对应schema的 `DROP` 权限。如果您不具备所需权限，操作将会失败并报错。

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

@@ -0,0 +1,46 @@
+## 功能
+
+`DROP TABLE` 命令用于删除数据库中的表。请注意，执行此操作后，表及数据将被删除。如果要恢复，请使用 [UNDROP](<UNDROP-TABLE.md>) 命令，并确保删除的对象在 [TIME TRAVEL](<timetravel-summary.md>) 保留周期内，否则将无法恢复。
+
+## 语法
+
+```SQL
+DROP TABLE [ IF EXISTS ] [schema_name.]<table_name>
+```
+
+### 参数说明
+
+- `IF EXISTS`：可选。如果指定的表不存在，系统不会报错。
+- `schema_name`：可选。指定 schema 的名称。如果未指定，默认使用当前用户的 schema。
+- `table_name`：要删除的表名称。
+
+## 示例
+
+1. 删除当前 schema 下名为 `my_table` 的表：
+
+```SQL
+DROP TABLE my_table;
+```
+
+2. 删除名为 `my_table` 的表，如果表不存在，不报错：
+
+```SQL
+DROP TABLE IF EXISTS my_table;
+```
+
+3. 删除名为 `my_schema` 下的 `my_table` 表：
+
+```SQL
+DROP TABLE my_schema.my_table;
+```
+
+4. 删除名为 `my_schema` 下的 `my_table` 表，如果表不存在，不报错：
+
+```SQL
+DROP TABLE IF EXISTS my_schema.my_table;
+```
+
+## 注意事项
+
+- 在执行 `DROP TABLE` 命令前，请确保已对表中的数据进行备份，以防止数据丢失。
+- 在删除表之前，请确保该表不再被其他数据库对象（如视图、TABLE STREAM 等）引用，否则可能导致错误。

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

@@ -0,0 +1,34 @@
+# 从当前workspace移除用户
+
+## 功能
+
+本命令用于从当前 workspace 中移除指定的用户，以确保只有授权的用户可以访问和操作该 workspace。
+
+## 语法
+
+```SQL
+DROP USER [IF EXISTS] user_name;
+```
+
+- `IF EXISTS`：可选参数，用于判断指定的用户是否存在于当前 workspace 中。若存在，则执行移除操作；若不存在，则不执行任何操作。
+- `user_name`：需要从当前 workspace 中移除的用户的名称。
+
+## 使用示例
+
+1. 移除名为 “uat_test” 的用户：
+
+```SQL
+DROP USER uat_test;
+```
+
+2. 移除名为 “john_doe” 的用户，如果该用户不存在，则不执行任何操作：
+
+```SQL
+DROP USER IF EXISTS john_doe;
+```
+
+## 注意事项
+
+- 在执行本命令之前，请确保您有足够的权限来移除指定的用户。
+- 移除用户后，该用户将无法访问或操作当前 workspace 中的任何资源。请谨慎操作，以免造成不必要的损失。
+- 如果您希望移除多个用户，请分别执行多次 `DROP USER` 命令。

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

@@ -0,0 +1,33 @@
+## 功能
+本命令用于从当前 schema 或指定 schema 删除一个或多个视图。需要注意的是，一旦视图被删除，相关数据将无法通过该视图进行访问，除非重新创建视图。
+
+## 语法
+
+```
+DROP VIEW [ IF EXISTS ] view_name;
+```
+
+## 参数说明
+
+- `IF EXISTS`：可选参数，用于在视图不存在的情况下避免报错。
+- `view_name`：指定要删除的视图名称。可以是单个视图名称，也可以使用<schema_name>.<view_name>格式指定schema和视图名称。
+
+## 使用示例
+
+**示例1：删除当前schema下的视图**
+
+假设我们需要删除名为`myview`的视图，可以使用以下命令：
+
+```
+DROP VIEW myview;
+```
+
+**示例2：删除指定schema下的视图**
+
+如果我们想要删除`my_schema`架构下的`myview`视图，可以使用以下命令：
+
+```
+DROP VIEW my_schema.myview;
+```
+
+

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

@@ -0,0 +1,99 @@
+# 数据质量管理
+
+在大数据时代，数据质量管理是确保数据正确性、有效性和一致性的关键环节。通过数据质量管理，我们可以对海量数据进行清洗、加工和优化，从而提升数据价值密度，更好地服务于业务需求。数据质量模块为您提供全方位监控和评估数据质量的功能，包括完整性、唯一性、一致性、准确性、有效性和及时性六大维度。通过数据质量模块，您可以实现数据质量的持续改进和优化。
+
+## 概览
+
+数据质量概览页面为您提供了一个直观的数据质量监控大盘，方便您查看质量规则和校验运行的整体情况。以下是部分指标的详细解释：
+
+![](.topwrite/assets/image_1760004305684.png)
+
+部分指标的口径如下
+
+* 质量规则数：服务实例的所有工作空间下，配置的质量规则总数，包含未开启的规则
+* 覆盖表总数：服务实例的所有工作空间下，有配置质量规则的表的数量
+* 检测运行次数：近一个月的质量规则运行次数
+* 校验通过率：近一个月的通过次数/校验总次数
+* 质量规则分布：服务实例的所有工作空间下的质量规则，按照负责人或者工作空间统计的数量分布
+* 校验结果分布：服务实例的所有工作空间下的质量规则，校验结果状态的分布
+* 高质量表：有配置质量规则，且最近7天均校验通过的表
+* 今日需要关注结果：校验失败的质量规则
+
+## 质量规则
+
+质量规则页面以列表形式展示您已配置的全部质量规则。通过顶部的筛选过滤区域，您可以快速找到所需的规则。
+
+![](.topwrite/assets/image_1760004360956.png)
+
+通过顶部的筛选过滤区域，可以进行精细化地查找。
+
+### 新建质量规则
+
+1. 在质量规则列表中，或在校验对象的规则列表中，点击“新建规则”按钮，进入新建质量规则页面。
+2. 填写必填配置项，如数据源、工作空间、校验对象、负责人、描述、参数配置、取值过滤、校验方式、期待结果、触发方式、执行集群和超时时间等。
+ ![](.topwrite/assets/image_1760004384816.png)
+
+| **配置项**       | **配置说明**                                                                                                                                                                                                                                |
+| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| 数据源           | 指数据源类型，当前只支持Lakehouse数据源                                                                                                                                                                                                                |
+| 工作空间          | 校验对象所属的工作空间                                                                                                                                                                                                                             |
+| 校验对象          | 校验对象是Lakehouse表时，选择其所在的Schema和名称（表名、视图名称等）                                                                                                                                                                                              |
+| 负责人           | 质量规则的负责人，影响告警的接受                                                                                                                                                                                                                        |
+| 描述            | 给质量规则定义的描述                                                                                                                                                                                                                              |
+| 参数配置          | 质量规则中，在取值过滤和自定义SQL来计算指标值时，支持引用预先定义的动态参数取值。举例定义如下参数\* partition = $\[yyyyMMdd]                                                                                                                                                           |
+| 取值过滤          | 用以过滤需要校验的对象范围，比如按照分区过滤，支持引用参数\* dt = ${partition}                                                                                                                                                                                       |
+| 校验方式 - 内置指标   | 系统内置的校验指标，按需选择使用                                                                                                                                                                                                                        |
+| 校验方式 - 自定义SQL | 如果系统内置的校验指标不满足使用需要，可以通过自定义SQL来计算指标取值\* 特别注意：自定义SQL的运行结果，必须是一个单值的数值，才能进行比较                                                                                                                                                               |
+| 期待结果          | 定义指标值的期待结果                                                                                                                                                                                                                              |
+| 触发方式          | 用于配置质量规则触发运行的方式
 1、定时触发：在给定的定时时间，由系统触发运行一次校验
2、周期任务触发：由关联的周期任务实例来触发，在实例运行成功后，触发质量规则运行。对于周期调度触发，有两种调度阻塞配置选项
A：强阻塞调度：如果质量规则校验失败，会把关联的调度任务实例置为失败，进而会阻塞该调度实例的下游实例运行。
B：不阻塞调度：质量规则作为旁路运行，不影响关联的调度任务实例的运行状态
3、手动触发：按需手动触发 |
+| 执行集群          | 指定工作空间下，运行质量规则的计算集群                                                                                                                                                                                                                     |
+| 超时时间          | 在设定的超时时间到达后，如果质量规则校验没有完成，会被系统自动取消                                                                                                                                                                                                       |
+
+填写好必填的配置项后，点击“确认”按钮新建规则。
+
+3. 举例：如果您希望检测某个表的记录数是否符合预期，可以选择“记录数”作为内置指标，设置取值过滤为特定分区，期待结果为一个具体数值，触发方式为定时触发，执行集群为您的工作空间下的计算集群。
+
+### 试跑质量规则
+
+新建质量规则后，建议您使用“试跑”功能来验证配置的正确性。试跑成功后，您可以查看试跑结果，以便对规则进行调整。
+
+![](.topwrite/assets/image_1760004576132.png)
+
+### 查看试跑结果
+
+点击“试跑”后，按照提示点击“查看结果”可以查看试跑校验的结果
+
+![](.topwrite/assets/image_1699875850066.png)
+
+### 配置监控告警
+
+为确保数据质量问题得到及时处理，您可以为质量规则配置监控告警。有两种方式：
+
+1. **开启全局的质量监控告警**：在监控告警模块中搜索“数据质量检测失败”，开启系统内置的全局质量校验监控规则。
+   ![](.topwrite/assets/image_1699875920709.png)
+2. **配置自定义的质量监控告警**：创建自定义监控规则，选择“质量规则校验失败”作为监控消息，并设置过滤条件，如工作空间或具体校验对象。
+   ![](.topwrite/assets/image_1699875932007.png)
+
+## 校验对象
+
+在校验对象页面，您可以按照校验对象（表）的维度管理全部质量规则。使用搜索过滤区域，您可以快速定位到特定的规则。
+
+![](.topwrite/assets/image_1699875683208.png)
+
+## 校验结果
+
+### 校验结果列表
+
+在校验结果列表页面，您可以查看全部质量规则的运行情况。通过搜索和过滤区域，您可以精确地找到所需的校验结果。
+
+![](.topwrite/assets/image_1699875971234.png)
+
+### 校验结果的操作
+
+针对每个校验结果，您可以执行以下操作：
+
+* **终止**：取消当前的校验运行。
+* **置成功/置失败**：将校验结果人为置为成功或失败。
+* **再次校验**：触发质量校验的再次运行。请注意，如果校验失败的规则再次校验通过，不会继续触发监控告警的发送。
+
+通过以上功能，您可以有效地管理和监控数据质量，确保数据在业务中的应用价值得到充分发挥。

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

@@ -0,0 +1 @@
+^

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

@@ -0,0 +1,35 @@
+# ADB for MySQL 数据源配置指南
+
+## 概述
+
+ADB for MySQL 是阿里云提供的分析型数据库服务，它基于 MySQL 协议，支持高并发、高可用的在线事务处理和在线分析处理。配置 ADB for MySQL 数据源可以实现数据的高效同步和分析，满足多种业务场景的需求。
+
+## 参数配置
+
+配置 ADB for MySQL 数据源时，需要提供以下信息以确保成功连接到 ADB 服务：
+
+* **数据源名称**：为 ADB for MySQL 数据源指定一个唯一且易于识别的名称。
+* **JDBC 连接地址**：提供 ADB for MySQL 实例的 JDBC 连接地址，格式通常为 `jdbc:mysql://host:port/database`。
+* **用户名**：输入用于连接 ADB for MySQL 实例的用户名。
+* **密码**：提供对应用户名的数据库密码。
+* **数据源描述**：（可选）为数据源添加描述性信息，以帮助管理员理解该数据源的用途或特点。
+
+## 连接配置
+
+在连接配置方面，可以选择以下连接方式之一：
+
+* **直连**：确保输入的连接信息在公网可访问。如果源端开启了IP访问白名单，请确保数据集成服务的出口IP地址已被添加到白名单中，具体IP地址请联系技术支持人员。
+* **通过 SSH 隧道**：为了提高安全性，您可以选择通过 SSH 隧道连接到 ADB for MySQL。启用此选项并提供以下与 SSH 隧道相关的配置信息：
+  * **SSH 服务器地址**：提供 SSH 服务器的 IP 地址或域名。
+  * **SSH 端口**：指定 SSH 服务器监听的端口号，通常为 `22`。
+  * **用户名**：提供 SSH 服务器的登录用户名。
+  * **密码**：提供 SSH 服务器登录用户名对应的密码。
+
+## 注意事项
+
+* 确保所有提供的连接信息准确无误，并且 ADB for MySQL 服务是可访问的。
+* 保护您的数据库凭证信息和 SSH 凭证信息，避免泄露给未经授权的人员。
+* 定期检查并更新您的数据源配置，以适应数据库结构的变化或新的安全要求。
+* 监控数据同步任务的运行状态，以便及时发现并解决可能出现的问题。
+
+配置完成后，即可在数据同步任务中选择此 ADB for MySQL 数据源，进行数据的导入或导出操作。通过 SSH 隧道连接可以增强数据传输的安全性，特别是在处理敏感数据时。

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

@@ -0,0 +1,36 @@
+# ADB for PostgreSQL 数据源配置指南
+
+## 概述
+
+ADB for PostgreSQL 是阿里云提供的一种关系型数据库服务。它基于 PostgreSQL 开源数据库，支持 SQL 和 NoSQL 数据模型，提供高性能、高可用性和弹性扩展的数据存储解决方案。通过配置 ADB for PostgreSQL 数据源，您可以实现数据的高效同步和分析，满足复杂的业务需求。
+
+## 参数配置
+
+配置 ADB for PostgreSQL 数据源时，需要提供以下信息，以确保成功连接到数据库服务：
+
+* **数据源名称**：为您的 ADB for PostgreSQL 数据源指定一个唯一且易于识别的名称。
+* **JDBC 连接地址**：提供 ADB for PostgreSQL 实例的 JDBC 连接地址，格式通常为 `jdbc:postgresql://host:port/database`。
+* **用户名**：输入用于连接 ADB for PostgreSQL 实例的用户名。
+* **密码**：提供对应用户名的数据库密码。
+* **Schema**：指定默认连接的 Schema，例如 `public` 或其他您需要使用的 Schema。
+* **数据源描述**：（可选）为数据源添加描述信息，以帮助您或其他管理员理解该数据源的用途或特点。
+
+## 连接配置
+
+在连接配置方面，您可以选择以下连接方式之一：
+
+* **直连**：确保您输入的连接信息对应的服务在公网可访问。如果数据库实例开启了 IP 访问白名单，请确保数据集成服务的出口 IP 地址已被添加到白名单中，具体 IP 地址请联系技术支持人员。
+* **通过 SSH 隧道连接**：为了提高安全性，您可以选择通过 SSH 隧道连接到 ADB for PostgreSQL。启用此选项后，需要提供以下 SSH 隧道相关的配置信息：
+  * **SSH 服务器地址**：填写 SSH 服务器的 IP 地址或域名。
+  * **SSH 端口**：指定 SSH 服务器监听的端口号，通常为 `22`。
+  * **用户名**：填写 SSH 服务器的登录用户名。
+  * **密码**：填写 SSH 服务器登录用户名对应的密码。
+
+## 注意事项
+
+* 确保所有提供的连接信息准确无误，且 ADB for PostgreSQL 服务是可访问的。
+* 请妥善保护您的数据库凭证和 SSH 凭证，避免泄露给未经授权的人员。
+* 定期检查并更新您的数据源配置，以适应数据库结构变化或新的安全要求。
+* 监控数据同步任务的运行状态，以便及时发现并解决可能出现的问题。
+
+配置完成后，您即可在数据同步任务中选择此 ADB for PostgreSQL 数据源，进行数据导入或导出操作。通过 SSH 隧道连接可以增强数据传输的安全性，特别是在处理敏感数据时。

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

@@ -0,0 +1,37 @@
+# AMQP 数据源配置指南
+
+## 概述
+
+AMQP（Advanced Message Queuing Protocol）是一种异步消息传输协议，以其高可靠性和灵活性广泛应用于物联网(IoT)、微服务架构和企业系统集成中。通过配置AMQP数据源，您可以实现与阿里云物联网平台等系统的高效数据交换。
+
+## 参数配置
+
+配置 AMQP 数据源时，需要提供以下信息以确保成功连接到 AMQP 服务：
+
+* 数据源名称：为您的 AMQP 数据源指定一个唯一且易于识别的名称。
+* Host：提供AMQP服务的接入域名，通常格式为 `${uid}.iot-amqp.${YourRegionId}.aliyuncs.com`。详情请参见[阿里云管理实例终端节点](https://help.aliyun.com/zh/iot/user-guide/manage-the-endpoint-of-an-instance#task-1545804)
+* 认证方式：目前支持通过RAM账号认证和基于RAM账号的角色扮演认证。请选择配置合适的认证方式。
+* IOT INSTANCE ID：IOT实例ID。您可在[阿里云物联网平台控制台](https://iot.console.aliyun.com/)的实例概览页面，查看当前实例的ID。
+* 数据源描述：（可选）为数据源添加描述性信息，以帮助您或其他管理员理解该数据源的用途或特点。
+
+## 认证方式配置
+
+选择适合您的认证方式，并根据实际情况配置以下参数：
+
+* 通过RAM账号连接：此种模式直接使用RAM账号进行连接，需要配置如下参数：
+  * AccessKey ID：阿里云主账号或对应RAM用户的AccessKey ID和AccessKey Secret。登录阿里云物联网平台控制台，将鼠标移至账号头像上，然后单击AccessKey管理，获取AccessKey ID和AccessKey Secret。
+  * AccessKey Secret：阿里云主账号或对应RAM用户的AccessKey ID和AccessKey Secret。登录阿里云物联网平台控制台，将鼠标移至账号头像上，然后单击AccessKey管理，获取AccessKey ID和AccessKey Secret。
+* 通过 RAM角色授权的RAM用户：此种模式适用于通过RAM角色授权一个其他RAM账号来访问数据源，需要配置如下参数：
+  * STS Endpoint：STS Token获取服务接入点。具体信息，请参见[阿里云服务接入点](https://www.alibabacloud.com/help/zh/ram/developer-reference/api-sts-2015-04-01-endpoint)
+  * STS AccessKey ID：扮演数据持有企业阿里云账号下RAM角色的RAM用户的AccessKey ID。
+  * STS Role ARN：数据持有企业的阿里云账号下要扮演的RAM角色ARN，格式为 `acs:ram::<account-id>:role/<role-name>`
+
+## 注意事项
+
+* 确保AMQP服务器的安全性和稳定性，合理配置认证和授权机制。
+* 保护您的凭证信息，避免泄露给未经授权的人员。
+* 配置时，请参考AMQP服务器的相关文档和支持资源以确保正确性。
+* 配置后，可以使用“测试连通”功能验证数据源的可访问性和配置信息的正确性。
+* 验证无误后，您可以在数据同步任务中选择此AMQP数据源，执行数据读取导出。
+
+请确保您已阅读并遵循上述指南，以顺利完成AMQP数据源的配置。如果需要进一步的帮助，请参阅相关文档或联系技术支持。

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

@@ -0,0 +1,115 @@
+# AWS DocumentDB 数据源配置指南
+
+## 概述
+
+AWS DocumentDB（兼容 MongoDB）是 Amazon Web Services 提供的完全托管的文档数据库服务，它在云中提供了与 MongoDB 兼容的数据库引擎。通过配置 AWS DocumentDB 数据源，您可以轻松实现与其他系统的数据同步和集成，享受云原生数据库的高可用性、可扩展性和安全性。
+
+## 参数配置
+
+配置 AWS DocumentDB 数据源时，需要提供以下信息以确保成功连接到数据库：
+
+### 基础配置
+
+* **数据源名称**（必填）：为您的 AWS DocumentDB 数据源指定一个唯一且易于识别的名称。建议使用有意义的命名规则，例如"行为数据源"，以便后续管理和维护。
+* **URL地址**（必填）：提供 AWS DocumentDB 集群的连接端点地址，格式为 `hostname:port`。例如：`docdb-example.cluster-abc123.us-east-1.docdb.amazonaws.com:27017`。该地址可在 AWS 管理控制台的 DocumentDB 集群详情页面中获取。
+
+### 认证信息
+
+* **用户名**（必填）：提供用于连接 AWS DocumentDB 的主用户名或具有相应权限的数据库用户。默认主用户名通常为 `admin`，您也可以使用自定义的用户。
+* **密码**（必填）：提供对应用户名的数据库密码。请确保密码的强度，避免使用弱密码。系统会对密码进行加密存储。
+
+### 安全配置
+
+* **CA证书**（可选）：AWS DocumentDB 默认启用 TLS 加密连接以确保数据传输安全。如果您的集群启用了 TLS，则需要上传 AWS 提供的 CA 证书文件（rds-combined-ca-bundle.pem）。请点击“上传文件”按钮选择本地的 CA 证书文件。
+
+### 连接方式
+
+* **通过SSH Tunnel连接**（可选）：为了提高安全性，特别是当 DocumentDB 集群位于私有 VPC 中时，您可以选择通过 SSH 隧道连接。启用此选项后，数据将通过安全的 SSH 通道传输到 DocumentDB。您需要提供一台具有公网访问能力且能够访问 DocumentDB 集群的跳板机（Bastion Host）的信息：
+
+  * SSH 服务器的 IP 地址
+  * SSH 端口（默认 22）
+  * SSH 用户名和密钥或密码
+
+### 其他配置
+
+* **数据源描述**（可选）：为数据源添加描述性信息，例如“生产环境用户行为数据库”，以帮助您或其他管理员理解该数据源的用途、所属环境或业务场景。
+
+### 授权访问工作空间
+
+* **指定工作空间**：仅授权特定工作空间使用此数据源，适用于需要严格权限控制的场景。
+* **全部工作空间**（推荐）：允许所有工作空间使用此数据源，便于跨团队协作和数据共享。
+
+## 连接配置说明
+
+### 网络访问配置
+
+根据您的 AWS DocumentDB 部署架构，可以选择以下连接方式：
+
+#### 1. 公网直连（需配置 VPC 和安全组）
+
+如果您的 DocumentDB 集群配置了公网访问（通过 VPN 或 Direct Connect），确保：
+
+* DocumentDB 集群的安全组入站规则允许数据集成平台的出口 IP 地址访问 27017 端口
+* VPC 网络 ACL 规则允许相应的流量通过
+* 具体的平台出口 IP 地址列表，请联系技术支持获取。
+
+#### 2. 通过 SSH 隧道连接（推荐）
+
+对于位于私有 VPC 中的 DocumentDB 集群，强烈推荐使用 SSH 隧道方式：
+
+* 在与 DocumentDB 集群相同的 VPC 中部署一台 EC2 实例作为跳板机
+* 该 EC2 实例需要具有公网 IP 或弹性 IP
+* 确保 EC2 实例的安全组允许来自数据集成平台的 SSH 连接（22 端口）
+* DocumentDB 集群的安全组需允许来自 EC2 实例的访问（27017 端口）
+* 这种方式可以避免将 DocumentDB 直接暴露在公网，提高安全性
+
+## 连接测试
+
+完成所有配置后，点击页面底部的“测试连接”按钮验证连接配置：
+
+* 系统将尝试使用提供的参数连接到 AWS DocumentDB 集群
+* 验证网络可达性、认证信息和权限设置
+* 测试成功后，您可以保存数据源配置，并在数据同步任务中使用它。
+
+## 注意事项
+
+### 安全性建议
+
+* **TLS 加密**：AWS DocumentDB 默认启用 TLS，强烈建议保持启用状态并上传正确的 CA 证书，确保数据传输加密。
+* **最小权限原则**：为数据同步创建专用的数据库用户，仅授予必要的读写权限，避免使用主账号。
+* **密码管理**：定期更换数据库密码，避免在多个系统中重复使用相同密码。
+* **网络隔离**：优先使用 SSH 隧道或 VPC 私有连接，避免将数据库直接暴露在公网中。
+
+### 性能优化
+
+* **连接池配置**：系统会自动管理连接池，确保高效的连接复用。
+* **网络延迟**：选择与 DocumentDB 集群位于同一区域（Region）的数据集成服务，以降低网络延迟。
+* **读取性能**：对于大规模数据同步，可以考虑从副本实例读取数据，减轻主实例压力。
+
+### 运维建议
+
+* **监控同步状态**：定期检查数据同步任务的运行状态和日志，及时发现并解决潜在问题。
+* **备份策略**：确保 DocumentDB 集群已配置自动备份，避免数据丢失风险。
+* **版本兼容性**：注意 AWS DocumentDB 的版本与 MongoDB 协议的兼容性，某些高级功能或语法可能存在差异。
+* **配额限制**：了解 AWS DocumentDB 的连接数、存储容量等配额限制，避免超限导致服务中断。
+
+### 故障排查
+
+如果连接测试失败，请检查以下常见问题：
+
+1. **网络连通性**：使用 `telnet` 或 `nc` 命令，测试从数据集成平台到 DocumentDB 的网络连通性。
+2. **安全组配置**：确认 DocumentDB 和 EC2（如使用 SSH 隧道）的安全组规则正确配置。
+3. **认证信息**：验证用户名和密码是否正确，用户是否具有访问目标数据库的权限。
+4. **CA 证书**：如果启用 TLS，确保上传的 CA 证书文件有效且未过期。
+5. **SSH 配置**：如使用 SSH 隧道，验证跳板机的 SSH 服务是否正常，密钥或密码是否正确。
+
+## 完成配置
+
+完成所有参数配置并通过连接测试后，您就可以：
+
+* 在数据同步任务中选择此 AWS DocumentDB 数据源
+* 配置具体的集合（Collection）和字段映射
+* 设置数据同步的调度策略和增量更新规则
+* 执行数据的导入或导出操作
+
+^

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

@@ -0,0 +1,42 @@
+# AWS OpenSearch 数据源配置指南
+
+## 概述
+
+AWS OpenSearch 是 Amazon Web Services 提供的托管式搜索和分析引擎服务，基于开源的 OpenSearch 项目构建。它能够实现实时的全文搜索、日志分析和复杂的数据分析。配置 AWS OpenSearch 数据源可以帮助您在数据同步和分析任务中高效地操作和管理存储在 AWS OpenSearch 中的数据。
+
+## 参数配置
+
+配置 AWS OpenSearch 数据源时，需要提供以下信息以确保成功连接到 AWS OpenSearch 域：
+
+* **数据源名称**：为您的 AWS OpenSearch 数据源指定一个唯一且易于识别的名称，例如 `行为数据数据源`。
+* **Domain EndPoint**：提供 AWS OpenSearch 域的访问端点地址，格式为 `<domain-name>-<identifier>.<region>.es.amazonaws.com:443`。例如，`search-example-domain-abc123.us-east-1.es.amazonaws.com:443`。
+* **鉴权方式**：选择 `Access Key ID & Access Key Secret` 作为身份验证方式。
+* **Access Key ID**：提供具有 OpenSearch 访问权限的 AWS IAM 用户的 Access Key ID。
+* **Access Key Secret**：提供对应的 Access Key Secret 密钥。
+* **通过SSH Tunnel连接**：（可选）当 OpenSearch 域位于 VPC 内部无法直接访问时，可启用 SSH Tunnel 实现安全连接。
+* **数据源描述**：（可选）为数据源添加描述性信息，以帮助您或其他管理员理解该数据源的用途或特点。
+* **授权给工作空间使用**：选择数据源的可见范围，可以选择 `指定工作空间` 或 `全部工作空间`。
+
+## 连接配置
+
+在连接配置方面，您需要注意以下事项：
+
+* **直连**：确保您的 AWS OpenSearch 域配置了适当的访问策略。如果域启用了 IP 地址访问控制，请确保数据集成服务的出口 IP 地址已被加入到允许列表中，具体 IP 地址请联系技术支持人员。
+* **SSH Tunnel**：如果 OpenSearch 域部署在 VPC 内部，您可以通过启用 SSH Tunnel 方式，经由跳板机建立安全连接。
+
+## 注意事项
+
+* 确保所有提供的连接信息准确无误，并且 AWS OpenSearch 域是可访问的。
+* 保护您的 Access Key 凭证信息，避免泄露给未经授权的人员。Access Key Secret 将被加密存储。
+* 确保 IAM 用户具有访问 OpenSearch 域的必要权限，建议附加 `AmazonOpenSearchServiceFullAccess` 策略或自定义策略。
+* 定期检查并更新您的数据源配置，以适应域结构的变化或新的安全要求。
+* 监控数据同步任务的运行状态，以便及时发现并解决可能出现的问题。
+* 注意 AWS 数据传输产生的费用，特别是跨区域访问的场景。
+
+配置完成后，您就可以在数据同步任务中选择此 AWS OpenSearch 数据源，进行数据的导入或导出操作。通过合适的连接方式，您可以实现快速的数据传输，提高数据处理效率。
+
+
+## 相关文档
+
+* [AWS OpenSearch Service官方文档](https://docs.aws.amazon.com/opensearch-service/)
+* [AWS IAM用户管理](https://docs.aws.amazon.com/IAM/latest/UserGuide/)