MySQL :: MySQL 8.3 Reference Manual :: 14.17.6 JSON Table Functions

version 8.3

8.0 current

8.0 Japanese

MySQL 8.3 Reference Manual / ... / JSON Table Functions

14.17.6 JSON 表函数

本节包含将 JSON 数据转换为表格数据的 JSON 函数信息。MySQL 8.3 支持一个这样的函数，JSON_TABLE()。

JSON_TABLE(expr, path COLUMNS (column_list) [AS] alias)

从 JSON 文档中提取数据并将其作为关系表返回，具有指定的列。该函数的完整语法如下所示：

JSON_TABLE(
    expr,
    path COLUMNS (column_list)
)   [AS] alias

column_list:
    column[, column][, ...]

column:
    name FOR ORDINALITY
    |  name type PATH string path [on_empty] [on_error]
    |  name type EXISTS PATH string path
    |  NESTED [PATH] path COLUMNS (column_list)

on_empty:
    {NULL | DEFAULT json_string | ERROR} ON EMPTY

on_error:
    {NULL | DEFAULT json_string | ERROR} ON ERROR

expr：这是一个返回 JSON 数据的表达式。这可以是一个常量 ('{"a":1}')、一个列 (t1.json_data，假设表 t1 在 FROM 子句中指定之前的 JSON_TABLE()) 或函数调用 (JSON_EXTRACT(t1.json_data,'$.post.comments'))。

path：一个 JSON 路径表达式，应用于数据源。我们将匹配该路径的 JSON 值称为行源；这用于生成关系数据的行。 COLUMNS 子句评估行源，找到行源中的特定 JSON 值，并将这些 JSON 值作为关系数据的行中的单个列返回。

需要 alias。通常的表别名规则适用（见第 11.2 节，“模式对象名称”）。

该函数以不区分大小写的方式比较列名。

JSON_TABLE() 支持四种类型的列，以下是它们的描述：

name FOR ORDINALITY：该类型枚举 COLUMNS 子句中的行；名为 name 的列是一个计数器，其类型为 UNSIGNED INT，初始值为 1。这相当于在 CREATE TABLE 语句中指定一个列为 AUTO_INCREMENT，并可以用于区分具有相同值的多行父行。
name type PATH string_path [on_empty] [on_error]：该类型的列用于提取由 string_path 指定的值。type 是 MySQL 标量数据类型（即不能是对象或数组）。JSON_TABLE() 将数据从 JSON 提取出来，然后强制转换为列类型，使用 MySQL 中 JSON 数据的常规自动类型转换。如果值缺失，将触发 on_empty 子句。将对象或数组保存时，将触发可选的 on_error 子句；这也发生在从 JSON 保存的值强制转换为表列时出错时，例如尝试将字符串 'asd' 保存到整数列中。
name type EXISTS PATH path：该列返回 1，如果在 path 指定的位置存在任何数据，否则返回 0。type 可以是任何有效的 MySQL 数据类型，但通常应该指定为某种整数类型。
NESTED [PATH] path COLUMNS (column_list)：该类型将嵌套对象或数组中的 JSON 数据展平到单行中，连同父对象或数组中的 JSON 值。使用多个 PATH 选项允许从多个嵌套级别投影 JSON 值到单行中。

该 path 相对于 JSON_TABLE() 的父路径行路径，或者在嵌套路径的情况下是父 NESTED [PATH] 子句的路径。

如果为空, 如果指定，确定了 JSON_TABLE() 在数据缺失时（取决于类型）的行为。该子句也在 NESTED PATH 子句中触发，当后者没有匹配并产生一个补充的空行时。 如果为空 可以取以下值：

NULL 如果为空：该列被设置为 NULL；这是默认行为。
DEFAULT json_string 如果为空：提供的 json_string 被解析为 JSON，并存储而不是缺失的值。列类型规则也适用于默认值。
ERROR 如果为空：抛出错误。

如果使用， on_error 可以取以下值，结果如下所示：

NULL 如果错误：该列被设置为 NULL；这是默认行为。
DEFAULT json string 如果错误：提供的 json_string 被解析为 JSON（只要它是有效的），并存储而不是对象或数组。
ERROR 如果错误：抛出错误。

在 MySQL 中，指定 ON ERROR 在 ON EMPTY 之前是非标准的，并且已经弃用；尝试这样做将导致服务器发出警告。预计在未来版本的 MySQL 中将删除对非标准语法的支持。

当值保存到列时被截断，例如在 DECIMAL(10,1) 列中保存 3.14159，独立于任何 ON ERROR 选项，警告将被发出。当单个语句中多个值被截断时，警告只发出一次。

当表达式和路径传递给该函数时解析为 JSON null， JSON_TABLE() 返回 SQL NULL，符合 SQL 标准，如下所示：

mysql> SELECT *
    ->   FROM
    ->     JSON_TABLE(
    ->       '[ {"c1": null} ]',
    ->       '$[*]' COLUMNS( c1 INT PATH '$.c1' ERROR ON ERROR )
    ->     ) as jt;
+------+
| c1   |
+------+
| NULL |
+------+
1 row in set (0.00 sec)

以下查询演示了 ON EMPTY 和 ON ERROR 的使用。对应于 {"b":1} 的行为空对于路径 "$.a"，尝试将 [1,2] 保存为标量将产生错误；这些行在输出中被突出显示。

mysql> SELECT *
    -> FROM
    ->   JSON_TABLE(
    ->     '[{"a":"3"},{"a":2},{"b":1},{"a":0},{"a":[1,2]}]',
    ->     "$[*]"
    ->     COLUMNS(
    ->       rowid FOR ORDINALITY,
    ->       ac VARCHAR(100) PATH "$.a" DEFAULT '111' ON EMPTY DEFAULT '999' ON ERROR,
    ->       aj JSON PATH "$.a" DEFAULT '{"x": 333}' ON EMPTY,
    ->       bx INT EXISTS PATH "$.b"
    ->     )
    ->   ) AS tt;

+-------+------+------------+------+
| rowid | ac   | aj         | bx   |
+-------+------+------------+------+
|     1 | 3    | "3"        |    0 |
|     2 | 2    | 2          |    0 |
|     3 | 111  | {"x": 333} |    1 |
|     4 | 0    | 0          |    0 |
|     5 | 999  | [1, 2]     |    0 |
+-------+------+------------+------+
5 rows in set (0.00 sec)

列名遵循通常的规则和限制，见第 11.2 节，“Schema Object Names”。

所有 JSON 和 JSON 路径表达式都被检查以确保其有效性；无效的表达式将导致错误。

每个 path 前面的匹配都映射到结果表中的单个行。例如，以下查询将产生以下结果：

mysql> SELECT *
    -> FROM
    ->   JSON_TABLE(
    ->     '[{"x":2,"y":"8"},{"x":"3","y":"7"},{"x":"4","y":6}]',
    ->     "$[*]" COLUMNS(
    ->       xval VARCHAR(100) PATH "$.x",
    ->       yval VARCHAR(100) PATH "$.y"
    ->     )
    ->   ) AS  jt1;

+------+------+
| xval | yval |
+------+------+
| 2    | 8    |
| 3    | 7    |
| 4    | 6    |
+------+------+

表达式 "$[*]" 匹配数组的每个元素。你可以通过修改路径来过滤结果中的行。例如，使用 "$[1]" 将提取限制到源 JSON 数组的第二个元素，如下所示：

mysql> SELECT *
    -> FROM
    ->   JSON_TABLE(
    ->     '[{"x":2,"y":"8"},{"x":"3","y":"7"},{"x":"4","y":6}]',
    ->     "$[1]" COLUMNS(
    ->       xval VARCHAR(100) PATH "$.x",
    ->       yval VARCHAR(100) PATH "$.y"
    ->     )
    ->   ) AS  jt1;

+------+------+
| xval | yval |
+------+------+
| 3    | 7    |
+------+------+

在列定义中， "$" 将整个匹配传递给列； "$.x" 和 "$.y" 分别传递匹配中的键 x 和 y 的值。更多信息，请参阅 JSON Path 语法。

NESTED PATH（或简称 NESTED； PATH 是可选的）在 COLUMNS 子句中产生一组记录，每个匹配都对应于该子句。如果没有匹配，所有嵌套路径的列都将被设置为 NULL。这实现了顶级子句和 NESTED [PATH] 之间的外连接。可以通过在 WHERE 子句中应用适当的条件来模拟内连接，如下所示：

mysql> SELECT *
    -> FROM
    ->   JSON_TABLE(
    ->     '[ {"a": 1, "b": [11,111]}, {"a": 2, "b": [22,222]}, {"a":3}]',
    ->     '$[*]' COLUMNS(
    ->             a INT PATH '$.a',
    ->             NESTED PATH '$.b[*]' COLUMNS (b INT PATH '$')
    ->            )
    ->    ) AS jt
    -> WHERE b IS NOT NULL;

+------+------+
| a    | b    |
+------+------+
|    1 |   11 |
|    1 |  111 |
|    2 |   22 |
|    2 |  222 |
+------+------+

同级嵌套路径——即同一个 COLUMNS 子句中的两个或多个 NESTED [PATH] 实例——将一个接一个地处理，而不是同时处理。当一个嵌套路径产生记录时，任何同级嵌套路径表达式的列都将被设置为 NULL。这意味着单个包含 COLUMNS 子句的匹配的总记录数是所有 NESTED [PATH] 修饰符产生的记录数的总和，而不是乘积，如下所示：

mysql> SELECT *
    -> FROM
    ->   JSON_TABLE(
    ->     '[{"a": 1, "b": [11,111]}, {"a": 2, "b": [22,222]}]',
    ->     '$[*]' COLUMNS(
    ->         a INT PATH '$.a',
    ->         NESTED PATH '$.b[*]' COLUMNS (b1 INT PATH '$'),
    ->         NESTED PATH '$.b[*]' COLUMNS (b2 INT PATH '$')
    ->     )
    -> ) AS jt;

+------+------+------+
| a    | b1   | b2   |
+------+------+------+
|    1 |   11 | NULL |
|    1 |  111 | NULL |
|    1 | NULL |   11 |
|    1 | NULL |  111 |
|    2 |   22 | NULL |
|    2 |  222 | NULL |
|    2 | NULL |   22 |
|    2 | NULL |  222 |
+------+------+------+

一个 FOR ORDINALITY 列枚举了 COLUMNS 子句产生的记录，并可以用来区分嵌套路径的父记录，特别是当父记录的值相同时，如下所示：

mysql> SELECT *
    -> FROM
    ->   JSON_TABLE(
    ->     '[{"a": "a_val",
    '>       "b": [{"c": "c_val", "l": [1,2]}]},
    '>     {"a": "a_val",
    '>       "b": [{"c": "c_val","l": [11]}, {"c": "c_val", "l": [22]}]}]',
    ->     '$[*]' COLUMNS(
    ->       top_ord FOR ORDINALITY,
    ->       apath VARCHAR(10) PATH '$.a',
    ->       NESTED PATH '$.b[*]' COLUMNS (
    ->         bpath VARCHAR(10) PATH '$.c',
    ->         ord FOR ORDINALITY,
    ->         NESTED PATH '$.l[*]' COLUMNS (lpath varchar(10) PATH '$')
    ->         )
    ->     )
    -> ) as jt;

+---------+---------+---------+------+-------+
| top_ord | apath   | bpath   | ord  | lpath |
+---------+---------+---------+------+-------+
|       1 |  a_val  |  c_val  |    1 | 1     |
|       1 |  a_val  |  c_val  |    1 | 2     |
|       2 |  a_val  |  c_val  |    1 | 11    |
|       2 |  a_val  |  c_val  |    2 | 22    |
+---------+---------+---------+------+-------+

源文档包含一个具有两个元素的数组；每个元素生成两行。 apath 和 bpath 的值在整个结果集中保持不变；这意味着它们不能用于确定 lpath 值来自同一个或不同的父对象。 ord 列的值保持不变，等于具有 top_ord 等于 1 的记录集，因此这两个值来自同一个对象。剩下的两个值来自不同的对象，因为它们在 ord 列中具有不同的值。

通常，您不能在同一个 FROM 子句中连接依赖于前一个表的派生表。 MySQL 按照 SQL 标准，例外地允许表函数；这些被认为是侧面派生表。这是隐式的，因此在 JSON_TABLE() 之前不允许，也是按照标准。

假设您创建并填充了表 t1，使用以下语句：

CREATE TABLE t1 (c1 INT, c2 CHAR(1), c3 JSON);

INSERT INTO t1 () VALUES
	ROW(1, 'z', JSON_OBJECT('a', 23, 'b', 27, 'c', 1)),
	ROW(1, 'y', JSON_OBJECT('a', 44, 'b', 22, 'c', 11)),
	ROW(2, 'x', JSON_OBJECT('b', 1, 'c', 15)),
	ROW(3, 'w', JSON_OBJECT('a', 5, 'b', 6, 'c', 7)),
	ROW(5, 'v', JSON_OBJECT('a', 123, 'c', 1111))
;

然后，您可以执行连接，例如以下连接，其中 JSON_TABLE() 作为派生表，同时也引用了前一个表中的列：

SELECT c1, c2, JSON_EXTRACT(c3, '$.*') 
FROM t1 AS m 
JOIN 
JSON_TABLE(
  m.c3, 
  '$.*' 
  COLUMNS(
    at VARCHAR(10) PATH '$.a' DEFAULT '1' ON EMPTY, 
    bt VARCHAR(10) PATH '$.b' DEFAULT '2' ON EMPTY, 
    ct VARCHAR(10) PATH '$.c' DEFAULT '3' ON EMPTY
  )
) AS tt
ON m.c1 > tt.at;

尝试使用 LATERAL 关键字与该查询将引发 ER_PARSE_ERROR。

PREV HOME UP NEXT