JSON_OBJECTAGG (Transact-SQL)

Van toepassing op: SQL Server 2025 (17.x) Preview AzureSQL Database Azure SQL Managed InstanceSQL-databasein Microsoft Fabric Preview

Met JSON_OBJECTAGG de syntaxis wordt een JSON-object samengesteld op basis van een aggregatie van SQL-gegevens of -kolommen. JSON_OBJECTAGG kan ook worden gebruikt in een SELECT instructie met component GROUP BY GROUPING SETS .

De sleutel/waardeparen kunnen worden opgegeven als invoerwaarden, kolommen, variabele verwijzingen.

Beide statistische json-functiesJSON_OBJECTAGG en JSON_ARRAYAGG zijn:

• algemeen beschikbaar voor Azure SQL Database, Azure SQL Managed Instance (met sql Server 2025 of Always-up-to-dateupdate policy**), SQL-database in Microsoft Fabric en Fabric Data Warehouse.

• in preview voor SQL Server 2025 (17.x) Preview.

Transact-SQL syntaxisconventies

Syntax

JSON_OBJECTAGG ( json_key_value [ json_null_clause ] [ RETURNING json ] )

json_key_value ::= <json_name> : <value_expression>

json_null_clause ::= NULL ON NULL | ABSENT ON NULL

Arguments

json_key_value

Het sleutel-/waardepaar van het JSON-object.

json_null_clause

Optional. Hiermee wordt de hele eigenschap van een object weggelaten als de waarde is NULLof JSON null als eigenschapswaarde gebruiken. Als u dit weglaat, is NULL ON NULL standaard.

Retourwaarde

Retourneert een geldige JSON-objecttekenreeks van het type nvarchar(max ). Als de RETURNING json optie is opgenomen, wordt het JSON-object geretourneerd als json-type .

Examples

A. JSON-object retourneren met één sleutel

In het volgende voorbeeld wordt een JSON-object met één sleutel en null-waarde geretourneerd.

SELECT JSON_OBJECTAGG('key':NULL);

Hier is het resultatenoverzicht.

{"key":null}

B. JSON-object maken uit resultatenset

In het volgende voorbeeld wordt een JSON-object samengesteld met drie eigenschappen uit een resultatenset.

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

Hier is het resultatenoverzicht.

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

C. Resultaat retourneren met twee kolommen

In het volgende voorbeeld wordt een resultaat met twee kolommen geretourneerd. De eerste kolom bevat de object_id-waarde. De tweede kolom bevat een JSON-object waarin de sleutel de kolomnaam en -waarde is de 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;

D. Een JSON-object retourneren als JSON-type

In het volgende voorbeeld wordt een JSON-object geretourneerd als json-type .

SELECT JSON_OBJECTAGG('a':1 RETURNING JSON);

resultaat

{"a":1}

Hier is het resultatenoverzicht.

E. Geaggregeerd resultaat retourneren met vier kolommen

In het volgende voorbeeld wordt een resultaat geretourneerd met vier kolommen uit een SELECT instructie met SUM en JSON_OBJECTAGG aggregaties met GROUP BY GROUPING SETS. De eerste twee kolommen retourneren de id en type kolomwaarde. De derde kolom total_amount retourneert de waarde van SUM aggregaties in de amount kolom. De vierde kolom json_total_name_amount retourneert de waarde van JSON_OBJECTAGG aggregaties op de name en amount kolommen.

WITH T
AS (SELECT *
    FROM (
        VALUES (1, 'k1', 'a', 2), (1, 'k2', 'b', 3), (1, 'k3', 'b', 4), (2, 'j1', 'd', 7), (2, 'j2', 'd', 9)
    ) AS b(id, name, type, amount))
SELECT id,
       type,
       SUM(amount) AS total_amount,
       JSON_OBJECTAGG(name:amount) AS json_total_name_amount
FROM T
GROUP BY GROUPING SETS((id), (type), (id, type), ());

Hier is het resultatenoverzicht.

Verwante inhoud

• JSON-padexpressies in de SQL Database Engine
• JSON-gegevens in SQL Server
• JSON_ARRAYAGG (Transact-SQL)