Queryresultaten opmaken als JSON met FOR JSON

2025-07-29

Van toepassing op: SQL Server 2016 (13.x) en latere versies Azure SQL Database Azure SQL Managed Instance Azure Synapse Analytics (alleen serverloze SQL-pool)SQL Analytics-eindpunt in Microsoft Fabric Warehouse in Microsoft FabricSQL-database in Microsoft Fabric Preview

Maak queryresultaten op als JSON of exporteer gegevens uit SQL Server als JSON door de FOR JSON component toe te voegen aan een SELECT instructie. Gebruik de component FOR JSON om clienttoepassingen te vereenvoudigen door de opmaak van JSON-uitvoer van de app naar SQL Server te delegeren.

Note

Azure Data Studio- is de aanbevolen query-editor voor JSON-query's omdat deze de JSON-resultaten automatisch opmaakt, zoals wordt weergegeven in dit artikel. SQL Server Management Studio geeft een niet-opgemaakte tekenreeks weer.

In Fabric Data Warehouse moet FOR JSON de laatste operator in de query zijn en is dit dus niet toegestaan binnen subquery's.

Queryresultaten opmaken

Wanneer u de FOR JSON-component gebruikt, kunt u de structuur van de JSON-uitvoer expliciet opgeven of de structuur van de SELECT-instructie de uitvoer laten bepalen.

Gebruik FOR JSON PATHom de volledige controle over de indeling van de JSON-uitvoer te behouden. U kunt wrapperobjecten maken en complexe eigenschappen nesten.
Als u de JSON-uitvoer automatisch wilt opmaken op basis van de structuur van de SELECT-instructie, gebruikt u FOR JSON AUTO.

Hier volgt een voorbeeld van een SELECT-uitspraak met de FOR JSON-clausule en de uitvoer ervan.

diagram waarin wordt getoond hoe FOR JSON werkt.

VOOR JSON-PAD
VOOR JSON AUTO

Uitvoer beheren met FOR JSON PATH

In PATH-modus kunt u de puntsyntaxis - bijvoorbeeld, Item.Price - gebruiken om geneste uitvoer op te maken.

Hier volgt een voorbeeldquery die gebruikmaakt van PATH-modus met de FOR JSON-component. In het volgende voorbeeld wordt ook de optie ROOT gebruikt om een benoemd hoofdelement op te geven.

diagram van stroom van FOR JSON-uitvoer.

Meer informatie over FOR JSON PATH

Zie Geneste JSON-uitvoer opmaken met PATH-modus voor meer gedetailleerde informatie en voorbeelden.

Zie SELECT - FOR-component (Transact-SQL)voor syntaxis en gebruik.

Uitvoer van SELECT-instructiebesturingselementen met FOR JSON AUTO

In AUTO-modus bepaalt de structuur van de SELECT-instructie de indeling van de JSON-uitvoer.

Standaard worden NULL waarden niet opgenomen in de uitvoer. U kunt INCLUDE_NULL_VALUES gebruiken om dit gedrag te wijzigen.

Hier volgt een voorbeeldquery die gebruikmaakt van AUTO-modus met de FOR JSON-component.

SELECT name, surname
FROM emp
FOR JSON AUTO;

En hier is de geretourneerde JSON.

[{
    "name": "John"
}, {
    "name": "Jane",
    "surname": "Doe"
}]

Voorbeeld met JOIN en `NULL`

Het volgende voorbeeld van SELECT...FOR JSON AUTO bevat een weergave van hoe de JSON-resultaten eruitzien wanneer er een 1:veel relatie is tussen gegevens uit gekoppelde tabellen.

Het ontbreken van de null-waarde van de geretourneerde JSON wordt ook geïllustreerd. U kunt dit standaardgedrag echter overschrijven door het trefwoord INCLUDE_NULL_VALUES in de FOR component te gebruiken.

DROP TABLE IF EXISTS #tabStudent;
DROP TABLE IF EXISTS #tabClass;
GO

CREATE TABLE #tabClass (
    ClassGuid UNIQUEIDENTIFIER NOT NULL DEFAULT newid(),
    ClassName NVARCHAR(32) NOT NULL
);

CREATE TABLE #tabStudent (
    StudentGuid UNIQUEIDENTIFIER NOT NULL DEFAULT newid(),
    StudentName NVARCHAR(32) NOT NULL,
    ClassGuid UNIQUEIDENTIFIER NULL -- Foreign key.
);
GO

INSERT INTO #tabClass (ClassGuid, ClassName)
VALUES
    ('DE807673-ECFC-4850-930D-A86F921DE438', 'Algebra Math'),
    ('C55C6819-E744-4797-AC56-FF8A729A7F5C', 'Calculus Math'),
    ('98509D36-A2C8-4A65-A310-E744F5621C83', 'Art Painting');

INSERT INTO #tabStudent (StudentName, ClassGuid)
VALUES
    ('Alice Apple', 'DE807673-ECFC-4850-930D-A86F921DE438'),
    ('Alice Apple', 'C55C6819-E744-4797-AC56-FF8A729A7F5C'),
    ('Betty Boot', 'C55C6819-E744-4797-AC56-FF8A729A7F5C'),
    ('Betty Boot', '98509D36-A2C8-4A65-A310-E744F5621C83'),
    ('Carla Cap', null);
GO

SELECT c.ClassName,
    s.StudentName
FROM #tabClass AS c
RIGHT JOIN #tabStudent AS s ON s.ClassGuid = c.ClassGuid
ORDER BY c.ClassName,
    s.StudentName
FOR JSON AUTO
    -- To include NULL values in the output, uncomment the following line:
    --, INCLUDE_NULL_VALUES
    ;
GO

DROP TABLE IF EXISTS #tabStudent;
DROP TABLE IF EXISTS #tabClass;
GO

Vervolgens is dit de JSON die wordt gegenereerd door de voorgaande SELECT-query.

JSON_F52E2B61-18A1-11d1-B105-00805F49916B

[
   {"s":[{"StudentName":"Carla Cap"}]},
   {"ClassName":"Algebra Math","s":[{"StudentName":"Alice Apple"}]},
   {"ClassName":"Art Painting","s":[{"StudentName":"Betty Boot"}]},
   {"ClassName":"Calculus Math","s":[{"StudentName":"Alice Apple"},{"StudentName":"Betty Boot"}]}
]

Meer informatie over FOR JSON AUTO

Zie JSON-uitvoer automatisch opmaken met de AUTO-modus voor meer gedetailleerde informatie en voorbeelden.

Zie SELECT - FOR-component (Transact-SQL)voor syntaxis en gebruik.

Andere JSON-uitvoeropties beheren

Beheer de uitvoer van de FOR JSON-component met behulp van de volgende extra opties.

ROOT

Als u één element op het hoogste niveau wilt toevoegen aan de JSON-uitvoer, geeft u de optie ROOT op. Als u deze optie niet opgeeft, heeft de JSON-uitvoer geen hoofdelement. Zie Een hoofdknooppunt toevoegen aan JSON-uitvoer met de ROOT-optie voor meer informatie.
INCLUDE_NULL_VALUES

Als u null-waarden wilt opnemen in de JSON-uitvoer, geeft u de optie INCLUDE_NULL_VALUES op. Als u deze optie niet opgeeft, bevat de uitvoer geen JSON-eigenschappen voor NULL waarden in de queryresultaten. Zie Null-waarden opnemen in JSON - INCLUDE_NULL_VALUES Optionvoor meer informatie.
WITHOUT_ARRAY_WRAPPER

Als u de vierkante haken tussen de JSON-uitvoer van de FOR JSON-component standaard wilt verwijderen, geeft u de optie WITHOUT_ARRAY_WRAPPER op. Gebruik deze optie om één JSON-object te genereren als uitvoer van een resultaat met één rij. Als u deze optie niet opgeeft, wordt de JSON-uitvoer opgemaakt als een matrix. Dat wil gezegd, de uitvoer wordt tussen vierkante haken geplaatst. Zie Vierkante haken verwijderen uit JSON - WITHOUT_ARRAY_WRAPPER Optionvoor meer informatie.

Uitvoer van de FOR JSON-clausule

De uitvoer van de FOR JSON clausule heeft de volgende kenmerken:

De resultatenset bevat één kolom.
- Een kleine resultatenset kan één rij bevatten.
- Een grote resultatenset splitst de lange JSON-tekenreeks over meerdere rijen.
  - Sql Server Management Studio (SSMS) voegt standaard de resultaten samen in één rij wanneer de uitvoerinstelling is Resultaten naar Raster. Op de SSMS-statusbalk wordt het werkelijke aantal rijen weergegeven.
  - Voor andere clienttoepassingen is mogelijk code vereist om lange resultaten opnieuw samen te voegen in één geldige JSON-tekenreeks door de inhoud van meerdere rijen samen te voegen. Zie Use FOR JSON-uitvoer in een C#-client-appvoor een voorbeeld van deze code in een C#-toepassing.
De resultaten worden opgemaakt als een matrix van JSON-objecten.
- Het aantal elementen in de JSON-matrix is gelijk aan het aantal rijen in de resultaten van de SELECT-instructie (voordat de FOR JSON-component wordt toegepast).
- Elke rij in de resultaten van de SELECT-instructie (voordat de FOR JSON-component wordt toegepast) wordt een afzonderlijk JSON-object in de matrix.
- Elke kolom in de resultaten van de SELECT-instructie (voordat de FOR JSON-component wordt toegepast) wordt een eigenschap van het JSON-object.
Zowel de namen van kolommen als hun waarden worden geëscaped volgens deze JSON-syntaxis. Zie How FOR JSON escapes voor speciale tekens en besturingstekens voor meer informatie.

Example

Hier volgt een voorbeeld van hoe de FOR JSON-component de JSON-uitvoer opmaakt.

Queryresultaten

A	B	C	D
10	11	12	X
20	21	22	Y
30	31	32	Z

JSON-uitvoer

[{
    "A": 10,
    "B": 11,
    "C": 12,
    "D": "X"
}, {
    "A": 20,
    "B": 21,
    "C": 22,
    "D": "Y"
}, {
    "A": 30,
    "B": 31,
    "C": 32,
    "D": "Z"
}]

Feedback

Is deze pagina nuttig?