@clickzetta/cz-cli-darwin-x64 0.3.1

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

@@ -0,0 +1,52 @@
+## 功能概述
+
+CHAR\_LENGTH等效于CHARACTER\_LENGTH，用于返回字符串中字符的数量。
+
+## 语法
+
+```SQL
+CHAR_LENGTH(string|char|)
+```
+
+## 参数说明
+
+* **string**: 要计算字符长度的字符串表达式。
+
+## 返回结果
+
+该函数返回一个整数，表示输入字符串中的字符总数。
+
+## 示例
+
+示例 1：基本用法
+
+```SQL
+SELECT CHAR_LENGTH('Hello, World!');
++-------------------------------------+
+| `CHAR_LENGTH`('Hello, World!') |
++-------------------------------------+
+| 13                                  |
++-------------------------------------+
+```
+
+示例 2：与 NULL 值一起使用
+
+```SQL
+SELECT CHAR_LENGTH(NULL);
++--------------------------+
+| `CHAR_LENGTH`(NULL) |
++--------------------------+
+| null                     |
++--------------------------+
+```
+
+示例 3：中文字符
+
+```SQL
+ SELECT CHAR_LENGTH('中文');
++--------------------------+
+| `CHARA_LENGTH`('中文') |
++--------------------------+
+| 2                        |
++--------------------------+
+```

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

@@ -0,0 +1,52 @@
+## 功能概述
+
+CHARACTER_LENGTH 用于返回字符串中字符的数量。
+
+## 语法
+
+```SQL
+CHARACTER_LENGTH(string|char|)
+```
+
+## 参数说明
+
+* **string**: 要计算字符长度的字符串表达式。
+
+## 返回结果
+
+该函数返回一个整数，表示输入字符串中的字符总数。
+
+## 示例
+
+示例 1：基本使用
+
+```SQL
+SELECT CHARACTER_LENGTH('Hello, World!');
++-------------------------------------+
+| `CHARACTER_LENGTH`('Hello, World!') |
++-------------------------------------+
+| 13                                  |
++-------------------------------------+
+```
+
+示例 2：处理 NULL 值
+
+```SQL
+SELECT CHARACTER_LENGTH(NULL);
++--------------------------+
+| `CHARACTER_LENGTH`(NULL) |
++--------------------------+
+| null                     |
++--------------------------+
+```
+
+示例 3：中文字符
+
+```SQL
+ SELECT CHARACTER_LENGTH('中文');
++--------------------------+
+| `CHARACTER_LENGTH`('中文') |
++--------------------------+
+| 2                        |
++--------------------------+
+```

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

@@ -0,0 +1,26 @@
+### CHR
+```sql
+chr(n)
+```
+
+#### 功能
+返回给定整数对应的 ASCII 字符。
+
+#### 参数
+* `n`: int 类型，表示字符的 ASCII 码，范围 0-127。
+
+#### 返回结果
+* string 类型，返回对应的字符。
+* 如果输入为 NULL，返回 NULL。
+
+#### 举例
+```sql
+> SELECT chr(100);
+d
+
+> SELECT chr(65);
+A
+
+> SELECT chr(null);
+NULL
+```

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

@@ -0,0 +1,58 @@
+### 函数名称
+COLLATION\_SORT\_KEY
+
+#### 功能描述
+COLLATION\_SORT\_KEY 函数根据指定的字符集，为输入的字符串生成一个排序键，用于按照特定字符集的规则对字符串进行排序。
+
+#### 语法
+```
+collection_sort_key(str, coll)
+```
+* str: 输入的字符串。
+* coll: 指定的排序规则。
+
+#### 返回值
+返回一个二进制值，表示输入字符串按照指定字符集生成的排序键。
+
+#### 使用示例
+1. 按照拼音顺序对中文字符串进行排序：
+```
+SELECT s, collation_sort_key(s, 'zh') AS sort_key
+FROM ('你好', '苹果', '香蕉', '梨子', '草莓', '西瓜', '世界') AS t(s)
+ORDER BY sort_key;
+```
+结果如下：
+```
+s   | sort_key
+----|----------
+你好 | 7A96647001060106
+苹果 | 7DA963B401060106
+梨子 | 71FDA16101060106
+草莓 | 5496779301060106
+西瓜 | 8EAD628E01060106
+世界 | 86056B8E01060106
+香蕉 | 90A36AB101060106
+```
+
+2. 按照英文字母顺序（如`utf8mb4_general_ci`）对英文字符串进行排序：
+```
+SELECT s, collation_sort_key(s, 'en') AS sort_key
+FROM ('apple', 'banana', 'cherry', 'grape', 'orange', 'strawberry') AS t(s)
+ORDER BY sort_key;
+```
+结果如下：
+```
+s    | sort_key
+-----|----------
+apple | 0100000001000000
+banana | 0100000002000000
+cherry | 0100000003000000
+grape | 0100000004000000
+orange | 0100000005000000
+strawberry | 0100000010000000
+```
+
+#### 注意事项
+* COLLATION\_SORT\_KEY 函数仅适用于字符串类型的输入。
+* 指定的排序规则必须有效，否则将返回 NULL。
+* 生成的排序键是二进制值，可用于 ORDER BY 子句进行排序。

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

@@ -0,0 +1,75 @@
+### CONCAT 函数
+
+#### 概述
+`CONCAT` 函数用于连接多个字符串、数组或二进制数据。根据输入参数的类型，`CONCAT` 函数可以执行以下操作：
+1. 将多个数组元素组合成一个新的数组。
+2. 将多个字符串拼接成一个新的字符串。
+3. 将多个二进制数据拼接成一个新的二进制数据。
+
+#### 语法
+```
+CONCAT(array1, array2, ..., arrayN)
+CONCAT(str1, str2, ..., strN)
+CONCAT(binary1, binary2, ..., binaryN)
+```
+
+#### 参数
+- `array1 ~ arrayN`: `array<T>` 类型，表示要连接的数组。
+- `str1 ~ strN`: `string` 类型，表示要连接的字符串。
+- `binary1 ~ binaryN`: `binary` 类型，表示要连接的二进制数据。
+
+#### 返回结果
+- 数组重载版本：返回一个 `array<T>` 类型的新数组。
+- 字符串重载版本：返回一个连接后的字符串。
+- 二进制重载版本：返回一个连接后的二进制数据。
+
+#### 示例
+1. 连接两个数组：
+```sql
+SELECT CONCAT(array(1, 2), array(3, 4));
+```
+结果：
+```
+[1, 2, 3, 4]
+```
+
+2. 连接多个字符串：
+```sql
+SELECT CONCAT('hello', '-', 'world');
+```
+结果：
+```
+hello-world
+```
+
+3. 连接两个二进制数据：
+```sql
+SELECT CONCAT(CAST('123' AS BINARY), CAST('456' AS BINARY));
+```
+结果：
+```
+[31 32 33 34 35 36] 
+```
+
+4. 连接字符串和数字（注意：数字需要先转换为字符串）：
+```sql
+SELECT CONCAT('The price is ', CAST(100 AS STRING), ' dollars.');
+```
+结果：
+```
+The price is 100 dollars.
+```
+
+5. 使用 `CONCAT` 函数连接多个字段：
+```sql
+SELECT CONCAT(first_name, ' ', last_name) AS full_name
+FROM users;
+```
+结果：
+```
+full_name
+----------
+John Doe
+Jane Smith
+```
+

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

@@ -0,0 +1,72 @@
+### CONCAT_WS 函数
+
+#### 概述
+`CONCAT_WS` 函数用于将多个字符串或数组中的字符串元素连接成一个字符串。它可以根据指定的分隔符 `sep` 来连接输入的字符串或数组中的字符串元素。如果输入的字符串为 `NULL`，则在结果中忽略该值。
+
+#### 语法
+```
+CONCAT_WS(sep, str1, str2, ..., strN)
+CONCAT_WS(sep, array1, array2, ..., arrayN)
+```
+
+#### 参数
+- `sep`: 分隔符字符串，用于连接输入的各个字符串。
+- `str1, str2, ..., strN`: 要连接的字符串。
+- `array1, array2, ..., arrayN`: 包含要连接的字符串元素的数组。
+
+#### 返回结果
+返回一个连接后的字符串。
+
+#### 使用示例
+
+1. 基本使用：
+```sql
+SELECT CONCAT_WS('-', 'hello', 'world');
+```
+结果：
+```
+hello-world
+```
+
+2. 连接多个字符串：
+```sql
+SELECT CONCAT_WS('-', 'hello', 'my', 'friend', '!');
+```
+结果：
+```
+hello-my-friend-!
+```
+
+3. 忽略 `NULL` 值：
+```sql
+SELECT CONCAT_WS('-', 'hello', NULL, 'world', NULL);
+```
+结果：
+```
+hello-world
+```
+
+4. 使用数组连接字符串：
+```sql
+SELECT CONCAT_WS('-', array('hello', 'my', 'friend'), array('is', NULL, 'awesome'));
+```
+结果：
+```
+hello-my-friend-is-awesome
+```
+
+5. 结合其他函数使用：
+```sql
+SELECT CONCAT_WS('-', UPPER('hello'), LENGTH('world'), LOWER('!'));
+```
+结果：
+```
+HELLO-5-!
+```
+
+#### 注意事项
+- 当输入的字符串或数组元素为 `NULL` 时，`CONCAT_WS` 函数会忽略这些值。
+- 如果所有输入的字符串或数组元素均为 `NULL`，则返回空字符串。
+- 如果分隔符 `sep` 为 `NULL`，则返回 NULL。
+
+通过以上示例和说明，您可以更好地理解 `CONCAT_WS` 函数的用法和功能。在实际应用中，您可以根据需要灵活地使用此函数来连接字符串或数组元素。

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

@@ -0,0 +1,31 @@
+### CONTAINS 函数
+`contains(expr, subExpr)`
+#### 功能描述
+`contains` 函数用于判断字符串或二进制表达式 `subExpr` 是否存在于字符串或二进制表达式 `expr` 中。如果 `subExpr` 存在于 `expr` 中，则返回 `true`，否则返回 `false`。
+
+#### 参数说明
+- `expr`：需要搜索的字符串或二进制表达式。
+- `subExpr`：需要在 `expr` 中查找的子字符串或二进制表达式。
+
+#### 返回结果
+返回一个布尔值，表示 `subExpr` 是否在 `expr` 中存在。
+
+#### 使用示例
+1. 判断 "HelloWorld" 中是否包含 "Hello"：
+   ```sql
+   SELECT contains('HelloWorld', 'Hello'); -- 返回 true
+   ```
+2. 判断 "123456" 中是否包含 "34"：
+   ```sql
+   SELECT contains('123456', '34'); -- 返回 true
+   ```
+3. 判断 "示例文本" 中是否包含 "本"（中文字符）：
+   ```sql
+   SELECT contains('示例文本', '本'); -- 返回 true
+   ```
+
+
+#### 注意事项
+- 当 `expr` 或 `subExpr` 为 `NULL` 时，`contains` 函数将返回 `NULL`。
+
+通过使用 `contains` 函数，您可以轻松地在数据查询中实现对特定子字符串或二进制模式的检测，从而提高数据处理的灵活性和效率。

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

@@ -0,0 +1,50 @@
+# conv函数
+
+## 简介
+
+`conv` 函数用于将一个数字从一种基数转换为另一种基数。它支持从基数 2 到基数 36 的转换，并且可以处理有符号和无符号数字。
+
+## 语法
+
+```sql
+conv(num, fromBase, toBase)
+```
+
+## 参数
+
+- **`num`**：`STRING` 类型，表示需要转换的数字，该数字以字符串形式表示，其基数由 `fromBase` 指定。
+- **`fromBase`**：`INTEGER` 类型，表示源数字的基数，取值范围为 2 到 36。
+- **`toBase`**：`INTEGER` 类型，表示目标基数，取值范围为 2 到 36。
+
+## 返回值
+
+返回一个 `STRING` 类型的结果，表示转换后的数字。
+
+- 如果 `fromBase` 小于 2 或大于 36，或者 `toBase` 小于 2 或大于 36，则返回 `NULL`。
+- 如果 `toBase` 为负数，则将 `num` 解释为有符号数字，否则将其视为无符号数字。
+
+## 示例
+
+示例 1：二进制转十进制
+
+```sql
+> SELECT conv('100', 2, 10);
+4
+```
+
+示例 2：十六进制转十进制
+
+```sql
+> SELECT conv('1A', 16, 10);
+26
+```
+
+示例 3：十进制转十六进制
+
+```sql
+> SELECT conv('255', 10, 16);
+FF
+```
+
+
+

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

@@ -0,0 +1,70 @@
+# ENDSWITH 函数
+
+## 功能描述
+
+`ENDSWITH` 函数用于判断一个字符串或二进制表达式是否以另一个指定的字符串或二进制表达式结尾。如果满足条件，则返回布尔值 `TRUE`，否则返回 `FALSE`。该函数支持字符串和二进制数据，适用于字符串处理和模式匹配场景。
+
+## 语法
+
+```sql
+ENDSWITH(expr, endExpr)
+```
+
+## 参数
+
+* `expr`：字符串或二进制表达式，表示需要检查的目标数据。
+* `suffix`：字符串或二进制表达式，表示用于比较的结尾模式。
+
+## 返回值
+
+* 返回值为布尔类型（`TRUE` 或 `FALSE`）。
+* 如果 `expr` 或 `endExpr` 为 `NULL`，则返回 `NULL`。
+* 如果 `endExpr` 是空字符串或空二进制数据，则返回 `TRUE`。
+
+## 示例
+
+示例 1：字符串模式匹配
+
+```sql
+SELECT ENDSWITH('LakehouseSQL', 'SQL') AS result;
++--------+
+| result |
++--------+
+| true   |
++--------+
+```
+
+示例 2：区分大小写
+
+```sql
+SELECT ENDSWITH('LakehouseSQL', 'sql') AS result;
++--------+
+| result |
++--------+
+| false  |
++--------+
+```
+
+示例 3：包含 NULL 值
+
+```sql
+SELECT ENDSWITH('LakehouseSQL', NULL) AS result;
++--------+
+| result |
++--------+
+| null   |
++--------+
+```
+
+示例 4：空字符串
+
+```sql
+SELECT ENDSWITH('LakehouseSQL', '') AS result;
++--------+
+| result |
++--------+
+| true   |
++--------+
+```
+
+^

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

@@ -0,0 +1,19 @@
+### FIND_IN_SET
+```sql
+split_part(str, strlist)
+```
+#### 功能
+strlist 是由 N 个被 ‘,’ 分隔的子串组成的字符串。假如字符串 str 在 strlist 中，则返回 str 的位置（1 到 N 之间）。
+如果 str 不在 strlist 中或 strlist 为空字符串，则返回值为 0。
+如任意一个参数为 NULL，则返回值为 NULL。
+这个函数在第一个参数包含一个逗号 ‘,’ 时将无法正常运行。
+#### 参数
+* str: string, 待匹配字符串
+* strlist: string, 待查找字符串
+#### 返回结果
+int
+#### 举例
+```sql
+> SELECT FIND_IN_SET('b','a,b,c,d');
+2
+```

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

@@ -0,0 +1,53 @@
+## 功能概述
+
+`FORMAT_STRING` 是一个 SQL 函数，用于格式化字符串。它基于 `printf` 样式的格式字符串生成格式化后的字符串。此函数使用 `java.util.Formatter` 类，利用 `Locale.US` 进行格式化。
+
+## 语法
+
+```SQL
+FORMAT_STRING(strfmt [, obj1 [, ...]])
+```
+
+## 参数说明
+
+* **strfmt**: 一个 `STRING` 类型的表达式，定义了字符串的格式。这应该包含格式化指令，如 `%d`、`%s` 等。
+* **obj1, ...**: 一个或多个 `STRING` 或数值类型的表达式，这些表达式将被格式化并插入到 `strfmt` 中相应的位置。
+
+## 返回结果
+
+该函数返回一个 `STRING` 类型的值，表示格式化后的字符串。
+
+## 示例
+
+示例 1: 基本使用
+
+```SQL
+SELECT FORMAT_STRING('Hello World %d %s', 100, 'days') as res;
++----------------------+
+|         res          |
++----------------------+
+| Hello World 100 days |
++----------------------+
+```
+
+示例 2: 使用数值参数
+
+```SQL
+SELECT FORMAT_STRING('The square of %d is %d', 5, 5*5) as res;
++-----------------------+
+|          res          |
++-----------------------+
+| The square of 5 is 25 |
++-----------------------+
+```
+
+示例 3: 使用多个参数
+
+```SQL
+SELECT FORMAT_STRING('Name: %s, Age: %d, Location: %s', 'Alice', 30, 'Wonderland') as res;
++--------------------------------------------+
+|                    res                     |
++--------------------------------------------+
+| Name: Alice, Age: 30, Location: Wonderland |
++--------------------------------------------+
+```

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

@@ -0,0 +1,45 @@
+### HEX 函数
+```sql
+HEX(expr)
+```
+#### 功能描述
+HEX 函数用于将不同类型的数据转换为十六进制格式的字符串。该函数接受多种输入类型，包括字符串、二进制数据和大整数，并将它们转换为对应的十六进制表示形式。
+
+#### 参数说明
+* **expr**: string/binary/bigint
+  * 待转换的输入数据。
+
+#### 返回结果
+返回一个字符串，表示输入数据的十六进制形式。
+
+#### 使用示例
+1. 字符串转换为十六进制：
+    ```sql
+   SELECT HEX('HelloWorld');
+   ```
+    结果：
+    ```
+   48656C6C6F576F726C64
+   ```
+2. 二进制数据转换为十六进制：
+    ```sql
+   SELECT HEX(CAST('11001010' AS BINARY));
+   ```
+    结果：
+    ```
+   3131303031303130
+
+   ```
+3. 大整数转换为十六进制：
+    ```sql
+   SELECT HEX(1234567891234567);
+   ```
+    结果：
+    ```
+   462D53C9BAF07
+   ```
+
+#### 注意事项
+- 对于空字符串输入，HEX 函数将返回空字符串。
+- 当输入数据无法转换为十六进制时，函数将返回 NULL。
+

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

@@ -0,0 +1,41 @@
+### INSTR 函数
+```sql
+instr(str, substr)
+```
+#### 功能描述
+INSTR 函数用于查找指定子字符串（substr）在给定字符串（str）中第一次出现的位置。当 substr 在 str 中被找到时，返回其起始位置的整数索引（从 1 开始计数）；若未找到，则返回 0。
+
+#### 参数说明
+- str: 待搜索的字符串。
+- substr: 需要查找的子字符串。
+
+#### 返回结果
+返回一个整数，表示 substr 在 str 中第一次出现的位置。如果 substr 未在 str 中出现，则返回 0。
+
+#### 使用示例
+1.  查询子字符串 "World" 在 "HelloWorld" 中的位置：
+    ```sql
+SELECT INSTR('HelloWorld', 'World'); -- 结果为：6
+```
+2.  查询子字符串 "Java" 在 "HelloWorld" 中的位置（预期未找到，返回 0）：
+    ```sql
+SELECT INSTR('HelloWorld', 'Java'); -- 结果为：0
+```
+3.  计算子字符串 "or" 在 "HelloWorld" 中的起始位置：
+    ```sql
+SELECT INSTR('HelloWorld', 'or'); -- 结果为：7
+```
+4.  在一个更长的文本中查找子字符串 "Program" 的位置：
+    ```sql
+SELECT INSTR('Programming in C language is fun', 'Program'); -- 结果为：1
+```
+5.  当 substr 为空字符串时，返回 1，因为空字符串被视为存在于任何字符串的开头。
+    ```sql
+SELECT INSTR('HelloWorld', ''); -- 结果为：1
+```
+#### 注意事项
+- 如果 str 或 substr 为 NULL，则 INSTR 函数返回 NULL。
+- 搜索是区分大小写的，即 'Hello' 和 'hello' 被视为不同的字符串。
+- 若要执行不区分大小写的搜索，可先使用 UPPER 或 LOWER 函数转换 str 和 substr 为同一大小写形式，然后再进行比较。
+
+通过以上示例和说明，您可以更好地理解 INSTR 函数的用法和功能。在实际应用中，您可以根据需要灵活地使用此函数来查找特定子字符串的位置。

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

@@ -0,0 +1,27 @@
+### IS_ASCII
+``` sql
+is_ascii(str)
+```
+
+#### 功能
+判断str是否只包含ascii编码的字符
+
+#### 参数
+* str: string
+
+#### 返回结果
+boolean
+
+#### 举例
+```sql
+> SELECT a, is_ascii(a)
+  FROM VALUES (""),
+  ("abcd"),
+  ("中文"),
+  ("，。") AS t(a);
+        true
+abcd    true
+中文    false
+，。    false
+
+```