JSON_EXTRACT_ARRAY_ELEMENT_TEXT 函数

注意

JSON_PARSE 及其关联函数将 JSON 值解析为 SUPER，Amazon Redshift 解析 SUPER 的效率比 VARCHAR 更高。

我们建议您使用 JSON_PARSE 函数解析 JSON 字符串来获取 SUPER 值，而不是使用 JSON_EXTRACT_ARRAY_ELEMENT_TEXT。然后，使用 value[element position] 语法，通过其数组索引查询所需的元素。有关在 SUPER 值中查询数组元素的更多信息，请转到查询半结构化数据。

JSON_EXTRACT_ARRAY_ELEMENT_TEXT 函数返回 JSON 字符串的最外侧数组中的 JSON 数组元素（使用从零开始的索引）。数组中的第一个元素位于位置 0。如果索引为负或超出界限，JSON_EXTRACT_ARRAY_ELEMENT_TEXT 将返回 NULL。如果 null_if_invalid 参数设置为 TRUE 并且 JSON 字符串无效，函数将返回 NULL 而不是返回错误。

有关更多信息，请参阅 JSON 函数。

语法

JSON_EXTRACT_ARRAY_ELEMENT_TEXT('json string', pos [, null_if_invalid ] )

参数

json_string

格式正确的 JSON 字符串。

pos

一个 INTEGER，表示要返回的数组元素的索引（使用从零开始的数组索引）。

null_if_invalid

（可选）一个 BOOLEAN 值，指定在输入 JSON 字符串无效时是否返回 NULL，而不返回错误。要在 JSON 无效时返回 NULL，请指定 true（t）。要在 JSON 无效时返回错误，请指定 false (f)。默认为 false。

返回类型

VARCHAR

表示 pos 引用的 JSON 数组元素的 VARCHAR 字符串。

示例

要返回位置 2 的数组元素（它是从零开始的数组索引的第三个元素），请使用以下示例：

SELECT JSON_EXTRACT_ARRAY_ELEMENT_TEXT('[111,112,113]', 2);
 
+---------------------------------+
| json_extract_array_element_text |
+---------------------------------+
|                             113 |
+---------------------------------+

要因为 JSON 无效而返回错误，请使用以下示例。

SELECT JSON_EXTRACT_ARRAY_ELEMENT_TEXT('["a",["b",1,["c",2,3,null,]]]',1);
 
ERROR: invalid json array object ["a",["b",1,["c",2,3,null,]]] 

要将 null_if_invalid 设置为 true，以便语句返回 NULL，而不是在 JSON 无效时返回错误，请使用以下示例。

SELECT JSON_EXTRACT_ARRAY_ELEMENT_TEXT('["a",["b",1,["c",2,3,null,]]]',1,true);
 
+---------------------------------+
| json_extract_array_element_text |
+---------------------------------+
| NULL                            |
+---------------------------------+

考虑以下示例语句。如果提供的 JSON 字符串或索引为 NULL，则 JSON_EXTRACT_ARRAY_ELEMENT_TEXT 会返回 NULL，无论任何其他参数的值如何。

--Statement where json_string is NULL.
SELECT json_extract_array_element_text(NULL, 0)

 json_extract_array_element_text
---------------------------------
                            NULL

--Statement where pos is NULL and json_string is invalid JSON.
SELECT json_extract_array_element_text('invalid_json', NULL);

 json_extract_array_element_text
---------------------------------
                            NULL

--Statement where json_string is NULL and null_if_invalid is FALSE.
SELECT json_extract_array_element_text(NULL, 0, FALSE);

 json_extract_array_element_text
---------------------------------
                            NULL

考虑以下示例语句。如果 null_if_invalid 为 TRUE，则当 json_string 为无效 JSON 时，JSON_EXTRACT_ARRAY_ELEMENT_TEXT 会返回 NULL。如果 null_if_invalid 为 FALSE 或未设置，则当 json_string 无效时，该函数会返回错误。

--Statement with invalid JSON where null_if_invalid is TRUE.
SELECT json_extract_array_element_text('invalid_json', 0, TRUE);

 json_extract_array_element_text
---------------------------------
                            NULL
                            
--Statement with invalid JSON where null_if_invalid is FALSE.
SELECT json_extract_array_element_text('invalid_json', 0);

ERROR:  JSON parsing error

考虑以下示例，其中 json_string 是有效的 JSON，pos 指的是 JSON null 值。在此情况下，不管 null_if_invalid 的值如何，JSON_EXTRACT_ARRAY_ELEMENT_TEXT 都会返回 NULL。

--Statement selecting a null value.
SELECT json_extract_array_element_text('[null]', 0);

  json_extract_array_element_text 
----------------------------------
                             NULL