人大金仓数据库KingbaseES 中JSON_SEARCH函数的使用介绍

金仓数据库KingbaseES

《KES V9中JSON_SEARCH函数使用介绍》

关键字：

KES、JSON_SEARCH函数、JSON数据类型、人大金仓

1. JSON_SEARCH函数简介

在KES中，扩展时一种机制，用于增加和扩展数据库的功能。通过扩展，可以向KES添加新的数据类型、函数、操作符、索引类型和语法等，以满足特定的需求。

mysql_json时KES的Mysql模式下一个扩展包，用于支持常用的Mysql的JSON函数，JSON_SEARCH函数就是其中之一，其主要功能在JSON数据中搜索指定值的函数。它返回匹配的JSON路径，以便定位所需的值。JSON_REMOVE函数的语法如下：

JSON_SEARCH(json_doc,one_or_all,search_str[,escape_char[,path_mode]])

参数说明：

json_doc：要搜索的JSON文档。

one_or_all：指定搜索模式，可以是“one”或者“all”，如果设置为“one”，则返回第一个匹配的路径；如果设置为“all”，则返回所有匹配的路径。

search_str：要搜索的值。

escape_char（可选）：用于转义特殊字符的转义字符，默认为反斜杠（\）。

path_mode（可选）：指定返回的路径格式，可以是“lax”或者“strict”，如果设置为“lax”，则返回简化的路径；如果设置为“strict”，则返回完整的路径。

返回值：

如果可以找到匹配的值，则返回对应的JSON路径；如果未找到匹配的值，则返回NULL。

1. JSON_SEARCH函数实际应用

JSON_SEARCH函数在KES中主要用于在JSON数据中搜索特定的值，并返回匹配值的路径。这允许处理包含复杂结构的JSON数据时非常有用，因为它可以帮助我们定位到数据的具体位置。

以下是一个实际应用的例子：假设我们有一个名为users的表，其中一个名为profile的JSON列，存储了用户的个人信息，如下所示：

{ “name”: “John Doe”, “email”: “john.doe@example.com”, “address”: { “street”: “123 Main St”, “city”: “New York”, “country”:”USA” }, “hobbies”: [“reading, “music”, “sports”] }

现在我们想要找出所有喜欢阅读（“reading”）的用户，我们可以使用JSON_SEARCH函数来实现这个需求，示例如下：

SEELCT * FROM users WHERE JSON_SERACH(profile,’one’,’reading’) IS NOT NULL;

这个查询会返回所有profile字段中hobbies数组包含“reading”的用户。

另一个例子，假设我们要找出所有在“New York”市居住的用户，我们可以这样做：

SELECT * FROM users WHERE JSON_SEARCH(profile, ‘one’, ‘New York’) IS NOT NULL;

这个查询会返回所有profile字段中address.city值为“New York”的用户。

这些例子展示了JSON_SEARCH函数在处理包含复杂结构的JSON数据的实用性，它可以帮助我们在JSON数据中搜索和定位特定的值。

1. 使用JSON_SEARCH函数的注意事项

在使用KES的JSON_REMOVE函数时，有几个注意事项需要考虑：

一、JSON_SEARCH函数返回的匹配值的路径，而不是匹配值本身，如果想要获得匹配值的本身，可以使用其他的JSON函数，如JSON_EXTRACT。

二、JSON_SERACH函数的第二个参数可以是‘one’或者‘all’，分别表示返回第一个匹配的路径或者返回所有匹配的路径。因此可以根据需求来选择合适的搜索模式。

三、如果JSON_SEARCH函数无法找到匹配的值，或者输入的JSON文档不是一个有效的JSON文档，那么函数将返回NULL。

四、JSON_SEARCH函数只能搜索JSON字符串类型，如果视图搜索一个非字符串值，如数字或者布尔值，函数将无法找到匹配的结果。