SQL Server 中 `JSON_MODIFY` 的使用

Intro

SQL Server 从 2016 开始支持了一些 JSON操作，最近的项目里也是好多地方字段直接存成了 JSON，需要了解一下怎么在SQL Server 中操作 JSON.

JSON支持适用于 SQL Server 2016 及以上版本 和 Azure SQL Database。

最近在项目中很多地方字段都是存一个 JSON 字符串，尤其是针对一些有很多不确定的属性的数据来说，这样的信息我们一般都放在一个 Extra 之类的字段保存一个 JSON 字符串，由于不确定性很大，很有可能会遇到要修改这个 JSON 字符串结构的问题，在修改 JSON 对象的某一个值和修改 JSON 的结构时都会用到 JSON_MODIFY，今天就来介绍一下 JSON_MODIFY 的使用

示例

直接来看示例：

-- JSON_MODIFY 测试
DECLARE @testJsonValue NVARCHAR(100) = N'{"name":"John","skills":["C#","SQL"]}';
PRINT @testJsonValue;

-- 适用 append 在数组中追加元素
PRINT JSON_MODIFY(@testJsonValue, 'append $.skills', 'Azure');

-- 无效用法，这样会把属性更新为字符串
PRINT JSON_MODIFY(@testJsonValue, '$.skills', '["C#","T-SQL","Azure"]');

-- 修改数组
PRINT JSON_MODIFY(@testJsonValue, '$.skills', JSON_QUERY('["C#","T-SQL","Azure"]'));
-- 修改数组某个元素
PRINT JSON_MODIFY(@testJsonValue, '$.skills[0]', 'CSharp');


-- 增加属嵌套
PRINT JSON_MODIFY(@testJsonValue, '$.Likes', JSON_QUERY('{"Girl": "Alice"}'));
PRINT JSON_MODIFY(@testJsonValue, '$.Likes', JSON_QUERY('{"Animals": ["Dog","Cat"]}'));

-- 增加 bool 属性
PRINT JSON_MODIFY(@testJsonValue, '$.ShowAwardsAfterQuizEnds', CONVERT(BIT, 'false'));
PRINT JSON_MODIFY(@testJsonValue, '$.ShowAwardsAfterQuizEnds', CONVERT(BIT, 1));

-- 增加 int 属性
PRINT JSON_MODIFY(@testJsonValue, '$.TotalWinnersCount', CONVERT(INT, '20'));
PRINT JSON_MODIFY(@testJsonValue, '$.TotalWinnersCount', 20);

-- 删除属性
PRINT JSON_MODIFY(@testJsonValue, '$.name', NULL);

输出结果如下图：

More

注意：

• 如果要更新的字段没有是一个 JSON 对象或是一个数组，那么需要使用 JSON_QUERY ，否则更新的对应的属性就成了字符串了。

• 如果是要删除某一个属性，把某一个属性更新为 NULL 即可

• 如果要增加一个 bool 类型的属性，需要把对应的值转换为 BIT 类型

Reference

• https://docs.microsoft.com/en-us/sql/t-sql/functions/json-modify-transact-sql?view=sql-server-ver15
• https://docs.microsoft.com/en-us/sql/relational-databases/json/json-path-expressions-sql-server?view=sql-server-ver15