TRY_PARSE_TO_VARIANT

功能

TRY_PARSE_TO_VARIANT 尝试把一个完整 JSON 值解析为 VARIANT。函数名中的 TRY_ 表示：发生解析错误时返回 SQL NULL，而不是使查询失败。默认情况下，非法 JSON 文本不算解析错误，详见“返回值”。该函数自 Doris 4.1.4 起支持；本页描述的是 Doris 5.0.0 及之后版本中的行为。

语法

TRY_PARSE_TO_VARIANT(<json_value>)

参数

参数	说明
<json_value>	包含一个完整 JSON 值的 CHAR、VARCHAR 或 STRING 表达式，也可以是 JSON/JSONB 表达式。JSON/JSONB 输入会先转换为 JSON 文本，再解析为 VARIANT。

返回值

返回可为 NULL 的 VARIANT 值。

• 合法输入返回解析后的 VARIANT 值。
• 以下解析错误返回 SQL NULL：对象 key 超过 variant_max_json_key_length 字节（BE 配置，默认 255）、同一对象中有重复 key（BE 配置 variant_enable_duplicate_json_path_check 为 true 时保留第一个值，不返回 NULL）、嵌套超过 128 层、字符串不是合法的 UTF-8。
• 非法 JSON 文本，以及包含超出 [-2^63, 2^64 - 1] 的整数或超出 DOUBLE 范围的数值的 JSON，与 PARSE_TO_VARIANT 一样作为 VARIANT 字符串返回。只有当 BE 配置 variant_throw_exeception_on_invalid_json 为 true（默认 false）时，才返回 SQL NULL。
• 输入为空字符串时返回空对象 {}。
• 输入为 SQL NULL 时返回 SQL NULL。
• JSON 字面量 null 返回 VARIANT null，不是 SQL NULL。

示例

保留合法值，并把解析错误转换为 SQL NULL：

SELECT CAST(
           TRY_PARSE_TO_VARIANT('{"id": 1}')
           AS STRING
       ) AS valid_value,
       TRY_PARSE_TO_VARIANT('{"id": 1, "id": 2}') IS NULL AS duplicate_is_null,
       TRY_PARSE_TO_VARIANT(NULL) IS NULL AS input_is_null;

+-------------+-------------------+---------------+
| valid_value | duplicate_is_null | input_is_null |
+-------------+-------------------+---------------+
| {"id":1}    |                 1 |             1 |
+-------------+-------------------+---------------+

解析 JSON/JSONB 输入：

SELECT CAST(
           TRY_PARSE_TO_VARIANT(CAST('[10, 20, 30]' AS JSON))
           AS STRING
       ) AS value;

+------------+
| value      |
+------------+
| [10,20,30] |
+------------+

JSON null 不等于 SQL NULL；非法 JSON 文本会保留为字符串：

SELECT TRY_PARSE_TO_VARIANT('null') IS NULL AS json_null_is_sql_null,
       VARIANT_TYPE(TRY_PARSE_TO_VARIANT('{"id":')) AS invalid_json_type;

+-----------------------+-------------------+
| json_null_is_sql_null | invalid_json_type |
+-----------------------+-------------------+
|                     0 | string            |
+-----------------------+-------------------+

使用说明

• 如果解析错误应该使查询失败并暴露数据质量问题，请使用 PARSE_TO_VARIANT。
• 本函数只会把解析错误转换为 SQL NULL，不会改变合法 JSON null 的含义。
• Stream Load 等导入作业按与本函数相同的规则解析 JSON 文本，参见解析错误。