@clickzetta/cz-cli-darwin-x64 0.3.1

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

@@ -0,0 +1,375 @@
+# 修改dynamic table
+
+Lakehouse 系统支持使用 `ALTER` 语句对动态表进行运维管理：
+
+* **暂停和启动调度任务**：控制由 Lakehouse 系统自动刷新的调度任务。
+* **表注释**：更新动态表的描述信息。
+* **列名**：修改现有列的名称。
+
+对于涉及 **SQL 查询逻辑变化** 的修改（即动态表定义中的 `SELECT` 加工过程），必须使用 `CREATE OR REPLACE` 语法。这是因为动态表与普通表不同，其定义包含了数据加工逻辑，而不仅仅是静态结构。以下需要使用CREATE OR REPLACE 语法修改。需要注意的是，如果用户不是简单的删除列/添加列（添加列定义：只能是从表一路经由 SELECT 透传的，不能参与任何会影响其他列的计算，例如 join key、group key 等），则在 CREATE OR REPLACE 发生后，REFRESH 任务会退化为一次全量刷新。
+
+* **调度周期**：调整调度任务的执行频率。
+* **计算集群**：指定用于处理动态表的计算资源。
+* **增加列**：动态表增加列，涉及到SQL语法结构变化。
+* **减列**：动态表减列，涉及到SQL语法结构变化。
+* **修改列类型**：涉及到SQL语法结构变化。
+* **修改动态表中SQL语法定义**：涉及到SQL语法结构变化。
+
+# 语法
+
+## 暂停Lakehouse系统刷新的调度任务
+
+```
+-- 暂停Lakehouse系统刷新的调度任务
+ALTER DYNAMIC TABLE dt_name SUSPEND;
+```
+
+## 启动Lakehouse系统刷新的调度任务
+
+```
+-- 启动Lakehouse系统刷新的调度任务
+ALTER DYNAMIC TABLE dt_name RESUME;
+```
+
+## 修改表的注释（COMMENT）
+
+```SQL
+-- 修改表的comment
+ALTER DYNAMIC TABLE dt_name SET COMMENT 'comment';
+```
+
+## 修改动态表中列的名称
+
+```
+ALTER DYNAMIC TABLE dt_name RENAME COLUMN column_name TO new_column_name;
+```
+
+示例
+
+```
+ALTER DYNAMIC TABLE change_table  RENAME COLUMN i TO ii;
+```
+
+## 修改动态表中列的注释（COMMENT）
+
+```
+ALTER DYNAMIC TABLE table_name CHANGE COLUMN column_name_identifier COMMENT 'comment'
+```
+
+案例
+
+```
+ALTER DYNAMIC TABLE change_table  CHANGE COLUMN ii COMMENT 'comment';
+```
+
+## 修改表的属性（PROPERTIES）
+
+功能：通过 ALTER DYNAMIC TABLE 命令，您可以为动态表设置或修改属性。目前为保留参数。
+
+语法：
+
+```
+--为动态表设置或修改属性
+ALTER DYNAMIC TABLE dt_name SET PROPERTIES("key"="value");
+--删除属性
+ALTER DYNAMIC TABLE dt_name SET PROPERTIES("key");
+```
+案例
+```
+--增加属性
+ALTER DYNAMIC TABLE dt_name set properties('aa'='bb');
+--修改属性
+ALTER DYNAMIC TABLE dt_name set properties('aa'='cc');
+--删除属性
+ALTER DYNAMIC TABLE dt_name unset properties('aa');
+
+```
+
+## 修改调度周期
+
+使用 CREATE OR REPLACE 语法，示例如下
+
+```
+--原表
+CREATE dynamic TABLE dt_name
+REFRESH   interval 10 MINUTE vcluster DEFAULT AS
+SELECT    *
+FROM      student02;
+
+--修改后
+CREATE OR  REPLACE dynamic TABLE dt_name
+REFRESH   interval 20 MINUTE vcluster DEFAULT AS
+SELECT    *
+FROM      student02;
+```
+
+## 修改计算集群
+
+使用 CREATE OR REPLACE 语法，示例如下
+
+```
+--原表
+CREATE dynamic TABLE dt_name
+REFRESH   interval 10 MINUTE vcluster DEFAULT AS
+SELECT    *
+FROM      student02;
+
+--修改后
+CREATE OR   REPLACE dynamic TABLE dt_name
+REFRESH   interval 10 MINUTE vcluster alter_vc AS
+SELECT    *
+FROM      student02;
+```
+
+## 增加列
+
+```SQL
+--创建一个基表
+DROP TABLE  IF EXISTS dy_base_a;
+CREATE TABLE dy_base_a (i int, j int);
+INSERT INTO dy_base_a VALUES
+(1,10),
+(2,20),
+(3,30),
+(4,40);
+--使用dynamic table进行加工
+DROP DYNAMIC TABLE IF EXISTS change_table;
+
+CREATE DYNAMIC TABLE change_table (i, j) AS
+SELECT    *
+FROM      dy_base_a;
+
+--刷新dynamic table
+REFRESH   DYNAMIC TABLE change_table;
+
+--查询数据
+SELECT    *
+FROM      change_table;
++---+----+
+| i | j  |
++---+----+
+| 1 | 10 |
+| 2 | 20 |
+| 3 | 30 |
+| 4 | 40 |
++---+----+
+
+--添加一列col
+CREATE OR REPLACE DYNAMIC TABLE change_table (i, j, col) AS
+SELECT    i,
+          j,
+          j * 1
+FROM      dy_base_a;
+
+--下次刷新会进行全量刷新，因为新增了加工逻辑
+REFRESH   DYNAMIC TABLE change_table;
++---+----+-----+
+| i | j  | col |
++---+----+-----+
+| 1 | 10 | 10  |
+| 2 | 20 | 20  |
+| 3 | 30 | 30  |
+| 4 | 40 | 40  |
++---+----+-----+
+
+```
+
+## 减列
+
+```
+DROP      TABLE IF EXISTS dy_base_a;
+
+CREATE    TABLE dy_base_a (i int, j int);
+
+INSERT    INTO dy_base_a
+VALUES    (1, 10),
+          (2, 20),
+          (3, 30),
+          (4, 40);
+
+--使用dynamic table进行加工
+DROP DYNAMIC TABLE IF EXISTS change_table;
+
+CREATE DYNAMIC TABLE change_table (i, j) AS
+SELECT    *
+FROM      dy_base_a;
+
+--刷新dynamic table
+REFRESH   DYNAMIC TABLE change_table;
+
+--查询数据
+SELECT    *
+FROM      change_table;
++---+----+
+| i | j  |
++---+----+
+| 1 | 10 |
+| 2 | 20 |
+| 3 | 30 |
+| 4 | 40 |
++---+----+
+
+--减列
+CREATE OR REPLACE DYNAMIC TABLE change_table (i, j) AS
+SELECT    i,
+          j
+FROM      dy_base_a;
+
+--此时表中查询会少一列，刷新为增量刷新。
+SELECT    *
+FROM      change_table;
++---+----+
+| i | j  |
++---+----+
+| 1 | 10 |
+| 2 | 20 |
+| 3 | 30 |
+| 4 | 40 |
++---+----+
+```
+
+## 修改SQL语法定义
+
+```SQL
+--创建一个基表
+DROP      TABLE IF EXISTS dy_base_a;
+
+CREATE    TABLE dy_base_a (i int, j int);
+
+INSERT    INTO dy_base_a
+VALUES    (1, 10),
+          (2, 20),
+          (3, 30),
+          (4, 40);
+--使用dynamic table进行加工
+DROP DYNAMIC TABLE IF EXISTS change_table;
+
+CREATE DYNAMIC TABLE change_table (i, j) AS
+SELECT    *
+FROM      dy_base_a;
+
+--刷新dynamic table
+REFRESH   DYNAMIC TABLE change_table;
+--查询数据
+SELECT    *
+FROM      change_table;
++---+----+
+| i | j  |
++---+----+
+| 1 | 10 |
+| 2 | 20 |
+| 3 | 30 |
+| 4 | 40 |
++---+----+
+
+--修改where过滤条件
+CREATE OR  REPLACE DYNAMIC TABLE change_table (i, j) AS
+SELECT    *
+FROM      dy_base_a
+WHERE     i > 3;
+
+--此时刷新会全量刷新一次
+REFRESH   DYNAMIC TABLE change_table;
+
+SELECT    *
+FROM      change_table;
++---+----+
+| i | j  |
++---+----+
+| 4 | 40 |
++---+----+
+
+
+```
+
+## 修改列类型
+
+如果是兼容类型例如int变成bigint。具体兼容类型可以[参考修改列类型](ALTER-TABLE-COLUMN.md)则会增量刷新
+
+```SQL
+--创建一个基表
+DROP      TABLE IF EXISTS dy_base_a;
+
+CREATE    TABLE dy_base_a (i int, j int);
+
+INSERT    INTO dy_base_a
+VALUES    (1, 10),
+          (2, 20),
+          (3, 30),
+          (4, 40);
+
+--使用dynamic table进行加工
+DROP DYNAMIC TABLE IF EXISTS change_table;
+
+CREATE DYNAMIC TABLE change_table (i, j) AS
+SELECT    *
+FROM      dy_base_a;
+
+--刷新dynamic table
+REFRESH   DYNAMIC TABLE change_table;
+
+--查询数据
+SELECT    *
+FROM      change_table;
++---+----+
+| i | j  |
++---+----+
+| 1 | 10 |
+| 2 | 20 |
+| 3 | 30 |
+| 4 | 40 |
++---+----+
+
+--修改列类型，
+CREATE OR  REPLACE DYNAMIC TABLE change_table (i, j) AS
+SELECT    cast(i AS bigint),
+          j
+FROM      dy_base_a;
+
+REFRESH   DYNAMIC TABLE change_table;
+
+DESC change_table;
++-------------+-----------+---------+
+| column_name | data_type | comment |
++-------------+-----------+---------+
+| i           | bigint    |         |
+| j           | int       |         |
++-------------+-----------+---------+
+
+```
+
+## 使用示例
+
+1. 暂停名为 "dynamic_sales" 的动态表的调度任务：
+
+```SQL
+ALTER DYNAMIC TABLE dynamic_sales SUSPEND;
+```
+
+2. 启动名为 "dynamic_inventory" 的动态表的调度任务：
+
+```SQL
+ALTER DYNAMIC TABLE dynamic_inventory RESUME;
+```
+
+3. 对于设置过 refreshOption 的动态表 dt_name，修改刷新任务使用的计算资源
+
+```SQL
+CREATE dynamic TABLE dt_name
+REFRESH   interval 10 MINUTE vcluster DEFAULT AS
+SELECT    *
+FROM      student02;
+
+CREATE OR  REPLACE dynamic TABLE dt_name
+REFRESH   interval 10 MINUTE vcluster alter_vc AS
+SELECT    *
+FROM      student02;
+```
+
+4. 修改已有的动态表注释（COMMENT）
+
+```
+ALTER DYNAMIC TABLE bulk_order_items_dt SET COMMENT 'comment';
+```
+
+^

package/bin/skills/lakehouse-doc/references/alter-external-schema.md

@@ -0,0 +1,20 @@
+# 修改Schema属性
+
+在本篇文档中，我们将为您介绍如何修改 Schema 的属性，以便更好地满足您的需求。我们将详细说明如何使用 ALTER SCHEMA 命令来设置和修改 Schema 的属性（PROPERTIES），并提供一些常见的使用示例。
+
+## 使用 ALTER SCHEMA 命令修改 Schema 属性
+
+要修改 Schema 的属性，您可以使用以下 ALTER SCHEMA 命令：
+
+```SQL
+ALTER SCHEMA scname SET PROPERTIES ('property_key'='property_value');
+```
+
+其中，`scname` 是您要修改的 Schema 名称，`property_key` 是要修改的属性键名，`property_value` 是对应的属性值。
+
+## 权限要求
+
+要执行此操作，您需要拥有对应 Schema 的 ALTER 权限。
+
+
+

package/bin/skills/lakehouse-doc/references/alter-materialzied-view.md

@@ -0,0 +1,238 @@
+# 修改物化视图
+支持使用 ALTER 语句对 MATERIALIZED VIEW 进行运维管理，包括暂停和启动由 Lakehouse 系统刷新的调度任务。当创建 MATERIALIZED VIEW 时，使用 refreshOption 语法，可以通过以下语句来控制任务的执行状态。
+
+有关更多详细信息，请参阅[物化视图](<MATERIALIZEDVIEW.md>)。
+
+## 功能说明
+Lakehouse 系统支持使用 `ALTER` 语句对物化视图进行运维管理：
+* **暂停和启动调度任务**：控制由 Lakehouse 系统自动刷新的调度任务。
+* **表注释**：更新物化视图的描述信息。
+* **列名**：修改现有列的名称。
+
+对于涉及 **SQL 查询逻辑变化** 的修改（即物化视图定义中的 `SELECT` 加工过程），必须使用 `CREATE OR REPLACE` 语法。这是因为动态表与普通表不同，其定义包含了数据加工逻辑，而不仅仅是静态结构。以下修改需要使用 CREATE OR REPLACE 语法：
+* **调度周期**：调整调度任务的执行频率。
+* **计算集群**：指定用于处理物化视图的计算资源。
+* **增加列**：物化视图增加列，涉及到SQL语法结构变化。
+* **减列**：物化视图删除列，涉及 SQL 语法结构变化。
+* **修改列类型**：涉及 SQL 语法结构变化。
+* **修改物化视图中 SQL 语法定义**：涉及 SQL 语法结构变化。
+
+
+# 语法
+
+## 暂停 Lakehouse 系统刷新的调度任务
+
+```
+-- 暂停Lakehouse系统刷新的调度任务
+ALTER MATERIALIZED VIEW dt_name SUSPEND;
+```
+
+## 启动 Lakehouse 系统刷新的调度任务
+
+```
+-- 启动Lakehouse系统刷新的调度任务
+ALTER MATERIALIZED VIEW mv_name RESUME;
+```
+
+## 修改表的注释（comment）
+
+```SQL
+-- 修改表的comment
+ALTER TABLE mv_name SET COMMENT 'comment';
+```
+
+## 修改物化视图中列的名称
+
+```
+ALTER TABLE mv_name RENAME COLUMN column_name TO new_column_name;
+```
+
+## 案例
+
+```
+ALTER TABLE change_table  RENAME COLUMN i TO ii;
+```
+
+## 修改物化视图中列的注释（comment）
+
+```
+ALTER TABLE table_name CHANGE COLUMN column_name_identifier COMMENT 'comment'
+```
+
+## 案例
+
+```
+ALTER TABLE change_table  CHANGE COLUMN ii COMMENT 'comment';
+```
+## 修改表的属性
+
+功能：通过 ALTER TABLE 命令，您可以为外部表设置或修改属性。目前为保留参数。
+
+语法：
+
+```
+ALTER TABLE table_name SET PROPERTIES("key"="value");
+```
+
+## 修改调度周期
+
+```SQL
+--原表
+CREATE MATERIALIZED VIEW  mv_table
+REFRESH interval 10 minute vcluster default
+AS select * from student02;
+--修改后
+CREATE OR REPLACE MATERIALIZED VIEW  mv_table
+BUILD DEFERRED
+REFRESH
+interval 20 minute vcluster default
+DISABLE QUERY REWRITE
+AS select * from student02;
+
+--修改计算集群
+--原表
+CREATE MATERIALIZED VIEW  mv_table
+REFRESH
+interval 10 minute vcluster default
+AS select * from student02;
+--修改后
+CREATE OR REPLACE MATERIALIZED VIEW  mv_table
+BUILD DEFERRED 
+REFRESH interval 10 minute vcluster alter_vc
+DISABLE QUERY REWRITE
+AS select * from student02;
+```
+
+## 增加列
+
+```SQL
+--创建一个基表
+DROP TABLE  IF EXISTS mv_base_a;
+CREATE TABLE mv_base_a (i int, j int);
+INSERT INTO mv_base_a VALUES
+(1,10),
+(2,20),
+(3,30),
+(4,40);
+--使用MATERIALIZED VIEW进行加工
+DROP MATERIALIZED VIEW   IF EXISTS mv_table;
+CREATE  MATERIALIZED VIEW mv_table
+(i,j)
+AS select * from mv_base_a;
+--刷新MATERIALIZED VIEW
+refresh MATERIALIZED VIEW mv_table;
+--查询数据
+select * from mv_table;
++---+----+
+| i | j  |
++---+----+
+| 1 | 10 |
+| 2 | 20 |
+| 3 | 30 |
+| 4 | 40 |
++---+----+
+--添加一列col
+CREATE OR REPLACE MATERIALIZED VIEW mv_table
+(i,j,col)
+BUILD DEFERRED DISABLE QUERY REWRITE
+AS select i,j,j*1 from mv_base_a;
+--下次刷新会进行全量刷新，因为新增了加工逻辑
+refresh MATERIALIZED VIEW mv_table;
+SELECT * FROM mv_table;
++---+----+-----+
+| i | j  | col |
++---+----+-----+
+| 1 | 10 | 10  |
+| 2 | 20 | 20  |
+| 3 | 30 | 30  |
+| 4 | 40 | 40  |
++---+----+-----+
+```
+
+## 减列
+
+```SQL
+DROP TABLE  IF EXISTS mv_base_a;
+CREATE TABLE mv_base_a (i int, j int);
+INSERT INTO mv_base_a VALUES
+(1,10),
+(2,20),
+(3,30),
+(4,40);
+--使用MATERIALIZED VIEW进行加工
+DROP MATERIALIZED VIEW  IF EXISTS mv_table;
+CREATE  MATERIALIZED VIEW mv_table
+(i,j)
+AS select * from mv_base_a;
+--刷新MATERIALIZED VIEW
+refresh MATERIALIZED VIEW mv_table;
+--查询数据
+select  * from mv_table;
++---+----+
+| i | j  |
++---+----+
+| 1 | 10 |
+| 2 | 20 |
+| 3 | 30 |
+| 4 | 40 |
++---+----+
+--物化视图修改：减列
+CREATE OR REPLACE MATERIALIZED VIEW mv_table
+(i,j)
+BUILD DEFERRED DISABLE QUERY REWRITE
+AS select i,j from mv_base_a;
+--此时表中查询会少一列，刷新为增量刷新。
+select * from mv_table;
++---+----+
+| i | j  |
++---+----+
+| 1 | 10 |
+| 2 | 20 |
+| 3 | 30 |
+| 4 | 40 |
++---+----+
+```
+
+## 修改 SQL 语法定义
+
+```SQL
+--创建一个基表
+DROP TABLE  IF EXISTS mv_base_a;
+CREATE TABLE mv_base_a (i int, j int);
+INSERT INTO mv_base_a VALUES
+(1,10),
+(2,20),
+(3,30),
+(4,40);
+--使用MATERIALIZED VIEW进行加工
+DROP MATERIALIZED VIEW  IF EXISTS mv_table;
+CREATE MATERIALIZED VIEW mv_table
+(i,j)
+AS select * from mv_base_a;
+--刷新MATERIALIZED VIEW
+refresh MATERIALIZED VIEW mv_table;
+--查询数据
+select * from mv_table;
++---+----+
+| i | j  |
++---+----+
+| 1 | 10 |
+| 2 | 20 |
+| 3 | 30 |
+| 4 | 40 |
++---+----+
+--修改where过滤条件
+CREATE OR REPLACE MATERIALIZED VIEW mv_table
+(i,j)
+BUILD DEFERRED DISABLE QUERY REWRITE
+AS select * from mv_base_a where i>3;
+--此时刷新会全量刷新一次
+refresh MATERIALIZED VIEW mv_table;
+select * from mv_table;
++---+----+
+| i | j  |
++---+----+
+| 4 | 40 |
++---+----+
+```
+

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

@@ -0,0 +1,43 @@
+# 修改分享对象（SHARE）
+
+## 功能描述
+
+该语句用于修改分享对象（SHARE）。您可以使用此语句为分享对象添加或移除目标服务实例（INSTANCE）。
+
+## 语法
+
+```SQL
+ALTER SHARE <share_name> [ADD | REMOVE] INSTANCE <instance_name>;
+```
+
+## 参数说明
+
+1. **share_name**：需要修改的分享对象名称。
+2. **ADD | REMOVE**：对分享对象的操作，ADD 表示添加分享目标服务实例，REMOVE 表示移除已分享的服务实例。
+3. **instance_name**：服务实例的名称，需确保全局唯一。服务消费端用户可以在首页右侧或在服务实例的 URL 中找到自己的服务实例名称，并提供给分享者进行配置。
+
+## 使用示例
+
+**添加分享目标服务实例**
+
+假设您创建了一个名称为`SHARE_DEMO`的分享对象，其 `kind` 属性为 ‘OUTBOUND’，想要将其分享给名为`instancedemo`的服务实例，可以使用以下语句：
+
+```SQL
+ALTER SHARE SHARE_DEMO ADD INSTANCE instancedemo;
+```
+
+**移除分享目标服务实例**
+
+如果您创建了一个名称为`SHARE_DEMO`的分享对象，并且已分享给名为 `instancedemo` 的服务实例，想要收回对该服务实例的分享，可以使用以下语句：
+
+```SQL
+ALTER SHARE SHARE_DEMO REMOVE INSTANCE instancedemo;
+```
+
+## 注意事项
+
+* 确保在执行此操作时，已登录到具有相应权限的账户。
+* 在添加或移除分享目标服务实例时，请确保输入的实例名称正确无误。
+* 对 SHARE 对象执行 REMOVE INSTANCE 后，目标服务实例会立即失去使用该分享数据的权限。请谨慎操作，确认操作影响。
+
+通过以上步骤，您可以轻松地管理分享对象及其关联的服务实例。

package/bin/skills/lakehouse-doc/references/alter-user.md

@@ -0,0 +1,13 @@
+## 功能
+
+修改用户属性，设置用户的默认执行集群和默认 Schema
+
+## 语法
+```
+ALTER USER user_name SET
+[DEFAULT_VCLUSTER= vc_name] 
+[DEFAULT_SCHEMA=schema_name]
+```
+**1. DEFAULT_VCLUSTER**: 为用户指定默认的计算资源。如果未指定，则使用全局默认计算资源。
+
+**2. DEFAULT_SCHEMA**: 为用户指定默认的模式（schema）。如果用户未指定默认模式，登录时需要指定要访问的模式，否则会报错。如果指定了默认模式，用户登录时将默认使用该模式。在会话中使用 `USE` 命令可以切换到其他模式。优先级：`USE` 命令 > 默认模式。