MySQL JSON_REMOVE() 函数使用指南

MySQL JSON_REMOVE() 函数从一个 JSON 文档中删除由路径指定的数据并返回修改后的 JSON 文档。

JSON_REMOVE() 语法

这里是 MySQL JSON_REMOVE() 的语法:

JSON_REMOVE(json, path[, path] ...)

参数

json
必需的。一个 JSON 文档。
path
必需的。一个有效的路径表达式,它不能包含 ***

返回值

JSON_REMOVE() 函数从一个 JSON 文档中删除由路径指定的数据并返回修改后的 JSON 文档。

您可以通过参数提供多个路径表达式以供删除。多个路径参数会从左到右依次被执行。当执行下一个参数的时候,JSON 文档可能已经发生了变化。

如果 JSON 中不存在指定的路径,此函数返回原文档。

如果 JSON 文档或者路径为 NULL,此函数将返回 NULL

JSON_REMOVE() 函数将在以下情况下返回错误:

  • 如果参数 json 不是有效的 JSON 文档,MySQL 将会给出错误。您可以使用 JSON_VALID() 验证 JSON 文档的有效性。
  • 如果参数 path 不是有效的路径表达式或者等于 $ 或者其中包含 ***, MySQL 将会给出错误。

JSON_REMOVE() 示例

从数组中删除

下面语句使用 JSON_REMOVE() 从一个 JSON 数组中删除索引为 03 的元素。

SELECT JSON_REMOVE('[0, 1, 2, [3, 4]]', '$[0]', '$[2]');
+--------------------------------------------------+
| JSON_REMOVE('[0, 1, 2, [3, 4]]', '$[0]', '$[2]') |
+--------------------------------------------------+
| [1, 2]                                           |
+--------------------------------------------------+

这里,您可能会感到迷惑,为什么使用 $[2] 来删除索引位置 3 的数据?这是因为当存在多个路径的时候,JSON_REMOVE() 从左到右依次执行,步骤如下:

  1. 首先,执行 JSON_REMOVE('[0, 1, 2, [3, 4]]', '$[0]'),返回了 JSON 文档 [1, 2, [3, 4]]
  2. 然后,执行 JSON_REMOVE('[1, 2, [3, 4]]', '$[2]'),返回了 JSON 文档 [1, 2]

从对象中删除

下面语句使用 JSON_REMOVE() 从一个 JSON 对象中删除一个成员。

SELECT JSON_REMOVE('{"x": 1, "y": 2}', '$.x');
+----------------------------------------+
| JSON_REMOVE('{"x": 1, "y": 2}', '$.x') |
+----------------------------------------+
| {"y": 2}                               |
+----------------------------------------+