MySQL :: MySQL 8.4 参考手册 :: 14.17.8 JSON 实用函数

版本 8.4

8.0 日语

MySQL 8.4 参考手册 / ... / JSON 实用函数

14.17.8 JSON 实用函数

本节介绍对 JSON 值或可以解析为 JSON 值的字符串进行操作的实用函数。 JSON_PRETTY() 以易于阅读的格式打印 JSON 值。 JSON_STORAGE_SIZE() 和 JSON_STORAGE_FREE() 分别显示给定 JSON 值使用的存储空间量以及在部分更新后 JSON 列中剩余的空间量。

JSON_PRETTY(json_val)

提供类似于 PHP 和其他语言以及数据库系统中实现的 JSON 值的漂亮打印。提供的值必须是 JSON 值或 JSON 值的有效字符串表示。此值中存在的无关紧要的空格和换行符对输出没有影响。对于 NULL 值，函数返回 NULL。如果该值不是 JSON 文档，或者无法将其解析为 JSON 文档，则函数将失败并出现错误。

此函数的输出格式遵循以下规则

每个数组元素或对象成员都出现在单独的行上，缩进级别比其父级多一个级别。
每个缩进级别都会添加两个前导空格。
分隔各个数组元素或对象成员的逗号将打印在分隔这两个元素或成员的换行符之前。
对象成员的键和值用冒号和空格分隔（': '）。
空对象或数组在单行上打印。在开括号和闭括号之间不打印空格。
字符串标量和键名中的特殊字符使用与 JSON_QUOTE() 函数相同的规则进行转义。

mysql> SELECT JSON_PRETTY('123'); # scalar
+--------------------+
| JSON_PRETTY('123') |
+--------------------+
| 123                |
+--------------------+

mysql> SELECT JSON_PRETTY("[1,3,5]"); # array
+------------------------+
| JSON_PRETTY("[1,3,5]") |
+------------------------+
| [
  1,
  3,
  5
]      |
+------------------------+

mysql> SELECT JSON_PRETTY('{"a":"10","b":"15","x":"25"}'); # object
+---------------------------------------------+
| JSON_PRETTY('{"a":"10","b":"15","x":"25"}') |
+---------------------------------------------+
| {
  "a": "10",
  "b": "15",
  "x": "25"
}   |
+---------------------------------------------+

mysql> SELECT JSON_PRETTY('["a",1,{"key1":
    '>    "value1"},"5",     "77" ,
    '>       {"key2":["value3","valueX",
    '> "valueY"]},"j", "2"   ]')\G  # nested arrays and objects
*************************** 1. row ***************************
JSON_PRETTY('["a",1,{"key1":
             "value1"},"5",     "77" ,
                {"key2":["value3","valuex",
          "valuey"]},"j", "2"   ]'): [
  "a",
  1,
  {
    "key1": "value1"
  },
  "5",
  "77",
  {
    "key2": [
      "value3",
      "valuex",
      "valuey"
    ]
  },
  "j",
  "2"
]

JSON_STORAGE_FREE(json_val)

对于 JSON 列值，此函数显示使用 JSON_SET()、JSON_REPLACE() 或 JSON_REMOVE() 在其二进制表示形式中进行就地更新后释放的存储空间量。该参数也可以是有效的 JSON 文档，或可以解析为 JSON 文档的字符串，无论是作为文字值还是作为用户变量的值，在这种情况下，函数将返回 0。如果该参数是 JSON 列值，并且如前所述已更新，使其二进制表示形式占用的空间小于更新前的空间，则它将返回一个正的非零值。对于已更新的 JSON 列，使其二进制表示形式与以前相同或更大，或者如果更新无法利用部分更新，则它将返回 0；如果该参数是 NULL，则它将返回 NULL。

如果 json_val 不为 NULL，并且既不是有效的 JSON 文档，也无法成功解析为 JSON 文档，则会导致错误。

在此示例中，我们创建一个包含 JSON 列的表，然后插入包含 JSON 对象的行

mysql> CREATE TABLE jtable (jcol JSON);
Query OK, 0 rows affected (0.38 sec)

mysql> INSERT INTO jtable VALUES
    ->     ('{"a": 10, "b": "wxyz", "c": "[true, false]"}');
Query OK, 1 row affected (0.04 sec)

mysql> SELECT * FROM jtable;
+----------------------------------------------+
| jcol                                         |
+----------------------------------------------+
| {"a": 10, "b": "wxyz", "c": "[true, false]"} |
+----------------------------------------------+
1 row in set (0.00 sec)

现在，我们使用 JSON_SET() 更新列值，以便可以执行部分更新；在本例中，我们用一个占用更少空间的值（整数 1）替换 c 键指向的值（数组 [true, false]）

mysql> UPDATE jtable
    ->     SET jcol = JSON_SET(jcol, "$.a", 10, "$.b", "wxyz", "$.c", 1);
Query OK, 1 row affected (0.03 sec)
Rows matched: 1  Changed: 1  Warnings: 0

mysql> SELECT * FROM jtable;
+--------------------------------+
| jcol                           |
+--------------------------------+
| {"a": 10, "b": "wxyz", "c": 1} |
+--------------------------------+
1 row in set (0.00 sec)

mysql> SELECT JSON_STORAGE_FREE(jcol) FROM jtable;
+-------------------------+
| JSON_STORAGE_FREE(jcol) |
+-------------------------+
|                      14 |
+-------------------------+
1 row in set (0.00 sec)

如以下示例所示，连续部分更新对该可用空间的影响是累积的，使用 JSON_SET() 减少具有键 b 的值占用的空间（并且不进行任何其他更改）

mysql> UPDATE jtable
    ->     SET jcol = JSON_SET(jcol, "$.a", 10, "$.b", "wx", "$.c", 1);
Query OK, 1 row affected (0.03 sec)
Rows matched: 1  Changed: 1  Warnings: 0

mysql> SELECT JSON_STORAGE_FREE(jcol) FROM jtable;
+-------------------------+
| JSON_STORAGE_FREE(jcol) |
+-------------------------+
|                      16 |
+-------------------------+
1 row in set (0.00 sec)

在不使用 JSON_SET()、JSON_REPLACE() 或 JSON_REMOVE() 的情况下更新列意味着优化器无法就地执行更新；在本例中，JSON_STORAGE_FREE() 返回 0，如下所示

mysql> UPDATE jtable SET jcol = '{"a": 10, "b": 1}';
Query OK, 1 row affected (0.05 sec)
Rows matched: 1  Changed: 1  Warnings: 0

mysql> SELECT JSON_STORAGE_FREE(jcol) FROM jtable;
+-------------------------+
| JSON_STORAGE_FREE(jcol) |
+-------------------------+
|                       0 |
+-------------------------+
1 row in set (0.00 sec)

仅能对列值执行 JSON 文档的部分更新。对于存储 JSON 值的用户变量，即使使用 JSON_SET() 执行更新，该值也将始终完全替换

mysql> SET @j = '{"a": 10, "b": "wxyz", "c": "[true, false]"}';
Query OK, 0 rows affected (0.00 sec)

mysql> SET @j = JSON_SET(@j, '$.a', 10, '$.b', 'wxyz', '$.c', '1');
Query OK, 0 rows affected (0.00 sec)

mysql> SELECT @j, JSON_STORAGE_FREE(@j) AS Free;
+----------------------------------+------+
| @j                               | Free |
+----------------------------------+------+
| {"a": 10, "b": "wxyz", "c": "1"} |    0 |
+----------------------------------+------+
1 row in set (0.00 sec)

对于 JSON 文字，此函数始终返回 0

mysql> SELECT JSON_STORAGE_FREE('{"a": 10, "b": "wxyz", "c": "1"}') AS Free;
+------+
| Free |
+------+
|    0 |
+------+
1 row in set (0.00 sec)

JSON_STORAGE_SIZE(json_val)

此函数返回用于存储 JSON 文档二进制表示形式的字节数。当参数是 JSON 列时，这是用于存储 JSON 文档的空间，因为它是插入到列中的，在任何可能在之后对其执行的部分更新之前。 json_val 必须是有效的 JSON 文档或可以解析为 JSON 文档的字符串。在字符串情况下，函数将返回将字符串解析为 JSON 并将其转换为二进制后创建的 JSON 二进制表示形式中的存储空间量。如果该参数是 NULL，则它将返回 NULL。

当 json_val 不为 NULL，并且不是有效的 JSON 文档或无法成功解析为 JSON 文档时，会导致错误。

为了说明此函数在使用 JSON 列作为其参数时如何运行，我们创建一个名为 jtable 的表，其中包含 JSON 列 jcol，将 JSON 值插入到表中，然后使用 JSON_STORAGE_SIZE() 获取该列使用的存储空间，如下所示

mysql> CREATE TABLE jtable (jcol JSON);
Query OK, 0 rows affected (0.42 sec)

mysql> INSERT INTO jtable VALUES
    ->     ('{"a": 1000, "b": "wxyz", "c": "[1, 3, 5, 7]"}');
Query OK, 1 row affected (0.04 sec)

mysql> SELECT
    ->     jcol,
    ->     JSON_STORAGE_SIZE(jcol) AS Size,
    ->     JSON_STORAGE_FREE(jcol) AS Free
    -> FROM jtable;
+-----------------------------------------------+------+------+
| jcol                                          | Size | Free |
+-----------------------------------------------+------+------+
| {"a": 1000, "b": "wxyz", "c": "[1, 3, 5, 7]"} |   47 |    0 |
+-----------------------------------------------+------+------+
1 row in set (0.00 sec)

根据 JSON_STORAGE_SIZE() 的输出，插入到列中的 JSON 文档占用 47 字节。我们还使用 JSON_STORAGE_FREE() 检查了之前对该列的任何部分更新释放的空间量；由于尚未执行任何更新，因此正如预期的那样，值为 0。

接下来，我们对表执行 UPDATE 操作，这应该会导致存储在 jcol 中的文档进行部分更新，然后按照这里所示测试结果

mysql> UPDATE jtable SET jcol = 
    ->     JSON_SET(jcol, "$.b", "a");
Query OK, 1 row affected (0.04 sec)
Rows matched: 1  Changed: 1  Warnings: 0

mysql> SELECT
    ->     jcol,
    ->     JSON_STORAGE_SIZE(jcol) AS Size,
    ->     JSON_STORAGE_FREE(jcol) AS Free
    -> FROM jtable;
+--------------------------------------------+------+------+
| jcol                                       | Size | Free |
+--------------------------------------------+------+------+
| {"a": 1000, "b": "a", "c": "[1, 3, 5, 7]"} |   47 |    3 |
+--------------------------------------------+------+------+
1 row in set (0.00 sec)

在之前的查询中，JSON_STORAGE_FREE() 返回的值表明对 JSON 文档执行了部分更新，并且这释放了用于存储它的 3 字节空间。由 JSON_STORAGE_SIZE() 返回的结果不受部分更新的影响。

部分更新受使用 JSON_SET()、JSON_REPLACE() 或 JSON_REMOVE() 的更新支持。直接将值分配给 JSON 列无法进行部分更新；在这样的更新之后，JSON_STORAGE_SIZE() 始终显示用于新设置值的存储空间

mysql> UPDATE jtable
mysql>     SET jcol = '{"a": 4.55, "b": "wxyz", "c": "[true, false]"}';
Query OK, 1 row affected (0.04 sec)
Rows matched: 1  Changed: 1  Warnings: 0

mysql> SELECT
    ->     jcol,
    ->     JSON_STORAGE_SIZE(jcol) AS Size,
    ->     JSON_STORAGE_FREE(jcol) AS Free
    -> FROM jtable;
+------------------------------------------------+------+------+
| jcol                                           | Size | Free |
+------------------------------------------------+------+------+
| {"a": 4.55, "b": "wxyz", "c": "[true, false]"} |   56 |    0 |
+------------------------------------------------+------+------+
1 row in set (0.00 sec)

JSON 用户变量无法进行部分更新。这意味着此函数始终显示当前用于在用户变量中存储 JSON 文档的空间

mysql> SET @j = '[100, "sakila", [1, 3, 5], 425.05]';
Query OK, 0 rows affected (0.00 sec)

mysql> SELECT @j, JSON_STORAGE_SIZE(@j) AS Size;
+------------------------------------+------+
| @j                                 | Size |
+------------------------------------+------+
| [100, "sakila", [1, 3, 5], 425.05] |   45 |
+------------------------------------+------+
1 row in set (0.00 sec)

mysql> SET @j = JSON_SET(@j, '$[1]', "json");
Query OK, 0 rows affected (0.00 sec)

mysql> SELECT @j, JSON_STORAGE_SIZE(@j) AS Size;
+----------------------------------+------+
| @j                               | Size |
+----------------------------------+------+
| [100, "json", [1, 3, 5], 425.05] |   43 |
+----------------------------------+------+
1 row in set (0.00 sec)

mysql> SET @j = JSON_SET(@j, '$[2][0]', JSON_ARRAY(10, 20, 30));
Query OK, 0 rows affected (0.00 sec)

mysql> SELECT @j, JSON_STORAGE_SIZE(@j) AS Size;
+---------------------------------------------+------+
| @j                                          | Size |
+---------------------------------------------+------+
| [100, "json", [[10, 20, 30], 3, 5], 425.05] |   56 |
+---------------------------------------------+------+
1 row in set (0.00 sec)

对于 JSON 字面量，此函数始终返回当前使用的存储空间

mysql> SELECT
    ->     JSON_STORAGE_SIZE('[100, "sakila", [1, 3, 5], 425.05]') AS A,
    ->     JSON_STORAGE_SIZE('{"a": 1000, "b": "a", "c": "[1, 3, 5, 7]"}') AS B,
    ->     JSON_STORAGE_SIZE('{"a": 1000, "b": "wxyz", "c": "[1, 3, 5, 7]"}') AS C,
    ->     JSON_STORAGE_SIZE('[100, "json", [[10, 20, 30], 3, 5], 425.05]') AS D;
+----+----+----+----+
| A  | B  | C  | D  |
+----+----+----+----+
| 45 | 44 | 47 | 56 |
+----+----+----+----+
1 row in set (0.00 sec)