@clickzetta/cz-cli-darwin-x64 0.3.1

package/bin/skills/lakehouse-doc/references/create-vector-index.md

@@ -0,0 +1,115 @@
+### 创建向量索引
+
+**语法**
+
+```SQL
+CREATE TABLE table_name(
+  columns_difinition,
+  INDEX index_name (column_name) USING VECTOR  PROPERTIES(
+      "property1" = "value1",
+      "property2" = "value2"
+  )
+);
+```
+
+**columns\_difinition**：定义表的字段信息，最后一个字段必须使用逗号隔开
+
+**INDEX**：关键字
+
+**index\_name**：自定义index的名称
+
+**column\_name**：需要添加索引的字段名称
+
+**VECTOR**：关键字，表示向量索引
+
+**COMMENT**：指定index的说明信息
+
+**PROPERTIES**：指定向量INDEX的参数
+
+| 参数名称                       | 可选值                                                                  | 默认值              | 备注                                         |
+| -------------------------- | -------------------------------------------------------------------- | ---------------- | ------------------------------------------ |
+| distance.function          | l2\_distance, cosine\_distance, jaccard\_distance, hamming\_distance | cosine\_distance | -                                          |
+| scalar.type                | f32, f16, i8, b1                                                     | f32              | 向量索引中的向量元素类型，可与 vector column 不一致          |
+| m                          | 建议不超过1000                                                            | 16               | HNSW算法中的最大邻居数                              |
+| ef.construction            | 建议不超过5000                                                            | 128              | HNSW算法构建索引时的候选集大小                          |
+| reuse.vector.column        | false/true                                                           | false            | 是否复用 vector column 的数据以节省存储空间              |
+| compress.codec             | uncompressed/zstd/lz4                                                | uncompressed     | 向量索引的压缩算法；复用column时不生效                     |
+| compress.level             | fatest/default/best                                                  | default          | 压缩算法级别                                     |
+| compress.byte.stream.split | false/true                                                           | true             | 压缩前重排 float bit                            |
+| compress.block.size        | 大于1M的整数                                                              | 16777216         | 压缩块大小                                      |
+| conversion.rule            | default/as\_bits                                                     | default          | 需要把 vector(tinyint, N) 类型按位建索引时使用 as\_bits |
+
+**向量索引标量类型与列类型**
+
+索引元素类型 指的是 properites 中 scalar.type 指定的类型；两者类型不一致时，会执行一定的转换规则（多数情况下是 cast），当使用 b1 类型时除外。
+
+|        |                     |                                                                                                              |
+| ------ | ------------------- | ------------------------------------------------------------------------------------------------------------ |
+| 索引元素类型 | 支持的向量元素类型           | 备注                                                                                                           |
+| b1     | tinyint, int, float | "conversion.rule" = "bits" 时，会把 vector(tinyint, N) 中的每个bit当成向量中的一个元素 "conversion.rule" = "default" 时，会将向量二值化 |
+| i8     | tinyint, int, float | 向量元素类型与索引不一致时，执行 cast (注意可能会 overflow)                                                                       |
+| f16    | int, float          | 向量元素类型与索引不一致时，执行 cast                                                                                        |
+| f32    | int, float          | 向量元素类型与索引不一致时，执行 cast                                                                                        |
+
+**案例**
+
+```SQL
+CREATE TABLE test_vector1 (
+    vec vector(float, 4),
+    id int,
+    index test_vector1_vec_idx  (vec) using vector properties (
+        "scalar.type" = "f32",
+        "distance.function" = "l2_distance"
+    )
+)
+```
+
+## 参考文档
+
+* [构建索引](build-inverted-index.md)
+* [删除索引](DROP-INDEX.md)
+* [列出所有索引](SHOW-INDEX.md)
+* [查看索引详情](DESC-INDEX.md)
+
+## 使用说明
+
+[向量索引使用说明](vector-search.md)
+
+### 已有的表增加向量索引
+
+**语法**
+
+```SQL
+CREATE  VECTOR INDEX [IF NOT EXISTS] index_name ON TABLE 
+[schema].table_name(col_name) PROPERTIES(
+    "property1" = "value1",
+    "property2" = "value2"
+)
+```
+
+**VECTOR**:索引类型，向量索引
+
+**index\_name**: 表名字，位于schema下，schema下索引名称不能重复
+
+**PROPERTIES**：指定INDEX的参数
+
+**说明**
+
+执行CREATE INDEX仅对新增数据有效
+
+**案例**
+
+```SQL
+CREATE TABLE test_vector2 (
+    vec vector(float, 512),
+    id int
+) ;
+
+ CREATE VECTOR INDEX test_vector2_vec_idx
+ ON TABLE  test_vector2(vec) PROPERTIES (
+        "scalar.type" = "f32",
+        "distance.function" = "l2_distance"
+ );
+```
+
+^

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

@@ -0,0 +1,46 @@
+# 功能描述
+
+创建指定类型的对象
+
+# 语法
+
+```
+CREATE  <object_type> [ IF NOT EXISTS ] <object_name>
+COMMENT ''
+```
+
+## 具体的语法参考
+
+[CREATE USER](CREAREUSER.md)
+
+[CREATE ROLE](CREATEROLE.md)
+
+[CREATE CONNECTION](CREATECONNECTION.md)
+
+[CREATE EXTERNAL CATALOG](create-external-catalog.md)
+
+[CREATE EXTERNAL FUNCTION](CREATE_EXTERNATL_FUNCTION.md)
+
+[CREATE SCHEMA](CREATESCHEMA.md)
+
+[CREATE EXTERNAL SCHEMA](CREATEEXTERNAlLSCHEMA.md)
+
+[CREATE SHARE](create-share.md)
+
+[CREATE VCLUSTER](create_cluster.md)
+
+[CREATE TABLE](create-table-ddl.md)
+
+[CREATE EXTERNAL TABLE](create-external-table.md)
+
+[CREATE VIEW](CREATEVIEW.md)
+
+[CREATE DYNAMIC TABLE](create-dynamic-table.md)
+
+[CREATE MATERIALIZED VIEW](CREATEMATERIALIZEDVIEW.md)
+
+[CREATE BLOOMFILTER INDEX](CREATE-BLOOMFILTER-INDEX.md)
+
+[CREATE TABLE STREAM](create-table-stream.md)
+
+[CREATE SYNONYM](create-synonym.md)

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

@@ -0,0 +1,121 @@
+# 创建计算集群
+
+## 功能描述
+
+本功能允许用户根据指定的名称和配置，在执行SQL的工作空间下创建计算集群。计算集群（Virtual-Cluster，简称：VCluster）是云器Lakehouse提供的计算资源集群服务，提供执行查询分析所需的CPU、内存、临时存储等资源。用户可以使用计算集群执行各类ETL、流式分析、即席查询及数据集成等作业。在Lakehouse中执行需要计算的SQL Select查询或各类DML操作（如DELETE,INSERT,UPDATE等）时，都将使用计算集群。
+
+计算集群包括通用型（GENERAL PURPOSE VIRTUAL CLUSTER，简称：GP类型）、分析型（ANALYTICS PURPOSE VIRTUAL CLUSTER，简称：AP类型）和同步型（INTEGRATION VIRTUAL CLUSTER）三种类型。
+
+通用型计算集群中，提交至计算集群的作业共享集群内的计算资源，适合处理离线作业；分析型集群具备多计算实例、自动弹缩的功能特性，适合处理在线、高并发类的作业。同步型集群专门用于数据集成任务。
+
+## 语法
+
+```SQL
+-- 创建计算集群
+CREATE VCLUSTER [IF NOT EXISTS] <name>
+objectProperties
+[COMMENT '']
+
+--参数说明 
+--创建分析型计算集群（ANALYTICS PURPOSE VIRTUAL CLUSTER）适用属性           
+objectProperties ::=
+            VCLUSTER_SIZE = num --1至256的整数，且须为2的n次幂。
+            VCLUSTER_TYPE = ANALYTICS
+            MIN_REPLICAS = num
+            MAX_REPLICAS = num
+            AUTO_SUSPEND_IN_SECOND = num
+            AUTO_RESUME = TRUE| FALSE
+            MAX_CONCURRENCY = num
+            QUERY_RUNTIME_LIMIT_IN_SECOND = num
+            PRELOAD_TABLES = "<schema_name>.<table_name>[,<schema_name>.<table_name>,...]"
+            
+            
+--创建通用型计算集群（GENERAL PURPOSE VIRTUAL CLUSTER）适用属性             
+objectProperties ::=
+            [VCLUSTER_SIZE = num | MIN_VCLUSTER_SIZE=num  MAX_VCLUSTER_SIZE=num] --1至256的整数 
+            VCLUSTER_TYPE = GENERAL 
+            AUTO_SUSPEND_IN_SECOND = num
+            AUTO_RESUME = TRUE| FALSE
+            QUERY_RUNTIME_LIMIT_IN_SECOND = num
+            QUERY_RESOURCE_LIMIT_RATIO=num;
+
+--创建同步型计算集群（INTEGRATION VIRTUAL CLUSTER）适用属性             
+objectProperties ::=
+            [VCLUSTER_SIZE = num | MIN_VCLUSTER_SIZE=num  MAX_VCLUSTER_SIZE=num] --0.25、0.5或者1至256的整数 
+            VCLUSTER_TYPE = INTEGRATION 
+            AUTO_SUSPEND_IN_SECOND = num
+            AUTO_RESUME = TRUE| FALSE
+            QUERY_RUNTIME_LIMIT_IN_SECOND = num
+            QUERY_RESOURCE_LIMIT_RATIO=num;
+```
+
+**1. name**：计算集群的名字。在工作空间内唯一，创建后不可变更。命名规则为：3到28个字符，仅支持字母、下划线、十进制数字 (0-9)，不允许有空格。
+
+**2. objectProperties**：创建计算集群可以指定的属性，属性的具体含义和取值如下：
+
+| 字段名称                              | 字段含义                                                                                                                      | 取值范围                                                               | 默认值     |
+| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | ------- |
+| VCLUSTER\_SIZE                    | 计算集群规格。支持从1 CRU到256 CRU的规格，算力依次加大。（分析型集群须为2的n次幂，同步型集群单独支持0.25 CRU和0.5 CRU两种小规格）                                           | 数字：1-256，单位为 CRU（Compute Resource Unit）。                           | 1       |
+| MIN\_VCLUSTER\_SIZE               | 仅通用型（GENERAL）集群适用。&#xA;计算集群弹缩时的最小规格，支持从1 CRU到256 CRU的规格，需要小于等于MAX\_VCLUSTER\_SIZE参数。不可与VCLUSTER\_SIZE同时使用。                | 数字：1-256，单位为 CRU（Compute Resource Unit）。                           | 无       |
+| MAX\_VCLUSTER\_SIZE               | 仅通用型（GENERAL）集群适用。&#xA;计算集群弹缩时的最大规格，支持从1 CRU到256 CRU的规格，需要大于等于MIN\_VCLUSTER\_SIZE参数。不可与VCLUSTER\_SIZE同时使用。                | 数字：1-256，单位为 CRU（Compute Resource Unit）。                           | 无       |
+| VCLUSTER\_TYPE                    | 计算集群类型。&#xA;GENERAL：适用于数据摄取和ELT操作；&#xA;ANALYTICS：适用于查询Latency和并发能力有强保障需求的场景。&#xA;INTEGRATION：用于数据集成任务场景。                  | GENERAL \| ANALYTICS \| INTEGRATION                                 | GENERAL |
+| MIN\_REPLICAS                     | 计算集群最小实例数。仅适用于分析型计算集群。                                                                                                    | 1-10                                                               | 1       |
+| MAX\_REPLICAS                     | 计算集群最大实例数。仅适用于分析型计算集群。                                                                                                    | 1-10                                                               | 1       |
+| AUTO\_SUSPEND\_IN\_SECOND         | 集群自动关闭的空闲时长。单位：秒。                                                                                                         | 取值 -1或大于等于15的整数。&#xA;-1表示不自动停止。                                    | 600     |
+| AUTO\_RESUME                      | 是否自动恢复。                                                                                                                   | TRUE \| FALSE                                                         | TRUE    |
+| MAX\_CONCURRENCY                  | 计算集群中每个计算实例可负载的最大并发数。仅适用于分析型计算集群。                                                                                         | 1-32                                                               | 8       |
+| QUERY\_RUNTIME\_LIMIT\_IN\_SECOND | 提交至该计算集群上的作业，可执行的最大时长。单位：秒。                                                                                               | 大于0的整数。                                                            | 86400   |
+| PRELOAD\_TABLES                   | 计算集群可通过配置preload\_table，定时或被触发拉取preload\_table中指定的表数据到计算集群本地的SSD硬盘上进行缓存。您还可以在表上[设置缓存策略](create-table-ddl.md)。仅适用于分析型计算集群。 | schema\_name.table\_name，多个表名称之间用英文逗号分隔。支持通配符，例如：sample\_schema.\* | null    |
+| QUERY\_RESOURCE\_LIMIT\_RATIO     | **单作业资源占比阈值**,单个查询任务可使用的CPU/内存资源不超过集群总资源的指定比例                                                                             | `0.0` \~ `1.0`（如 `0.1` 表示10%）                                      | 1.0     |
+
+> 注：计算集群的vcluster\_size参数同时支持以T-shirt size（XSMALL、SMALL、Large等）和以数字（1,2,4,16等）表达的方式，以提供更丰富的计算集群规格，满足不同场景的需要。更多信息详见：[计算集群规格代码变更说明](vcluster_size_description.md)
+
+**3.创建时指定 GP 型 VC 的最大和最小值**
+
+```SQL
+CREATE VCLUSTER [IF NOT EXISTS] <name> 
+VCLUSTER_TYPE=GENERAL 
+MIN_VCLUSTER_SIZE=num 
+MAX_VCLUSTER_SIZE=num;
+```
+
+* VCLUSTER\_SIZE、MIN\_VCLUSTER\_SIZE 和 MAX\_VCLUSTER\_SIZE 不能同时设置。
+
+**4. comment**
+指定计算集群的说明信息，最大支持1024个字符。
+
+## 使用示例
+
+1. 使用默认属性创建计算集群：
+
+   ```SQL
+   CREATE VCLUSTER sample_vc;
+   ```
+
+2. 指定创建通用型计算集群，XSMALL规格，自动启动，自动停止时间为60秒，作业最大执行时间为600秒：
+
+   ```SQL
+   CREATE VCLUSTER demo_gp_vcluster 
+   VCLUSTER_SIZE = 1 
+   VCLUSTER_TYPE = GENERAL 
+   AUTO_SUSPEND_IN_SECOND = 60 
+   AUTO_RESUME = TRUE 
+   QUERY_RUNTIME_LIMIT_IN_SECOND = 600;
+   ```
+
+指定创建分析型计算集群，XSMALL规格，自动启动，自动停止时间为1分钟，最小实例数1，最大实例数2，每实例最大并发数为16，作业最大执行时间为600秒，预加载public.demo和billing.payment表的数据，每600秒拉取一次表数据缓存：
+
+```
+CREATE VCLUSTER demo_ap_vcluster 
+VCLUSTER_SIZE = 1
+VCLUSTER_TYPE = ANALYTICS
+MIN_REPLICAS = 1
+MAX_REPLICAS = 2
+MAX_CONCURRENCY = 16
+AUTO_SUSPEND_IN_SECOND = 60 
+AUTO_RESUME = TRUE 
+QUERY_RUNTIME_LIMIT_IN_SECOND = 600
+PRELOAD_TABLES = 'public.demo,billing.payment';
+```
+
+^

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

@@ -0,0 +1,37 @@
+# 创建阿里云私网连接终端节点
+
+当您需要在云厂商 VPC 内通过内网访问云器 Lakehouse 服务时，您需要在阿里云创建连接云器 Lakehouse 终端节点服务的终端节点。然后，将访问云器 Lakehouse 的 JDBC 连接或 API 的域名替换为终端节点的域名。
+
+:-: ![](.topwrite/assets/privatelink客户访问LH-例子.png)
+
+## 操作步骤
+
+1\. **添加白名单**。首先请将您的云平台账号（角色）添加至云器 Lakehouse 私有网络连接的白名单中。如下图所示：
+
+:-: ![](.topwrite/assets/image_1733063925523.png =708)
+
+为保障 Lakehouse 能够正常读取您的终端节点状态，并增强获取您云服务平台内终端节点信息的安全性，请在云服务平台内创建独立的访问控制角色，并授权及添加 External ID。
+
+**ARN 和 External ID 值获取**：
+
+在阿里云“RAM 访问控制” > “角色”页面，选择希望添加其 ARN 的访问控制角色，分别复制其 ARN 和 External ID 的值。然后，回到云器 Lakehouse 页面，在添加白名单弹窗中，分别将上述两项内容复制到对应的选项中。 
+
+该角色的权限配置和 External ID 配置详见[获取阿里云ARN和ExternalID](alicloud-arn-externalid.md)。
+
+:-: ![](.topwrite/assets/image_1733069144028.png =684)
+
+^
+
+:-: ![](.topwrite/assets/image_1733069236299.png =366)
+
+2\. **创建终端节点**。在阿里云控制台的“终端节点”页面中，点击“新建终端节点”按钮。在“所属地域”中选择与 Lakehouse 服务相同的地域，并在页面中选择“其他终端节点服务”，从 Lakehouse 服务中复制该区域的终端节点服务名称，填入此页面。
+
+:-: ![](.topwrite/assets/image_1733063937656.png =683)
+
+^
+
+:-: ![](.topwrite/assets/image_1733063950478.png =677)
+
+3\. **允许终端节点连接**。创建完成后，刷新 Lakehouse 中的“终端节点”页面，即可在列表中看到您已创建的终端节点，点击“允许连接”即可完成基于私网连接的网络互通配置。
+
+^

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

@@ -0,0 +1,31 @@
+# 创建阿里云终端节点服务
+
+当需要使用云器 Lakehouse 访问您在云厂商 VPC 内的服务（如自建的 MySQL 数据库）时，您首先需要在阿里云创建终端节点服务，并将需要被访问的服务配置为该终端节点服务的服务资源。
+
+:-: ![](.topwrite/assets/private_link访问客户-例子.png)
+
+## 操作步骤
+
+以下操作需要在阿里云控制台环境下完成。
+
+1\. 请参考https\://help.aliyun.com/zh/privatelink/user-guide/create-and-manage-endpoint-services? 完成前提条件，包括“开通私网连接服务”、“创建负载均衡实例”。
+
+2\. 在阿里云控制台左侧导航栏单击私有连接 - 终端节点服务 ，选择与当前Lakehouse服务实例相同的地域创建终端节点服务。您可以在 Lakehouse 服务的“创建终端节点服务”弹窗上方，找到当前服务实例所在的地域和可用区。请按照当前服务实例的地域和可用区创建终端节点服务，否则会导致 Lakehouse 无法创建对应的终端节点，从而无法建立 PrivateLink 连接。
+
+:-: ![](.topwrite/assets/image_1733063729452.png =381)
+
+3\. 请根据您在阿里云上服务的实际情况配置终端节点服务创建的其他选项。请注意，“服务付费者”选项请选择“服务提供方”，否则会影响正常创建连接。
+
+:-: ![](.topwrite/assets/image_1733063748752.png =636)
+
+4\. 在终端节点服务创建完成后，请点击终端节点的名称，进入终端节点服务详情页面，添加 Lakehouse 的云账号 ID 为白名单。
+
+:-: ![](.topwrite/assets/image_1733063764046.png =735)
+
+^
+
+:-: ![](.topwrite/assets/image_1733063781421.png =367)
+
+5\. 完成上述操作后，请回到Lakehouse页面。在“创建终端节点服务”弹窗中，填写上述步骤中创建的终端节点服务实例 ID（在阿里云终端节点服务详情页面中可找到）和名称，并点击 “确定” 。
+
+:-: ![](.topwrite/assets/image_1733063795296.png =442)

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

@@ -0,0 +1,33 @@
+# 创建腾讯云私网连接终端节点
+
+当您需要在云厂商 VPC 内通过内网访问云器 Lakehouse 服务时，您需要在腾讯云创建连接云器 Lakehouse 终端节点服务的终端节点。然后，将访问云器 Lakehouse 的 JDBC 连接或 API 的域名替换为终端节点的域名。
+
+:-: ![](.topwrite/assets/privatelink客户访问LH-例子.png)
+
+## 操作步骤
+
+1\. **添加白名单**。首先请将您的云平台账号（角色）添加至云器Lakehouse 私有网络连接的白名单中。如下图所示：
+
+:-: ![](.topwrite/assets/image_1732869126126.png =704)
+
+为保障 Lakehouse 能够正常读取您的终端节点状态，并增强从您云服务平台获取终端节点信息方式的安全性，请在云服务平台内创建独立的访问控制角色，并授权及添加 External ID。
+
+**查询 ARN 和 External ID**：
+
+在腾讯云访问控制角色列表页面，单击希望添加其 ARN 的角色名称，在角色详情中选择“角色载体”，分别复制该页面中的“**RoleArn**”和“**外部ID**”。回到云器 Lakehouse 页面，在添加白名单弹窗中，分别将上述两项内容复制到对应的输入框中。粘贴完成后，单击“确定”。
+
+该角色的权限配置和 External ID 配置详见 [获取腾讯云ARN和ExternalID](tencentcloud_arn_and_externalid.md)。
+
+:-: ![](.topwrite/assets/image_1733067670318.png =699)
+
+:-: ![](.topwrite/assets/image_1733067744128.png =703)
+
+^
+
+:-: ![](.topwrite/assets/image_1733067854956.png =377)
+
+2\. **新建终端节点**。在终端节点页面点击“新建”按钮，“对端账户类型”选择“其他账户”。然后，在“对端账户 UIN”和“对端终端节点服务 ID”中，分别填入从 Lakehouse 页面复制的“Lakehouse UID”和“终端节点服务 ID”。点击“确定”。
+
+:-: ![](.topwrite/assets/image_1733063999441.png =378)
+
+3\. **允许终端节点连接**。创建完成后，刷新![](.topwrite/assets/image_1733110508458.png =27)Lakehouse中“终端节点”页面，即可在列表中看到您已创建的终端节点，点击“允许连接”即可完成基于私有连接的网络互通配置。

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

@@ -0,0 +1,19 @@
+# 腾讯云
+
+当需要使用云器 Lakehouse 访问你在云厂商 VPC 内的服务（如自建的 MySQL 数据库）时，你首先需要在腾讯云创建终端节点服务，并将需要被访问的服务配置为该终端节点服务的服务资源。
+
+:-: ![](.topwrite/assets/private_link访问客户-例子.png)
+
+## 操作步骤
+
+1\. 在腾讯云的网络连接-终端节点服务页面，选择与当前Lakehouse服务实例相同的地域创建终端节点服务。您可以在Lakehouse服务“创建终端节点服务”的弹窗上方找到当前服务实例所在的地域和可用区。请按照当前服务实例的地域和可用区创建终端节点服务，否则会导致Lakehouse无法创建对应的终端节点而无法建立PrivateLink。
+
+:-: ![](.topwrite/assets/image.png =412)
+
+2\. 完成终端节点服务创建后，点击终端节点服务名称，进入详情页。切换到“白名单”页签，点击“添加”按钮，添加Lakehouse服务的UIN。您可在Lakehouse服务新建终端节点服务的信息弹窗中复制“Lakehouse UID”填入。
+
+:-: ![](.topwrite/assets/image.png =412)
+
+3\. 完成后，请复制您的终端节点服务ID，并粘贴在Lakehouse的创建页面中，点击“确定”即完成终端节点服务的创建。
+
+:-: ![](.topwrite/assets/image_1733063879303.png =408)