JSON_OBJECTAGG (Transact-SQL)

适用于:Azure SQL 数据库

通过聚合 SQL 数据或列来构造 JSON 对象。

键值对可以被指定为输入值、列、变量引用。

若要改为通过聚合来创建 JSON 数组,请使用 JSON_ARRAYAGG

注意

目前,json 聚合函数 JSON_OBJECTAGGJSON_ARRAYAGG 的预览版都可用于 Azure SQL 数据库。

Transact-SQL 语法约定

语法

JSON_OBJECTAGG ( json_key_value [ json_null_clause ] )
 
json_key_value ::= <json_name> : <value_expression> 

json_null_clause ::= NULL ON NULL | ABSENT ON NULL 

参数

json_key_value

JSON 对象的键值对。

json_null_clause

可选。 如果值为 NULL,则省略对象的整个属性,或使用 JSON null 作为属性值。 如果省略,则 NULL ON NULL 为默认值。

示例

示例 1

以下示例返回包含一个键和 null 值的 JSON 对象。

select JSON_OBJECTAGG ( 'key':null )

Result

{"key":null}

示例 2

以下示例使用结果集中的三个属性来构造 JSON 对象。

SELECT JSON_OBJECTAGG( c1:c2 )
FROM (
    VALUES('key1', 'c'), ('key2', 'b'), ('key3','a')
) AS t(c1, c2);

Result

{"key1":"c","key2":"b","key3":"a"}

示例 3

以下示例返回包含两列的结果。 第一列包含 object_id 值。 第二列包含一个 JSON 对象,其中键为列名,值为 column_id

SELECT TOP(5) c.object_id, JSON_OBJECTAGG(c.name:c.column_id) AS columns
  FROM sys.columns AS c
 GROUP BY c.object_id;

Result

object_id column_list
3 {"bitpos":12,"cid":6,"colguid":13,"hbcolid":3,"maxinrowlen":8,"nullbit":11,"offset":10,"ordkey":7,"ordlock":14,"rcmodified":4,"rscolid":2,"rsid":1,"status":9,"ti":5}
5 {"cmprlevel":9,"fgidfs":7,"fillfact":10,"idmajor":3,"idminor":4,"lockres":17,"maxint":13,"maxleaf":12,"maxnullbit":11,"minint":15,"minleaf":14,"numpart":5,"ownertype":2,"rcrows":8,"rowsetid":1,"rsguid":16,"scope_id":18,"status":6}
6 {"cloneid":6,"dbfragid":8,"id":1,"partid":3,"rowsetid":7,"segid":5,"status":9,"subid":2,"version":4}
7 {"auid":1,"fgid":5,"ownerid":3,"pcdata":10,"pcreserved":11,"pcused":9,"pgfirst":6,"pgfirstiam":8,"pgroot":7,"status":4,"type":2}
8 {"fileid":2,"filename":4,"name":3,"status":1}