@clickzetta/cz-cli-darwin-x64 0.3.1

package/bin/skills/lakehouse-doc/references/sql_functions/scalar_functions/string_functions/trim.md

@@ -0,0 +1,54 @@
+### TRIM 函数
+
+```
+trim(str [, trimStr])
+```
+
+#### 功能描述
+TRIM 函数用于去除字符串 `str` 左右两侧的指定字符（或空格）。如果不指定 `trimStr` 参数，则默认去除字符串左右两侧的所有空格字符。
+
+#### 参数说明
+- `str` (string): 需要进行处理的原始字符串。
+- `trimStr` (string, 可选): 指定要去除的字符集，如果省略此参数，则默认去除空格字符。
+
+#### 返回结果
+返回处理后的字符串。
+
+#### 使用示例
+1. 去除字符串两端的空格：
+   ```sql
+   > SELECT '  Hello, World!  ' AS original, TRIM(original) AS trimmed;
+    +----------------+--------+
+    | original       | trimmed |
+    +----------------+--------+
+    |  Hello, World!  | Hello, World! |
+    +----------------+--------+
+   ```
+2. 去除字符串两端的特定字符（例如星号）：
+   ```sql
+   > SELECT '**Hello, World!**' AS original, TRIM('**Hello, World!**' ,'**' ) AS trimmed;
+    +----------------+--------+
+    | original       | trimmed |
+    +----------------+--------+
+    | **Hello, World!** | Hello, World! |
+    +----------------+--------+
+   ```
+3. 去除字符串左侧的零字符：
+   ```sql
+   > SELECT '000Hello, World!' AS original, TRIM('000Hello, World!', '0' ) AS trimmed;
+    +----------------+--------+
+    | original       | trimmed |
+    +----------------+--------+
+    | 000Hello, World! | Hello, World! |
+    +----------------+--------+
+   ```
+4. 去除字符串右侧的百分号：
+   ```sql
+   > SELECT 'Hello, World!%' AS original, TRIM('Hello, World!%', '%' ) AS trimmed;
+    +----------------+--------+
+    | original       | trimmed |
+    +----------------+--------+
+    | Hello, World!% | Hello, World! |
+    +----------------+--------+
+   ```
+

package/bin/skills/lakehouse-doc/references/sql_functions/scalar_functions/string_functions/typeof.md

@@ -0,0 +1,54 @@
+### TYPEOF
+```sql
+typeof(expr)
+```
+#### 功能
+返回表达式的数据类型。该函数用于查询表达式或列的类型信息，在动态 SQL 和类型检查场景中非常有用。
+
+#### 参数
+* `expr`：任意类型的表达式
+
+#### 返回结果
+* string 类型
+* 返回表达式的数据类型名称
+* 对于基本类型，返回类型名称（如 'int', 'string', 'boolean'）
+* 对于复杂类型，返回完整的类型定义（如 `array<...>`, `map<...>`, `struct<...>`）
+
+#### 举例
+```sql
+-- 基本类型
+> SELECT typeof(true);
+boolean
+
+> SELECT typeof(1);
+int
+
+> SELECT typeof(1.0);
+decimal(2,1)
+
+> SELECT typeof("1");
+string
+
+-- 复杂类型
+> SELECT typeof(array(1, 2, 3));
+array<int>
+
+> SELECT typeof(map(1, 2));
+map<int,int>
+
+> SELECT typeof(struct(1, 2, 3));
+struct<col1:int,col2:int,col3:int>
+
+```
+
+#### 说明
+* typeof 函数返回的是类型名称字符串，而不是类型对象
+* 对于 decimal 类型，返回完整的精度信息，如 'decimal(10,2)'
+* 对于复杂类型（array、map、struct），返回完整的嵌套类型定义
+* `struct` 类型的字段名默认为 `col1`、`col2`、`col3` 等
+* 该函数在编译时确定类型，不会在运行时改变
+* 常用场景：
+  * 调试和诊断
+  * 生成类型相关的元数据
+* 注意：`TYPEOF` 只返回类型信息，不包含 NULL 约束信息
+* 该函数对性能影响很小，因为类型信息在编译时就已确定

package/bin/skills/lakehouse-doc/references/sql_functions/scalar_functions/string_functions/ucase.md

@@ -0,0 +1,46 @@
+### UCASE 函数
+
+```
+ucase(str)
+```
+
+#### 功能描述
+
+`UCASE` 函数是 `UPPER` 的别名，用于将输入字符串中的所有小写字母转换为大写字母，并返回转换后的字符串。
+
+#### 参数说明
+
+* `str`：需要转换为大写的字符串。
+
+#### 返回类型
+
+* 返回一个字符串，其中所有小写字母均已转换为大写字母。
+
+#### 注意事项
+
+* `UCASE` 函数与 `UPPER` 函数完全相同，可以互换使用。
+* `UCASE` 函数仅适用于输入字符串中包含的英文字母。对于其他语言或特殊字符，转换效果可能不符合预期。
+
+#### 使用示例
+
+1. 转换简单字符串
+
+```sql
+SELECT UCASE('hello world');
++-----------------------+
+| UCASE('hello world')  |
++-----------------------+
+| HELLO WORLD           |
++-----------------------+
+```
+
+2. 转换包含数字和特殊字符的字符串
+
+```sql
+SELECT UCASE('Hello123!@#');
++-----------------------+
+| UCASE('Hello123!@#')  |
++-----------------------+
+| HELLO123!@#           |
++-----------------------+
+```

package/bin/skills/lakehouse-doc/references/sql_functions/scalar_functions/string_functions/unbase64.md

@@ -0,0 +1,54 @@
+### UNBASE64 函数
+```
+unbase64(str)
+```
+#### 功能描述
+UNBASE64 函数用于将 Base64 编码格式的字符串转换为二进制格式。该函数接受一个字符串参数，并返回相应的二进制数据。
+
+#### 参数说明
+* `str`：输入的 Base64 编码格式字符串。
+
+#### 返回值
+返回二进制格式的数据。
+
+#### 使用示例
+1. 将 Base64 字符串转换为文本数据：
+```
+SELECT CAST(unbase64('SGVsbG9Xb3JsZA==') AS STRING);
+```
+结果：
+```
+HelloWorld
+```
+
+2. 将 Base64 字符串转换为 BLOB 数据：
+```
+SELECT unbase64('SGVsbG9Xb3JsZA==') AS BLOB;
+```
+结果：
+```
+[48 65 6c 6c 6f 57 6f 72 6c 64]
+
+```
+
+3. 将多个 Base64 字符串转换为文本数据，并进行拼接：
+```
+SELECT CONCAT(CAST(unbase64('SGVsbG8=') AS STRING), CAST(unbase64('U3RyaW5n') AS STRING)) AS RESULT;
+```
+结果：
+```
+HelloString
+```
+
+4. 从表中提取 Base64 编码的字段，并转换为文本数据：
+```
+SELECT CAST(unbase64(base64_column) AS STRING) AS text_data
+FROM my_table;
+```
+结果：
+```
+text_data
+----------
+HelloWorld
+```
+

package/bin/skills/lakehouse-doc/references/sql_functions/scalar_functions/string_functions/unhex.md

@@ -0,0 +1,46 @@
+### UNHEX 函数
+```
+unhex(expr)
+```
+#### 功能描述
+UNHEX 函数用于将十六进制格式的字符串转换为二进制数据。该函数接受一个字符串参数，并返回相应的二进制数据。
+
+#### 参数说明
+* `expr` (string): 需要转换的十六进制格式字符串。
+
+#### 返回结果
+返回二进制数据。
+
+#### 使用示例
+1. 将十六进制字符串转换为文本：
+```sql
+SELECT STRING(UNHEX('48656C6C6F576F726C64'));
+```
+结果：
+```
+HelloWorld
+```
+2. 将十六进制字符串转换为图片数据：
+```sql
+SELECT UNHEX('89504E470D0A1A0A0000') AS image_data;
+```
+结果：
+```
+ [89 50 4e 47 0d 0a 1a 0a 00 00]
+```
+3. 将十六进制字符串转换为音频数据：
+```sql
+SELECT UNHEX('25504446') AS audio_data;
+```
+结果：
+```
+ [25 50 44 46]
+```
+4. 将十六进制字符串转换为视频数据：
+```sql
+SELECT UNHEX('000001BA') AS video_data;
+```
+结果：
+```
+[00 00 01 ba]
+```

package/bin/skills/lakehouse-doc/references/sql_functions/scalar_functions/string_functions/upper.md

@@ -0,0 +1,51 @@
+### UPPER 函数
+
+#### 概述
+UPPER 函数用于将输入的字符串（str）中的所有小写字母转换为大写字母，并返回转换后的字符串。
+
+#### 语法
+```
+UPPER(str)
+```
+
+#### 参数
+- str (string): 需要转换为大写的字符串。
+
+#### 返回结果
+返回一个字符串，其中所有小写字母均已转换为大写字母。
+
+#### 使用示例
+
+1. 转换简单字符串：
+```sql
+SELECT UPPER('hello world');
+-- 输出结果：HELLO WORLD
+```
+
+2. 转换包含数字和特殊字符的字符串：
+```sql
+SELECT UPPER('Hello123!@#');
+-- 输出结果：HELLO123!@#
+```
+
+3. 转换已为大写的字符串：
+```sql
+SELECT UPPER('HELLOWORLD');
+-- 输出结果：HELLOWORLD
+```
+
+4. 在查询中使用 UPPER 函数处理列数据：
+```sql
+SELECT UPPER(column_name) FROM table_name;
+```
+
+5. 结合其他字符串函数使用：
+```sql
+SELECT CONCAT(UPPER(first_name), UPPER(last_name)) AS full_name
+FROM users;
+-- 假设 users 表包含 first_name 和 last_name 列，该查询将返回一个名为 full_name 的列，其中包含将用户的名字和姓氏转换为大写的结果。
+```
+
+#### 注意事项
+- UPPER 函数仅对输入字符串中的英文字母有效。对于其他语言的字母或特殊字符，转换效果可能不符合预期。
+- 在使用 UPPER 函数时，请确保输入的数据类型为字符串。如果输入非字符串类型，函数可能无法正常工作或返回错误。

package/bin/skills/lakehouse-doc/references/sql_functions/scalar_functions/string_functions/url_decode.md

@@ -0,0 +1,32 @@
+### URL_DECODE
+```sql
+url_decode(str)
+```
+
+#### 功能
+对 URL 编码的字符串进行解码。
+
+#### 参数
+* `str`: string 类型，URL 编码的字符串
+
+#### 返回结果
+* **string 类型**：返回解码后的字符串。
+* 将 `%XX` 形式的编码转换为对应的字符。
+* 将 `+` 转换为空格。
+
+#### 举例
+```sql
+> SELECT url_decode('http%3A%2F%2Fyunqi.tech%2Fpath%3Fquery%3D%26key%3D2');
+http://yunqi.tech/path?query=&key=2
+
+> SELECT url_decode('http%3A%2F%2Fyunqi.tech%2Fpath%3Fquery%3D%26key%3D+2');
+http://yunqi.tech/path?query=&key= 2
+
+> SELECT url_decode('http%3A%2F%2Fyunqi.tech%2Fpath%3Fquery%3D1%23ref');
+http://yunqi.tech/path?query=1#ref
+```
+
+#### 说明
+* 这是 `URL_ENCODE` 函数的逆操作。
+* `+` 会被解码为空格。
+* 支持标准的 URL 百分号编码解码。

package/bin/skills/lakehouse-doc/references/sql_functions/scalar_functions/string_functions/url_encode.md

@@ -0,0 +1,33 @@
+### URL_ENCODE
+```sql
+url_encode(str)
+```
+
+#### 功能
+对字符串进行 URL 编码。
+
+#### 参数
+* str: string 类型，要编码的字符串
+
+#### 返回结果
+* string 类型，返回 URL 编码后的字符串
+* 特殊字符会被转换为 `%XX` 的形式。
+* 空格会被编码为 `+`。
+
+#### 举例
+```sql
+> SELECT url_encode('http://yunqi.tech/path?query=&key=2');
+http%3A%2F%2Fyunqi.tech%2Fpath%3Fquery%3D%26key%3D2
+
+> SELECT url_encode('http://yunqi.tech/path?query=&key= 2');
+http%3A%2F%2Fyunqi.tech%2Fpath%3Fquery%3D%26key%3D+2
+
+> SELECT url_encode('http://yunqi.tech/path?query=1#ref');
+http%3A%2F%2Fyunqi.tech%2Fpath%3Fquery%3D1%23ref
+```
+
+#### 说明
+* 这是 `URL_DECODE` 函数的逆操作。
+* 空格会被编码为 `+`。
+* 支持标准的 URL 百分号编码。
+* 常用于构造 URL 查询参数。

package/bin/skills/lakehouse-doc/references/sql_functions/scalar_functions/string_functions/uuid.md

@@ -0,0 +1,33 @@
+### UUID 函数
+
+#### 功能描述
+`uuid()` 函数用于生成一个标准的唯一标识符（UUID）。UUID（Universally Unique Identifier）是一种用于计算机系统中确保全局唯一性的标识符标准。
+
+#### 语法
+```
+uuid()
+```
+
+#### 参数
+无
+
+#### 返回结果
+返回一个字符串类型的 UUID。
+
+#### 使用示例
+1. 生成一个 UUID 并显示结果：
+```sql
+SELECT uuid();
+```
+执行结果可能如下：
+```
+4d275467-77ee-427f-9d4e-f55078c6b4df
+```
+
+
+2. 用于更新记录时生成一个关联的新 UUID：
+```sql
+UPDATE example_table SET related_id = uuid() WHERE id = 'existing_id';
+```
+这将为 `example_table` 表中具有指定 `existing_id` 的记录生成一个新的 `related_id`。
+

package/bin/skills/lakehouse-doc/references/sql_functions/scalar_functions/vector_functions/binary_quantize.md

@@ -0,0 +1,51 @@
+# BINARY\_QUANTIZE
+
+
+
+```sql
+BINARY_QUANTIZE(vec);
+```
+
+## 功能描述
+
+将输入向量进行二值化处理，将每个浮点数元素转换为二进制表示。通常用于向量压缩和快速相似度计算，其中每一个比特（bit）表示原向量中对应元素的二值化结果（通常以 0 为阈值，大于等于 0 为 1，小于 0 为 0）。
+
+## 参数说明
+
+* `vec`: 输入向量，支持的类型为 `vector<<float>>`、`vector<<double>>` 等数值向量类型。
+
+## 返回结果
+
+返回一个 `vector<<tinyint>>` 类型的向量，其中每个 `tinyint` 元素（通常为 8 位）打包存储了原向量中多个元素的二值化结果。
+
+## 案例
+
+* 对浮点向量进行二值化
+  ```sql
+SELECT BINARY_QUANTIZE(VECTOR(1.5f, -0.5f, 2.0f, -1.0f, 0.5f, -2.0f, 1.0f, 0.0f)) as binary_vec;
++------------+
+| binary_vec |
++------------+
+| [-86]      |
++------------+
+```
+* 对全正数向量进行二值化
+  ```sql
+SELECT BINARY_QUANTIZE(VECTOR(1.0f, 2.0f, 3.0f, 4.0f)) as binary_vec;
++------------+
+| binary_vec |
++------------+
+| [-16]      |
++------------+
+```
+* 对全负数向量进行二值化
+  ```sql
+SELECT BINARY_QUANTIZE(VECTOR(-1.0f, -2.0f, -3.0f, -4.0f)) as binary_vec;
++------------+
+| binary_vec |
++------------+
+| [0]        |
++------------+
+```
+
+

package/bin/skills/lakehouse-doc/references/sql_functions/scalar_functions/vector_functions/cosine_distance.md

@@ -0,0 +1,53 @@
+## COSINE\_DISTANCE
+
+```SQL
+ COSINE_DISTANCE(vector1, vector2);
+```
+
+### 功能描述
+
+cosine\_distance，即余弦距离，是一种衡量两个向量方向差异的度量方法。它是从1减去余弦相似度得到的，用于反映向量在方向上的不同程度。余弦相似度本身是通过计算两个向量的夹角余弦值来确定的，其值范围在-1到1之间。
+
+### 参数说明
+
+* vector1:第一个向量，支持的类型array\<decimal>、array\<double>、array\<float>
+* vector2:第一个向量，支持的类型array\<decimal>、array\<double>、array\<float>
+
+### 返回结果
+
+返回一个 double 类型的结果。
+
+### 案例
+
+* 计算array\<decimal>类型的两个向量之间的距离
+
+```SQL
+SELECT cosine_distance(array(1bd, 2bd), array(2bd, 3bd)) as cosDis;
++----------------------+
+|        cosDis        |
++----------------------+
+| 0.007722123286332261 |
++----------------------+
+```
+
+* 计算array\<double>类型的两个向量之间的距离
+
+```SQL
+SELECT cosine_distance(array(1d, 2d), array(2d, 3d)) as cosDis;
++----------------------+
+|        cosDis        |
++----------------------+
+| 0.007722123286332261 |
++----------------------+
+```
+
+* 计算array\<float>类型的两个向量之间的距离
+
+```SQL
+SELECT cosine_distance(array(1f, 2f), array(2f, 3f)) as cosDis;
++----------------------+
+|        cosDis        |
++----------------------+
+| 0.007722123286332261 |
++----------------------+
+```

package/bin/skills/lakehouse-doc/references/sql_functions/scalar_functions/vector_functions/dot_product.md

@@ -0,0 +1,54 @@
+## DOT\_PRODUCT
+
+```SQL
+ DOT_PRODUCT(vector1, vector2);
+```
+
+### 功能描述
+
+点积（也称为数量积或标量积），是一种基本的代数运算，它接受两个等长的数字序列（通常是坐标向量）并返回一个单一的数字。
+
+### 参数说明
+
+* vector1:第一个向量，支持的类型array\<decimal>、array\<double>、array\<float>
+* vector2:第一个向量，支持的类型array\<decimal>、array\<double>、array\<float>
+
+### 返回结果
+
+返回一个 double 类型的结果。
+
+### 案例
+
+* 计算array\<decimal>类型的两个向量之间的点积
+
+```SQL
+SELECT dot_product(array(1bd, 2bd, 3bd), array(4bd, 5bd, 6bd)) AS res;
+
++------+
+| res  |
++------+
+| 32.0 |
++------+
+```
+
+* 计算array\<double>类型的两个向量之间的点积
+
+```SQL
+SELECT dot_product(array(1d, 2d, 3d), array(4d, 5d, 6d)) AS res;
++------+
+| res  |
++------+
+| 32.0 |
++------+
+```
+
+* 计算array\<float>类型的两个向量之间的点积
+
+```SQL
+SELECT dot_product(array(1f, 2f, 3f), array(4f, 5f, 6f)) AS res;
++------+
+| res  |
++------+
+| 32.0 |
++------+
+```

package/bin/skills/lakehouse-doc/references/sql_functions/scalar_functions/vector_functions/hamming_distance.md

@@ -0,0 +1,57 @@
+# HAMMING\_DISTANCE
+
+```sql
+HAMMING_DISTANCE(vector1, vector2);
+```
+
+## 功能描述
+
+计算两个等长向量之间的[汉明距离（Hamming Distance）](https://en.wikipedia.org/wiki/Hamming_distance)。汉明距离指两个等长字符串对应位置的不同字符的个数，在向量计算中表示两个向量中对应元素不相等的位置数量。
+
+## 参数说明
+
+* `vector1`: 第一个向量，支持的类型 `vector\<tinyint>`
+* `vector2`: 第二个向量，支持的类型 `vector\<tinyint>`
+
+注意：两个向量必须具有相同的长度。
+
+## 返回结果
+
+返回一个bigint类型的结果，表示两个向量中不相等元素的个数。
+
+## 案例
+
+* 计算 `vector\<tinyint>` 类型的两个向量之间的汉明距离
+
+```sql
+SELECT HAMMING_DISTANCE(VECTOR(1y, 0y, 1y), VECTOR(1y, 1y, 0y)) as hamming_dis;
++-------------+
+| hamming_dis |
++-------------+
+| 2.0         |
++-------------+
+```
+
+* 计算更长的 `tinyint` 向量之间的汉明距离
+
+```sql
+SELECT HAMMING_DISTANCE(VECTOR(1y, 0y, 1y, 0y), VECTOR(1y, 0y, 0y, 1y)) as hamming_dis;
++-------------+
+| hamming_dis |
++-------------+
+| 2.0         |
++-------------+
+```
+
+* 计算相同向量的汉明距离（结果为 0）
+
+```sql
+SELECT HAMMING_DISTANCE(VECTOR(1y, 1y, 0y), VECTOR(1y, 1y, 0y)) as hamming_dis;
++-------------+
+| hamming_dis |
++-------------+
+| 0.0         |
++-------------+
+```
+
+

package/bin/skills/lakehouse-doc/references/sql_functions/scalar_functions/vector_functions/jaccard_distance.md

@@ -0,0 +1,55 @@
+# JACCARD\_DISTANCE
+
+```sql
+JACCARD_DISTANCE(vector1, vector2);
+```
+
+## 功能描述
+
+计算两个向量之间的[雅卡德距离（Jaccard Distance）](https://en.wikipedia.org/wiki/Jaccard_index)。雅卡德距离定义为 1 - 雅卡德相似系数，用于衡量两个集合的差异程度。对于二进制向量，Jaccard 距离 = 1 - |A∩B| / |A∪B|，其中 A 和 B 分别表示两个向量中非零元素的集合。
+
+## 参数说明
+
+* `vector1`：第一个向量，支持的类型 `vector`\<tinyint>
+* `vector2`：第二个向量，支持的类型 `vector`\<tinyint>
+
+## 返回结果
+
+返回一个 `double` 类型的结果，取值范围为 [0, 1]。其中 0 表示两个向量完全相同，1 表示完全不同。
+
+## 案例
+
+* 计算 `vector`\<tinyint> 类型的两个向量之间的 Jaccard 距离
+
+```sql
+SELECT JACCARD_DISTANCE(VECTOR(1y, 0y, 1y), VECTOR(1y, 1y, 0y)) as jaccard_dis;
++-------------+
+| jaccard_dis |
++-------------+
+| 0.6666666   |
++-------------+
+```
+
+* 计算更长的 `tinyint` 向量之间的 Jaccard 距离
+
+```sql
+SELECT JACCARD_DISTANCE(VECTOR(1y, 0y, 1y, 0y), VECTOR(1y, 0y, 0y, 1y)) as jaccard_dis;
++-------------+
+| jaccard_dis |
++-------------+
+| 0.6666666   |
++-------------+
+```
+
+* 计算相同向量的 Jaccard 距离（结果为 0）
+
+```sql
+SELECT JACCARD_DISTANCE(VECTOR(1y, 1y, 0y), VECTOR(1y, 1y, 0y)) as jaccard_dis;
++-------------+
+| jaccard_dis |
++-------------+
+| 0.0         |
++-------------+
+```
+
+^