`mask` 函数

2025-10-20

适用于：勾选标记为“是” Databricks SQL Databricks Runtime 12.2 LTS 及更高版本

返回输入 str 的掩码版本。

在 Databricks SQL 和 Databricks Runtime 13.3 LTS 及更高版本中，此函数支持命名参数调用。

语法

mask(str [, upperChar [, lowerChar [, digitChar [, otherChar ] ] ] ] )

参数

str：一个 STRING 表达式。
upperChar：用于替换大写字符的单字符 STRING 文本。默认为 'X'。如果 upperChar 为 NULL，则大写字符保持未掩码状态。
lowerChar：用于替换小写字符的单字符 STRING 文本。默认为 'x'。如果 lowerChar 为 NULL，则小写字符保持未掩码状态。
digitChar：用于替换数字的单字符 STRING 文本。默认为 'n'。如果 digitChar 为 NULL，则数字保持未掩码状态。
otherChar：用于替换任何其他字符的单字符 STRING 文本。默认值为 NULL，即使这些字符保持未掩码状态。

返回

一个 STRING。

示例

> SELECT mask('AaBb123-&^ % 서울 Ä');
  XxXxnnn-&^ % 서울 X

> SELECT mask('AaBb123-&^ % 서울 Ä', 'Z', 'z', '9', 'X');
  ZzZz999XXXXXXXXXZ

> SELECT mask('AaBb123-&^ % 서울 Ä', lowerChar => 'z', otherChar => 'X');
  AzBz123XXXXXXXXXÄ

> SELECT mask('AaBb123-&^ % 서울 Ä', otherChar => '?');
  AaBb123?????????Ä

> SELECT mask('AaBb123-&^ % 서울 Ä', NULL, NULL, NULL, NULL);
  AaBb123-&^ % 서울 Ä