@clickzetta/cz-cli-darwin-x64 0.3.1

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

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

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

@@ -0,0 +1,45 @@
+### LCASE 函数
+
+```
+lcase(str)
+```
+
+#### 功能描述
+
+`LCASE` 函数是 `LOWER` 的别名，用于将输入的字符串中的所有大写字符转换为小写字符，并返回转换后的字符串。
+
+#### 参数说明
+
+* `str`：需要转换为小写字母的字符串。
+
+#### 返回类型
+
+* 返回转换为小写字母的字符串。
+
+#### 注意事项
+
+* `LCASE` 函数与 `LOWER` 函数完全相同，可以互换使用。
+
+#### 使用示例
+
+1. 将 "HelloWorld" 转换为 "helloworld"
+
+```sql
+SELECT LCASE('HelloWorld');
++----------------------+
+| LCASE('HelloWorld')  |
++----------------------+
+| helloworld           |
++----------------------+
+```
+
+2. 将 "Python" 和 "JAVA" 转换为小写字母
+
+```sql
+SELECT LCASE('Python'), LCASE('JAVA');
++------------------+-----------------+
+| LCASE('Python')  | LCASE('JAVA')   |
++------------------+-----------------+
+| python           | java            |
++------------------+-----------------+
+```

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

@@ -0,0 +1,35 @@
+### LEFT
+```sql
+left(str, len)
+```
+
+#### 功能
+返回字符串 `str` 左边的 `len` 个字符。
+
+#### 参数
+* str: string 类型
+* len: int 类型，要返回的字符数量
+
+#### 返回结果
+* string 类型，返回字符串左边的 `len` 个字符。
+* 如果 `len` 小于或等于 0，返回空字符串。
+* 如果 `len` 大于字符串长度，返回完整字符串。
+
+#### 示例
+```sql
+> SELECT left('hello-world', 7);
+hello-w
+
+> SELECT left('hello-world', 0);
+
+
+> SELECT left('hello-world', 99);
+hello-world
+
+> SELECT left('hello你好world', 7);
+hello你好
+```
+
+#### 说明
+* 支持 Unicode 字符，按字符（而非字节）计数。
+* `len` 参数为负数时返回空字符串。

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

@@ -0,0 +1,33 @@
+### LENGTH 函数
+
+#### 功能描述
+LENGTH 函数用于计算字符串的长度，返回字符串的字符数或二进制字符串的字节数。该函数对于文本数据的处理非常实用，可以快速获取文本的长度信息。
+
+#### 语法
+```sql
+LENGTH(expr)
+```
+
+#### 参数说明
+- `expr`：可以是字符串（string）或二进制（binary）类型的表达式。
+
+#### 返回结果
+返回一个整数（int），表示输入字符串的字符数或二进制字符串的字节数。
+
+#### 使用示例
+1. 计算普通字符串的长度：
+   ```sql
+   SELECT LENGTH('HelloWorld'); -- 返回结果为 10
+   ```
+2. 计算包含中文字符的字符串长度：
+   ```sql
+   SELECT LENGTH('你好世界'); -- 返回结果为 4
+   ```
+3. 计算包含特殊字符的字符串长度：
+   ```sql
+   SELECT LENGTH('Hello@World!'); -- 返回结果为 12
+   ```
+
+
+#### 注意事项
+- LENGTH 函数只适用于字符串和二进制类型的数据，对于其他类型的数据将返回错误。

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

@@ -0,0 +1,49 @@
+## 功能概述
+
+`LENGTHB` 是 SQL 中的一个函数，用于返回字符串参数的字节长度。与 `CHAR_LENGTH` 或 `CHARACTER_LENGTH` 函数不同，`LENGTHB` 计算的是字节数而不是字符数，这在处理多字节字符集（如 UTF-8）时尤其重要。
+
+## 语法
+
+```SQL
+LENGTHB(string)
+```
+
+## 参数说明
+
+* **string**: 要计算字节长度的字符串表达式。
+
+## 返回结果
+
+该函数返回一个整数，表示输入字符串中的字节总数。对于 NULL 输入，返回值也是 NULL。
+
+## 示例
+
+### 示例 1: 基本使用
+
+```SQL
+SELECT LENGTHB('Hello, World!');
+```
+
+这将返回 13。
+
+### 示例 2: 处理 NULL 值
+
+```SQL
+SELECT LENGTHB(NULL);
+```
+
+这将返回 `NULL`，因为输入参数是 NULL。
+
+### 示例 3: 中文字符
+
+```SQL
+SELECT LENGTHB('中文')
+union all
+SELECT CHARACTER_LENGTH('中文');
++---------------+
+| LENGTHB('中文') |
++---------------+
+| 3             |
+| 6             |
++---------------+
+```

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

@@ -0,0 +1,63 @@
+### LIKE 操作符
+
+#### 功能描述
+LIKE 操作符用于在 SQL 查询中根据指定的模式匹配字符串。它可以帮助你查找包含特定字符或模式的数据。使用 LIKE 操作符时，你可以使用通配符来表示一个或多个字符。
+
+#### 参数说明
+* `str` (string)：需要匹配的原始字符串。
+* `pattern` (string)：包含通配符的模式字符串。
+
+#### 返回结果
+返回一个布尔值，表示 str 是否匹配 pattern。
+
+#### 通配符说明
+* `%`：表示任意数量的字符（包括零个字符）。
+* `_`：表示任意单个字符。
+
+#### 使用示例
+
+1. 匹配以 "Hello" 开头的字符串：
+```sql
+SELECT 'HelloWorld' LIKE 'Hello%';
+```
+结果：
+```
+true
+```
+
+2. 匹配包含 "lo" 的字符串：
+```sql
+SELECT 'HelloWorld' LIKE '%lo%';
+```
+结果：
+```
+true
+```
+
+3. 匹配以 "ld" 结尾且包含 "lo" 的字符串：
+```sql
+SELECT 'HelloWorld' LIKE '%lo_ld';
+```
+结果：
+```
+false
+```
+
+4. 使用单个字符通配符匹配包含 "oW" 的字符串：
+```sql
+SELECT 'HelloWorld' LIKE 'Hello_W%';
+```
+结果：
+```
+true
+```
+
+5. 结合 NOT 关键字，查找不匹配特定模式的字符串：
+```sql
+SELECT 'HelloWorld' NOT LIKE 'Hello%';
+```
+结果：
+```
+false
+```
+

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

@@ -0,0 +1,42 @@
+### 定位函数：LOCATE
+```sql
+LOCATE(substr, str [, pos])
+```
+#### 功能描述
+LOCATE 函数用于在字符串 str 中查找子串 substr，并返回 substr 从 pos 位置之后第一次出现的位置索引。如果指定了 pos 参数，则从该位置开始搜索；若未指定 pos，则在整个字符串 str 中进行搜索。该函数返回的位置索引从 1 开始计数，如果 pos 小于 1，则返回 0。
+
+#### 参数说明
+* substr (string): 需要查找的子串。
+* str (string): 被搜索的主字符串。
+* pos (bigint, 可选): 开始搜索的位置索引。默认值为 1。
+
+#### 返回结果
+返回 substr 在 str 中第一次出现的位置索引（bigint 类型），若未找到返回 0。
+
+#### 使用示例
+```sql
+-- 例子 1：在字符串 "HelloWorldWorld" 中查找 "World"，默认从位置 1 开始搜索
+SELECT LOCATE('World', 'HelloWorldWorld');
+-- 结果：6
+
+-- 例子 2：在字符串 "HelloWorldWorld" 中查找 "World"，从位置 7 开始搜索
+SELECT LOCATE('World', 'HelloWorldWorld', 7);
+-- 结果：11
+
+-- 例子 3：在字符串 "1234" 中查找 "3"，默认从位置 1 开始搜索
+SELECT LOCATE('3', '1234');
+-- 结果：3
+
+-- 例子 4：在字符串 "abcde" 中查找 "c"，并从位置 2 开始搜索
+SELECT LOCATE('c', 'abcde', 2);
+-- 结果：3
+
+-- 例子 5：在字符串 "MoonshotAI" 中查找 "shot"，未指定 pos 参数
+SELECT LOCATE('shot', 'MoonshotAI');
+-- 结果：5
+
+-- 例子 6：在字符串 "HelloWorld" 中查找 "World"，从位置 9 开始搜索，不存在于该位置之后
+SELECT LOCATE('World', 'HelloWorld', 9);
+-- 结果：0
+```
+通过以上示例，您可以更好地理解 LOCATE 函数的使用方法和功能。在实际应用中，LOCATE 函数可以帮助您快速定位和提取字符串中的特定子串。

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

@@ -0,0 +1,61 @@
+### LOWER 函数
+
+#### 功能描述
+LOWER 函数用于将输入的字符串（str）中的所有大写字符转换为小写字符，并返回转换后的字符串。
+
+#### 参数说明
+* `str`：需要转换为小写字母的字符串。
+
+#### 返回结果
+返回转换为小写字母的字符串。
+
+#### 使用示例
+以下为几个使用 LOWER 函数的例子：
+
+1. 将 "HelloWorld" 转换为 "helloworld"：
+```sql
+SELECT LOWER('HelloWorld');
+```
+结果为：
+```
+helloworld
+```
+
+2. 将 "Python" 和 "JAVA" 转换为小写字母：
+```sql
+SELECT LOWER('Python'), LOWER('JAVA');
+```
+结果为：
+```
+python
+java
+```
+
+3. 将字符串 "SQL" 和 "DATABASE" 转换为小写字母，并拼接在一起：
+```sql
+SELECT LOWER('SQL') || LOWER('DATABASE');
+```
+结果为：
+```
+sqldatabase
+```
+
+4. 将用户输入的字符串转换为小写字母，并存储到新列 "lower_case" 中：
+```sql
+SELECT id, LOWER(name) AS lower_case
+FROM users;
+```
+假设用户表 `users` 如下所示：
+```
+id | name
+---|-----
+1  | JohnDoe
+2  | AliceSmith
+```
+执行上述查询后，结果如下：
+```
+id | lower_case
+---|-------------
+1  | johndoe
+2  | alicesmith
+```

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

@@ -0,0 +1,45 @@
+### LPAD 函数
+
+``` sql
+lpad(str, len[, pad])
+```
+
+#### 功能描述
+LPAD 函数用于对字符串进行左侧填充。当给定的字符串 `str` 长度小于指定的 `len` 时，LPAD 函数将在 `str` 的左侧补充 `pad` 字符串，直到新字符串的总长度等于 `len`。如果 `str` 的长度已经等于或超过 `len`，则返回原始字符串。如果 `len` 小于 1，将返回空字符串。若未指定 `pad` 字符串，则默认使用空格字符（' '）进行填充。
+
+#### 参数说明
+- `str`（必选）：需要进行左侧填充的原始字符串。
+- `len`（必选）：目标字符串的长度。
+- `pad`（可选）：用于填充的字符串。默认值为一个空格字符（' '）。
+
+#### 返回值
+返回一个新的字符串，长度为 `len`，左侧填充了 `pad` 字符串。
+
+#### 使用示例
+1. 补充单个字符：
+```sql
+> SELECT lpad('hello', 7, '#');
+##hello
+
+```
+
+2. 使用默认填充字符（空格）：
+```sql
+> SELECT lpad('world', 10);
+      world     
+```
+
+
+3. 指定填充字符串为特殊字符：
+```sql
+> SELECT lpad('!', 6, '@@');
+@@@@@!
+```
+
+
+4. 当 `len` 小于 1 时，返回空字符串：
+```sql
+> SELECT lpad('example', 0, '%');
+```
+
+在这个例子中，指定的目标长度 `len` 为 0，LPAD 函数将返回空字符串。

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

@@ -0,0 +1,48 @@
+### LTRIM 函数
+```
+LTRIM(str [, trimStr])
+```
+#### 功能描述
+LTRIM 函数用于去除字符串 `str` 左侧的指定字符或空格。如果未提供 `trimStr` 参数，则默认删除 `str` 左侧的所有空格。
+
+#### 参数说明
+- `str` (string): 需要处理的原始字符串。
+- `trimStr` (string, 可选): 指定要从 `str` 左侧删除的字符集。
+
+#### 返回结果
+返回处理后的字符串。
+
+#### 使用示例
+1. 删除字符串左侧的所有空格：
+   ```sql
+   SELECT 'X' || LTRIM('    HelloWorld    ') || 'X';
+   -- 结果：XHelloWorld    X
+   ```
+   
+2. 删除字符串左侧的特定字符：
+   ```sql
+   SELECT LTRIM('HelloWorld', 'He');
+   -- 结果：World
+   ```
+   
+3. 删除字符串左侧的多个字符（字符集）：
+   ```sql
+   SELECT LTRIM('!!!HelloWorld!!!', '!');
+   -- 结果：HelloWorld
+   ```
+   
+4. 当 `trimStr` 为空字符串时，不会对 `str` 进行任何操作：
+   ```sql
+   SELECT LTRIM('Hello', '');
+   -- 结果：Hello
+   ```
+   
+5. 如果 `trimStr` 中包含 `str` 中不存在的字符，LTRIM 函数仍会删除 `str` 左侧的空格：
+   ```sql
+   SELECT LTRIM('Hello', 'abc');
+   -- 结果：Hello
+   ```
+
+#### 注意事项
+- 当 `trimStr` 参数为空或仅包含空格时，LTRIM 函数的行为与 `LTRIM` 函数的默认行为相同，即删除字符串左侧的所有空格。
+- 如果 `trimStr` 参数中包含非打印字符或特殊字符，这些字符也会被用于去除 `str` 左侧的字符。

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

@@ -0,0 +1,37 @@
+### 掩码函数
+```sql
+mask_inner(str, margin1, margin2 [, mask_char]) 
+mask_outer(str, margin1, margin2 [, mask_char]) 
+```
+#### 功能描述
+`mask_inner` 和 `mask_outer` 函数用于对字符串中的部分字符进行替换，通常用于隐藏敏感信息，如密码、手机号码等。`mask_inner` 函数会保留字符串两端各 `margin1` 和 `margin2` 长度的字符，而将中间部分字符替换为指定的掩码字符（默认为 'X'）。`mask_outer` 函数则屏蔽字符串两端各 `margin1` 和 `margin2` 长度的字符，保留中间部分。
+
+#### 参数说明
+* `str`: 需要处理的原始字符串。
+* `margin1`: 保留或屏蔽左端的字符数量。
+* `margin2`: 保留或屏蔽右端的字符数量。
+* `mask_char` (可选): 用于替换中间部分字符的掩码字符，默认为 'X'。
+
+#### 返回值
+返回处理后的字符串。
+
+#### 使用示例
+```sql
+-- 示例1：隐藏手机号码中间四位
+SELECT mask_inner('13812345678', 3, 4);
+-- 返回结果：135XXXXX876
+
+-- 示例2：保留邮箱地址的前后部分，隐藏用户名部分
+SELECT mask Outer('alice@example.com', 5, 0);
+-- 返回结果：XXXXX@example.com
+
+-- 示例3：隐藏信用卡号中间八位
+SELECT mask_inner('1234 5678 9012 3456', 4, 4, '*');
+-- 返回结果：1234 **** 9012 3456
+
+-- 示例4：隐藏身份证号码中间十位
+SELECT mask_inner('11010519850605003X', 2, 10);
+-- 返回结果：11XXXXXXXXX03X
+```
+
+通过以上示例，您可以根据实际需求灵活使用 `mask_inner` 和 `mask_outer` 函数来保护用户的隐私信息。

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

@@ -0,0 +1,71 @@
+### MD5函数
+
+#### 简介
+
+MD5函数用于计算给定字符串的MD5散列值。MD5是一种广泛使用的哈希函数，它可以将任意长度的数据映射为固定长度（128位）的散列值。MD5散列值通常用于验证数据的完整性。
+
+#### 语法
+
+```
+md5(expr)
+```
+
+#### 参数
+
+* `expr`: 需要计算MD5值的字符串、字符或变长字符数据类型。
+
+#### 返回结果
+
+返回一个字符串，表示计算得到的MD5散列值。
+
+#### 使用示例
+
+1. 计算一个简单字符串的MD5值：
+
+```
+SELECT md5('hello')as res;
++----------------------------------+
+|               res                |
++----------------------------------+
+| 5d41402abc4b2a76b9719d911017c592 |
++----------------------------------+
+```
+
+2. 计算一个包含特殊字符的字符串的MD5值：
+
+```
+SELECT md5('Hello, World!') as res;
++----------------------------------+
+|               res                |
++----------------------------------+
+| 65a8e27d8879283831b664bd8b7f0ad4 |
++----------------------------------+
+```
+
+3. 计算一个中文字符串的MD5值：
+
+```
+SELECT md5('你好，世界！') as res;
++----------------------------------+
+|               res                |
++----------------------------------+
+| 5082079d92a8ef985f59e001d445ff20 |
++----------------------------------+
+```
+
+4. 计算一个包含数字的字符串的MD5值：
+
+```
+SELECT md5('12345');
++----------------------------------+
+|               res                |
++----------------------------------+
+| 827ccb0eea8a706c4c34a16891f84e7b |
++----------------------------------+
+```
+
+#### 注意事项
+
+* MD5散列值是不可逆的，即无法从散列值反推出原始数据。
+
+

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

@@ -0,0 +1,47 @@
+### 函数名称
+OCTET_LENGTH
+
+### 功能描述
+OCTET_LENGTH 函数用于计算字符串（string）或二进制数据（binary）的字节长度。该函数在处理文本数据时非常有用，尤其是在需要确定数据大小或进行字符编码转换时。
+
+### 语法
+```
+OCTET_LENGTH(expr)
+```
+其中，`expr` 是一个字符串或二进制数据类型的表达式。
+
+### 参数
+- `expr`: 需要计算字节长度的字符串或二进制数据。
+
+### 返回结果
+返回一个整数，表示输入数据的字节长度。
+
+### 使用示例
+1. 计算英文字符串的字节长度：
+   ```sql
+   SELECT OCTET_LENGTH('HelloWorld'); -- 结果为 10
+   ```
+   上述示例中，字符串 "HelloWorld" 包含 10 个字符，因此返回的字节长度为 10。
+
+2. 计算中文字符串的字节长度：
+   ```sql
+   SELECT OCTET_LENGTH('你好'); -- 结果为 6
+   ```
+   由于中文字符在 UTF-8 编码下通常占用 3 个字节，字符串 "你好" 包含 2 个中文字符，因此返回的字节长度为 6。
+
+3. 计算二进制数据的字节长度：
+   ```sql
+   SELECT OCTET_LENGTH(X'48656C6C6F20576F726C64'); -- 结果为 20
+   ```
+   上述示例中，十六进制字符串 "48656C6C6F20576F726C64" 解码后对应于 ASCII 编码的字符串 "Hello World"，占用 11 个字节。
+
+4. 在查询中使用 OCTET_LENGTH 函数：
+   ```sql
+   SELECT username, OCTET_LENGTH(password) as password_length
+   FROM users;
+   ```
+   在此示例中，我们从用户表中选择用户名和密码的字节长度。这可以帮助我们了解数据存储大小或密码的复杂度（结合其他因素）。
+
+### 注意事项
+- 当处理多字节字符集（如 UTF-8）时，字符的实际字节长度可能与字符数不同。
+- 在比较字符串长度时，务必注意字符编码和字节顺序的影响。

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

@@ -0,0 +1,78 @@
+### PARSE_URL 函数
+
+#### 功能描述
+PARSE_URL 函数用于从给定的 URL 中提取特定的部分。根据指定的 partToExtract 参数，可以从 URL 中提取主机名、路径、查询参数、引用、协议或文件名等信息。需要注意的是，该函数不会对 URL 的有效性进行校验。
+
+#### 参数说明
+* **url** (string 类型): 需要解析的 URL 地址。
+* **partToExtract** (string 类型): 需要提取的 URL 部分，可选值包括：HOST, PATH, QUERY, REF, PROTOCOL, FILE。
+* **key** (可选参数，string 类型): 当 partToExtract 为 QUERY 时，用于指定需要提取的查询参数的键名。
+
+#### 返回值
+函数返回提取到的 URL 部分，类型为 string。
+
+#### 使用示例
+以下示例展示了如何使用 PARSE_URL 函数提取不同部分的信息：
+
+1. 提取主机名：
+   ```sql
+   SELECT PARSE_URL('http://spark.apache.org/path?query=1#ref', 'HOST') AS host;
+   ```
+   结果：
+   ```
+   spark.apache.org
+   ```
+
+2. 提取路径：
+   ```sql
+   SELECT PARSE_URL('http://spark.apache.org/path?query=1#ref', 'PATH') AS path;
+   ```
+   结果：
+   ```
+   /path
+   ```
+
+3. 提取查询参数：
+   ```sql
+   SELECT PARSE_URL('http://spark.apache.org/path?query=1#ref', 'QUERY') AS query;
+   ```
+   结果：
+   ```
+   query=1
+   ```
+
+4. 提取引用：
+   ```sql
+   SELECT PARSE_URL('http://spark.apache.org/path?query=1#ref', 'REF') AS ref;
+   ```
+   结果：
+   ```
+   ref
+   ```
+
+5. 提取协议：
+   ```sql
+   SELECT PARSE_URL('http://spark.apache.org/path?query=1#ref', 'PROTOCOL') AS protocol;
+   ```
+   结果：
+   ```
+   http
+   ```
+
+6. 提取文件名：
+   ```sql
+   SELECT PARSE_URL('http://spark.apache.org/path?query=1#ref', 'FILE') AS file;
+   ```
+   结果：
+   ```
+   /path?query=1
+   ```
+
+7. 提取特定键名的查询参数值：
+   ```sql
+   SELECT PARSE_URL('http://spark.apache.org/path?query=1&key=value#ref', 'QUERY', 'key') AS key_value;
+   ```
+   结果：
+   ```
+   value
+   ```