@clickzetta/cz-cli-darwin-x64 0.3.1

package/bin/skills/lakehouse-doc/references/drop-external-table.md

@@ -0,0 +1,43 @@
+# 功能
+
+`DROP TABLE` 命令用于从数据库中移除表。在 Lakehouse 中，使用 `DROP TABLE` 可以删除外部表，这一操作不会删除表中的实际数据，仅删除 Lakehouse 中的元数据对象。
+
+# 语法
+
+```sql
+DROP TABLE [ IF EXISTS ] [ schema_name. ] table_name;
+```
+
+# 参数说明
+
+- **IF EXISTS**：（可选）如果指定的表不存在，使用此选项可以避免系统抛出错误。
+- **schema_name**：（可选）指定要删除表的 schema 名称。如果未指定，将默认使用当前用户的 schema。
+- **table_name**：要删除的表的名称。
+
+# 示例
+
+1.  **删除当前 schema 下的表**：
+
+   ```sql
+   DROP TABLE my_table;
+   ```
+
+2. **删除表，如果不存在则不报错**：
+
+   ```sql
+   DROP TABLE IF EXISTS my_table;
+   ```
+
+3.  **删除特定 schema 下的表**：
+
+   ```sql
+   DROP TABLE my_schema.my_table;
+   ```
+
+4. **删除特定 schema 下的表，如果不存在则不报错**：
+
+   ```sql
+   DROP TABLE IF EXISTS my_schema.my_table;
+   ```
+
+

package/bin/skills/lakehouse-doc/references/drop-function.md

@@ -0,0 +1,36 @@
+# DROP FUNCTION
+
+## **功能描述**
+
+删除当前或指定 schema 下的外部函数。需要注意的是，删除函数后，无法恢复该函数，只能重新创建。此外，删除函数并不会清理存储在对象存储中的函数代码和可执行文件。
+
+## **语法**
+
+```
+DROP FUNCTION [IF EXISTS] <function_name>;
+```
+
+## **参数说明**
+
+- `<function_name>`：指定的外部函数名称。
+- `IF EXISTS`：可选参数，用于判断函数是否存在。如果存在，则删除函数；如果不存在，则不执行任何操作。
+
+
+## **使用说明**
+
+- 删除函数时，建议先使用 `IF EXISTS` 参数进行判断，以避免因函数不存在而导致的错误。
+- 删除函数后，需要重新创建函数并重新加载函数代码和可执行文件。
+
+**示例**
+
+1.  删除名为 `ext_to_upper` 的外部函数。
+
+    ```
+   drop function if exists ext_to_upper;
+   ```
+
+2.  删除名为 `ext_to_upper` 的外部函数及其依赖的所有对象。
+
+    ```
+   drop function ext_to_upper ;
+   ```

package/bin/skills/lakehouse-doc/references/drop-share.md

@@ -0,0 +1,43 @@
+# DROP SHARE 语句
+
+## 功能描述
+
+`DROP SHARE` 语句用于删除已存在的 share 对象。share 对象通常用于在多个用户之间共享数据，删除 share 对象将移除该共享关系。
+
+## 语法格式
+
+```SQL
+DROP SHARE <share_name>;
+```
+
+## 参数说明
+
+* **share_name**：需要删除的 share 对象名称。
+
+## 使用示例
+
+1. 删除名为 `share_1` 的 share 对象：
+
+   ```SQL
+   DROP SHARE share_1;
+   ```
+
+2. 删除名为 `employee_data` 的 share 对象，该对象之前被用于在不同部门之间共享员工数据：
+
+   ```SQL
+   DROP SHARE employee_data;
+   ```
+
+## 注意事项
+
+* 执行 `DROP SHARE` 语句前，请确保该 share 对象不再被其他用户或应用程序使用，以免造成数据访问异常。
+* 删除 share 对象后，与之相关的共享权限也会被移除。需要重新配置共享权限时，请使用 `GRANT` 语句。
+* 请谨慎操作，删除 share 对象是不可逆的操作。
+
+## 相关语句
+
+* [CREATE SHARE](create-share.md)：创建 share 对象。
+* [ALTER SHARE](alter-share.md)：修改 share 对象的属性或权限。
+* [SHOW SHARES](show-shares.md)：查询已存在的 share 对象列表。
+
+^

package/bin/skills/lakehouse-doc/references/drop-synonym.md

@@ -0,0 +1,35 @@
+## 功能
+删除同义词
+## 语法
+
+```SQL
+DROP [TABLE|VOLUME|FUNCTION] SYNONYM [ IF EXISTS ] [ schema. ] synonym_name
+```
+
+* TABLE|VOLUME|FUNCTION：表示给哪种对象命名同义词。
+
+  * **TABLE**：这是默认选项。用于为table、table stream、materialized view、dynamic table命名同义词。在这些情况下，“TABLE”关键字是可选的。
+  * **VOLUME**：为VOLUME命名同义词时，必须明确指定此关键字。如果省略，系统将默认寻找同名的TABLE对象。
+  * **FUNCTION**：为FUNCTION命名同义词时，此关键字是必填项。如果未指定，系统同样会默认寻找同名的TABLE对象。
+
+* `IF EXISTS`：可选。仅当同义词已存在时，才有条件地删除该同义词。
+
+* `schema`：可选。指定同义词所在的schema。如果未指定schema，则使用当前会话的默认schema。
+
+### 权限
+
+```SQL
+grant drop synonym on all synonyms in schema <schemaname> to user uat_test_01;
+```
+## 示例
+为TABLE创建同义词并删除
+```SQL
+CREATE TABLE employees(id int,name string,skills array<string>);
+INSERT INTO employees (id, name, skills) VALUES
+(1, 'John Doe', ['Java', 'Python', 'SQL']),
+(2, 'Jane Smith', ['C++', 'Hadoop', 'SQL']),
+(3, 'Bob Johnson', ['Python', 'Docker']);
+CREATE TABLE SYNONYM employees_syno FOR employees;
+--删除同义词
+DROP SYNONYM employees_syno;
+```

package/bin/skills/lakehouse-doc/references/drop-table-stream.md

@@ -0,0 +1,42 @@
+# 删除 Table Stream 命令
+
+## 功能
+
+删除已经存在的 Table Stream，释放相关资源。
+
+## 语法
+
+```SQL
+DROP TABLE STREAM [IF EXISTS] stream_name;
+```
+
+* `stream_name`：要删除的Table Stream名称。
+
+## 说明
+
+`DROP TABLE STREAM` 命令用于删除已经存在的Table Stream。如果指定的Table Stream不存在，可以通过添加 `IF EXISTS` 选项来避免出现错误提示。
+
+## 示例
+
+1. 删除名为 `rc3.igs_test_upsert02_stream` 的Table Stream：
+
+```SQL
+DROP TABLE STREAM IF EXISTS rc3.igs_test_upsert02_stream;
+```
+
+2. 删除名为 `my_stream` 的Table Stream，不关心是否存在：
+
+```SQL
+DROP TABLE STREAM my_stream;
+```
+
+3. 删除名为 `customer_stream` 的Table Stream，如果存在：
+
+```SQL
+DROP TABLE STREAM IF EXISTS customer_stream;
+```
+
+## 注意事项
+
+* 删除 Table Stream 前，请确保不再需要该 Stream 中的数据。
+* 删除操作无法撤销，请谨慎操作。

package/bin/skills/lakehouse-doc/references/drop-vcluster.md

@@ -0,0 +1,52 @@
+# 删除计算集群
+
+## 功能
+
+删除指定的计算集群。计算集群删除后将不可恢复，请谨慎操作。
+
+## 语法
+
+```SQL
+DROP VCLUSTER [IF EXISTS] NAME [FORCE];
+```
+
+- `IF EXISTS`：可选关键字，用于判断计算集群是否存在。如果存在，则执行删除操作；如果不存在，则不执行删除操作且不报错。
+- `NAME`：指定要删除的计算资源名称。
+- `FORCE`：可选关键字，用于强制删除计算资源。如果不添加FORCE关键字，计算集群将在当前作业执行完毕后再进行删除。如果加入FORCE关键字，计算集群将直接删除，不再等待当前执行作业完成。
+
+## 示例
+
+1. 删除空间内名称为`sample_vc`的计算资源：
+
+   ```SQL
+   DROP VCLUSTER sample_vc;
+   ```
+
+2. 强制删除空间内名称为`simple_vc`的计算资源：
+
+   ```SQL
+   DROP VCLUSTER sample_vc FORCE;
+   ```
+
+3. 删除空间内名称为`test_vc`的计算资源，如果该计算集群不存在，则不执行删除操作且不报错：
+
+   ```SQL
+   DROP VCLUSTER IF EXISTS test_vc;
+   ```
+
+4. 删除空间内名称为`production_vc`的计算资源，使用FORCE关键字强制删除：
+
+   ```SQL
+   DROP VCLUSTER production_vc FORCE;
+   ```
+
+5. 在删除计算资源时，先判断计算资源是否存在：如果存在则删除，如果不存在则不报错：
+
+   ```SQL
+   DROP VCLUSTER IF EXISTS development_vc;
+   ```
+
+## 注意事项
+
+- 在执行删除操作前，请确保计算集群内没有正在运行的作业，以免造成数据丢失或任务失败。
+- 使用FORCE关键字强制删除计算集群时，请确保当前没有作业正在执行，否则可能会导致正在执行的作业中断或失败。

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

@@ -0,0 +1,32 @@
+## 功能描述
+
+删除指定的对象是指在数据库中移除一个已存在的数据库对象，如表、视图、索引、函数等。这个操作是不可逆的，一旦执行，被删除的对象及其所有数据将从数据库中永久移除。
+
+## 语法说明
+
+```
+DROP <object_type> [ IF EXISTS ] <identifier>  
+```
+* `DROP`: 关键字，表示要执行删除操作。
+* `<object_type>`: 要删除的对象类型，例如 TABLE、VIEW、INDEX、FUNCTION 等。
+* `IF EXISTS`: 可选子句。如果指定的对象存在，则执行删除操作；如果不存在，则不执行任何操作，也不抛出错误。
+* `<identifier>`: 要删除的具体对象的名称，例如表名、视图名等。
+
+## 语法参考
+[DROP USER](<DROPUSER.md>)
+[DROP ROLE](<DROPROLE.md>)
+[DROP CONNECTION](<DROPCONNECTION.md>)
+[DROP SCHEMA](<DROPSCHEMA.md>)
+[DROP EXTERNAL SCHEMA](<drop-external-schema.md>)
+[DROP SHARE](<drop-share.md>)
+[DROP VCLUSTER](<drop-vcluster.md>)
+[DROP TABLE](<DROPTABLE.md>)
+[DROP DYNAMIC TABLE](<drop-dynamic-table.md>)
+[DROP VIEW](<DROPVIEW.md>)
+[DROP MATERIALIZED VIEW](<DROPMATERIALIZEDVIEW.md>)
+[DROP INDEX](<DROP-INDEX.md>)
+[DROP TABLE STREAM](<drop-table-stream.md>)
+[DROP SYNONYM](<drop-synonym.md>)
+[DROP FUNCTION](<drop-function.md>)
+
+

package/bin/skills/lakehouse-doc/references/dynamic-mask.md

@@ -0,0 +1,201 @@
+# Lakehouse 列级安全（动态脱敏）使用文档
+> 【预览发布】本功能当前处于受邀预览发布阶段。如需使用，请联系我们的技术支持团队协助处理。
+## 1. 概述
+
+列级安全（Column-level Security）通过动态脱敏（Dynamic Data Masking）提供细粒度数据保护能力，可根据用户身份或角色动态修改敏感数据的显示方式（如部分隐藏、替换字符）。系统仅存储原始数据，在数据读取运行时才执行脱敏函数（mask function）。本文档介绍如何通过 SQL 接口实现此功能。
+
+## 2. 核心语法
+
+### 2.1 创建脱敏策略函数
+
+参考[CREATE FUNCTION(SQL)](create-sql-function.md)语法
+
+```sql
+CREATE  FUNCTION [schema_name.]function_name (col_name column_type) 
+RETURNS output_type 
+AS 
+expression_with_conditional_logic;
+```
+
+**关键要素**：
+
+* 必须返回与原始列相同的数据类型
+* 使用安全上下文函数：
+  * `current_user()` 获取当前用户（注意大小写）
+  * `current_roles()` 获取用户角色数组
+
+### 2.2 绑定策略到列
+
+**创建表时指定**：
+
+```sql
+CREATE TABLE table_name (
+  col1 STRING MASK schema_name.masking_function,
+  ...
+);
+```
+
+**修改已有表**：
+
+```sql
+ALTER TABLE table_name 
+CHANGE COLUMN column_name 
+SET MASK schema_name.masking_function;
+```
+
+**添加列时指定脱敏**：
+
+```SQL
+ALTER TABLE table_nameADD COLUMN (column_name column_typeMASK schema_name.masking_function);
+```
+
+### 2.3 解除策略绑定
+
+```sql
+ALTER TABLE table_name 
+CHANGE COLUMN column_name 
+UNSET MASK;
+```
+
+***
+
+## 3. 使用场景示例
+
+### 3.1 基础脱敏
+
+**需求**：身份证号前6位+4星号+后4位
+
+```sql
+CREATE FUNCTION public.idcard_masking(idcard STRING)
+RETURNS STRING
+AS concat(substr(idcard, 1, 6), repeat('*', 4), substr(idcard, 10, 4));
+
+ALTER TABLE data CHANGE COLUMN idcard SET MASK public.idcard_masking;
+```
+
+**查询效果**：
+
+```
+原始值：130183199901011234 → 脱敏后：130183****9010
+```
+
+### 3.2 基于用户的动态脱敏
+
+**需求**： 仅UAT\_TEST用户看到脱敏数据
+
+```sql
+CREATE FUNCTION public.idcard_masking(idcard STRING)
+RETURNS STRING
+AS 
+CASE 
+  WHEN current_user() = "UAT_TEST" 
+  THEN concat(substr(idcard, 1, 6), repeat('*', 4), substr(idcard, 10, 4))
+  ELSE idcard 
+END;
+--忽略用户名大小写
+CREATE FUNCTION public.idcard_masking(idcard STRING)
+RETURNS STRING
+AS 
+CASE 
+  WHEN lower(current_user()) = "uat_test" 
+  THEN concat(substr(idcard, 1, 6), repeat('*', 4), substr(idcard, 10, 4))
+  ELSE idcard 
+END;
+```
+
+### 3.3 基于角色的动态脱敏
+
+**需求**： user\_admin角色可查看完整信息
+
+```sql
+CREATE FUNCTION public.idcard_masking_role(idcard STRING)
+RETURNS STRING
+AS 
+CASE 
+  WHEN array_contains(current_roles(), "user_admin") 
+  THEN idcard
+  ELSE concat(substr(idcard,1,6), '****', substr(idcard,11,4)) 
+END;
+```
+
+***
+
+## 4. 完整操作示例
+
+### 4.1 初始化环境
+
+```sql
+CREATE SCHEMA IF NOT EXISTS security_demo;
+USE security_demo;
+-- 通用掩码函数
+CREATE FUNCTION security_demo.ssn_mask(ssn STRING)
+RETURNS STRING
+AS concat('***-**-', substr(ssn, 8, 4));
+
+CREATE TABLE security_demo.user_data (
+  name STRING,
+  ssn STRING MASK security_demo.ssn_mask,  -- 建表时直接绑定
+  phone STRING
+);
+INSERT INTO security_demo.user_data VALUES('James', '123-45-6789','123456789');
+SELECT * FROM      security_demo.user_data;
+```
+
+### 4.2 创建策略函数
+
+```sql
+-- 特权角色豁免
+CREATE FUNCTION security_demo.admin_ssn_mask(ssn STRING)
+RETURNS STRING
+AS 
+CASE
+  WHEN array_contains(current_roles(), 'user_admin') THEN ssn
+  ELSE concat('***-**-', substr(ssn,8,4))
+END;
+```
+
+### 4.3 修改脱敏策略
+
+```sql
+--去除之前的策略
+ALTER TABLE security_demo.user_data CHANGE COLUMN ssn UNSET MASK;
+
+--添加新的策略
+ALTER TABLE security_demo.user_data CHANGE COLUMN ssn SET MASK security_demo.admin_ssn_mask;
+```
+
+### 4.4 验证效果
+
+**普通用户查询**：
+
+```sql
+SELECT * FROM user_data;
+-- 输出：John Doe ***-**-6789 138****1234
+```
+
+**USER\_ADMIN角色查询**：
+
+```sql
+SELECT * FROM user_data; 
+-- 输出：John Doe 123-45-6789 138****1234
+```
+
+***
+
+## 5. 管理注意事项
+
+### 5.1 权限控制
+
+* 仅允许具有 `ALTER TABLE` 权限的角色修改脱敏策略。
+* 函数创建需要 `CREATE FUNCTION` 权限。
+
+### 5.2 性能建议
+
+* 避免在脱敏函数中使用复杂计算。
+* 对高频查询列，谨慎使用条件判断逻辑。
+
+## 6. 限制说明
+
+* 单个列只能绑定一个脱敏策略。如果您想定义多种脱敏规则，可以在一个函数中基于条件判断实现不同的策略。
+
+^

package/bin/skills/lakehouse-doc/references/dynamic-table-incre.md

@@ -0,0 +1,62 @@
+# 使用Explain查看动态表刷新模式
+
+通过 explain 命令查看是否能增量刷新（preview），需要通过开关开启，开启的开关为 `set cz.optimizer.explain.can.incrementalize=true;` 在数据开发中需要选中一起执行。
+
+**语法**
+
+```Plain
+set cz.optimizer.explain.can.incrementalize=true;
+EXPLAIN REFRESH DYNAMIC TABLE dtname;
+```
+
+使用说明
+
+* `explain` 命令通常是用来查看 SQL 执行计划。刷新动态表时添加 `explain` 可以用来查看动态表的执行计划，同时 Lakehouse 会输出是否是增量计划字段 `CanBeIncrementalized`。如果为 `Yes` 表示执行的是增量计划。如果输出为 `No` 表示不是增量计划，并会给出原因（No because ...）。
+
+**具体案例**
+
+```SQL
+set cz.optimizer.explain.can.incrementalize=true;
+explain refresh dynamic table event_gettime;
+```
+
+![](.topwrite/assets/image_1720597444254.png)
+
+# 使用Show命令查看动态表刷新模式
+通过 `show dynamic table refresh history` 查看。输出的字段中，`refresh_mode` 可以查看是否是增量刷新，`stats` 字段记录了增量刷新的条数。
+
+
+**语法**
+
+```SQL
+ SHOW DYNAMIC TABLE REFRESH HISTORY [where <expr>] [LIMIT num];
+```
+
+**参数说明**
+
+* `WHERE <expr>`:WHERE \<expr>:(可选)支持用户根据`SHOW JOBS`命令显示的字段进行筛选。用户可以通过表达式对结果进行过滤，以便更精确地查找所需的数据。
+* `LIMIT num`：（可选）限制返回的作业记录数量，范围为1-10000。
+
+**返回结果**
+
+
+
+|            字段        |                            说明                                               |
+| ------------------ | ------------------------------------------------------------------------- |
+| workspace\_name    | 工作空间名称                                                                    |
+| schema\_name       | schema名称                                                                  |
+| name               | 动态表名字                                                                     |
+| virtual\_cluster   | 使用的计算集群                                                                   |
+| start\_time        | 刷新开始时间，timestamp 类型                                                        |
+| end\_time          | 刷新结束时间，timestamp 类型                                                        |
+| duration           | 刷新耗时，interval类型                                                           |
+| state              | 作业状态                                                                      |
+| refresh\_trigger   | MANUAL(由用户调用refresh手动触发刷新,包含studio调度刷新) SYSTEM\_SCHEDULED（由lakehouse调度刷新） |
+| suspended\_reson   | 保留字段无特殊意义                                                                 |
+| refresh\_mode      | NO\_DATA, FULL, INCREMENTAL                                                 |
+| error\_message     | 刷新失败的信息                                                                   |
+| source\_tables     | 记录了 dynamic table 使用的基表名称                                                  |
+| stats              | 增量刷新条数等信息                                                                 |
+| completion\_target | 保留字段无特殊意义                                                                 |
+| job\_id            | 作业 ID，通过点击作业 ID 可以看到 job profile                                              |
+