STRING_AGG (Transact-SQL)

S’applique à : SQL Server 2017 (14.x) et versions ultérieures Azure SQL DatabaseAzure SQL Managed InstanceAzure Synapse AnalyticsPoint de terminaison analytique SQL dans Microsoft FabricEntrepôt dans Microsoft Fabric

Concatène les valeurs des expressions de chaîne et place les valeurs de séparateur entre elles. Le séparateur n’est pas ajouté à la fin de la chaîne.

Conventions de la syntaxe Transact-SQL

Syntaxe

STRING_AGG ( expression, separator ) [ <order_clause> ]

<order_clause> ::=   
    WITHIN GROUP ( ORDER BY <order_by_expression_list> [ ASC | DESC ] )   

Remarque

Pour afficher la syntaxe Transact-SQL pour SQL Server 2014 (12.x) et versions antérieures, consultez la Documentation sur les versions antérieures.

Arguments

expression
Expression de tout type. Les expressions sont converties en types NVARCHAR ou VARCHAR durant la concaténation. Les types autres que chaîne sont convertis en type NVARCHAR.

separator
Expression de type NVARCHAR ou VARCHAR qui est utilisée comme séparateur pour les chaînes concaténées. Ce peut être un littéral ou une variable.

<order_clause>
Spécifiez éventuellement l’ordre des résultats concaténés à l’aide de la clause WITHIN GROUP :

WITHIN GROUP ( ORDER BY <order_by_expression_list> [ ASC | DESC ] )

<order_by_expression_list>

Liste d’expressions non constantes qui peuvent être utilisées pour le tri des résultats. Un seul order_by_expression est autorisé par requête. L’ordre de tri par défaut est croissant.

Types de retour

Le type de retour dépend du premier argument (expression). Si l’argument d’entrée est de type chaîne (NVARCHAR, VARCHAR), le type de résultat sera identique au type d’entrée. Le tableau suivant répertorie les conversions automatiques :

Type d’expression d’entrée Résultats
NVARCHAR(MAX) NVARCHAR(MAX)
VARCHAR(MAX) VARCHAR(MAX)
NVARCHAR(1...4000) NVARCHAR(4000)
VARCHAR(1...8000) VARCHAR(8000)
int, bigint, smallint, tinyint, numeric, float, real, bit, decimal, smallmoney, money, datetime, datetime2, NVARCHAR(4000)

Remarques

STRING_AGG est une fonction d’agrégation qui accepte toutes les expressions à partir des lignes et les concatène en une seule chaîne. Les valeurs d’expression sont implicitement converties en types chaîne, puis concaténées. La conversion implicite en chaînes respecte les règles existantes de conversion de type de données. Pour plus d’informations sur les conversions de type de données, consultez CAST et CONVERT (Transact-SQL).

Si l’expression d’entrée est de type VARCHAR, le séparateur ne peut pas être de type NVARCHAR.

Les valeurs NULL sont ignorées et le séparateur correspondant n’est pas ajouté. Pour renvoyer un espace réservé pour les valeurs NULL, utilisez la fonction ISNULL comme illustré dans l’exemple B.

STRING_AGG est disponible dans n’importe quel niveau de compatibilité.

Notes

<order_clause> est disponible avec le niveau de compatibilité de la base de données 110 et plus.

Exemples

La plupart des exemples de cet article font référence aux exemples de bases de données AdventureWorks.

R. Générer une liste de noms séparés sur plusieurs lignes

L’exemple suivant génère une liste de noms dans une cellule de résultat unique, séparés par des retours chariot.

USE AdventureWorks2022;
GO
SELECT STRING_AGG (CONVERT(NVARCHAR(max),FirstName), CHAR(13)) AS csv 
FROM Person.Person;
GO

Voici le jeu de résultats obtenu.

csv
Syed
Catherine
Kim
Kim
Kim
Hazem
...

Les valeurs NULL trouvées dans les cellules name ne sont pas renvoyées dans le résultat.

Notes

Si vous utilisez l’éditeur de requête SQL Server Management Studio, l’option Résultats dans des grilles ne peut pas implémenter le retour chariot. Basculez vers Results to Text pour afficher correctement le jeu de résultats.
Les résultats dans du texte sont tronqués à 256 caractères par défaut. Pour augmenter cette limite, modifiez l’option Nombre maximal de caractères affichés dans chaque colonne.

B. Générer une liste de noms séparés par des virgules sans valeurs NULL

L’exemple suivant remplace les valeurs NULL par « N/A » et renvoie les noms séparés par des virgules dans une cellule de résultat unique.

USE AdventureWorks2022;
GO
SELECT STRING_AGG(CONVERT(NVARCHAR(max), ISNULL(FirstName,'N/A')), ',') AS csv 
FROM Person.Person;
GO

Voici le jeu de résultats obtenu.

Notes

Les résultats sont affichés tronqués.

csv
Syed,Catherine,Kim,Kim,Kim,Hazem,Sam,Humberto,Gustavo,Pilar,Pilar, ...

C. Générer des valeurs séparées par des virgules

USE AdventureWorks2022;
GO
SELECT STRING_AGG(CONVERT(NVARCHAR(max), CONCAT(FirstName, ' ', LastName, '(', ModifiedDate, ')')), CHAR(13)) AS names 
FROM Person.Person;
GO

Voici le jeu de résultats obtenu.

Notes

Les résultats sont affichés tronqués.

noms
Ken Sánchez (8 février 2003 12 h 00)
Terri Duffy (24 février 2002 12 h 00)
Roberto Tamburello (5 décembre 2001 12 h 00)
Rob Walters (29 décembre 2001 12 h 00)
...

Notes

Si vous utilisez l’éditeur de requête de Management Studio, l’option Results to Grid ne peut pas implémenter le retour chariot. Basculez vers Results to Text pour afficher correctement le jeu de résultats.

Imaginez une base de données dans laquelle les articles et leurs balises sont séparés en différentes tables. Un développeur souhaite renvoyer une ligne pour chaque article avec toutes les balises associées. La requête suivante permet d’obtenir ce résultat :

SELECT a.articleId, title, STRING_AGG (tag, ',') as tags
FROM dbo.Article AS a
LEFT JOIN dbo.ArticleTag AS t
    ON a.ArticleId = t.ArticleId
GROUP BY a.articleId, title;
GO

Voici le jeu de résultats obtenu.

articleId title tags
172 Les sondages prévoient des résultats serrés aux élections politique,sondages,conseil municipal
176 La nouvelle autoroute devrait réduire les embouteillages NULL
177 Les chiens restent plus populaires que les chats sondages,animaux

Notes

La clause GROUP BY est obligatoire si la fonction STRING_AGG n’est pas le seul élément de la liste SELECT.

E. Générer une liste d’adresses e-mail par ville

La requête suivante recherche les adresses e-mail des employés et les regroupe par ville :

USE AdventureWorks2022;
GO

SELECT TOP 10 City, STRING_AGG(CONVERT(NVARCHAR(max), EmailAddress), ';') AS emails 
FROM Person.BusinessEntityAddress AS BEA  
INNER JOIN Person.Address AS A ON BEA.AddressID = A.AddressID
INNER JOIN Person.EmailAddress AS EA ON BEA.BusinessEntityID = EA.BusinessEntityID 
GROUP BY City;
GO

Voici le jeu de résultats obtenu.

Notes

Les résultats sont affichés tronqués.

City emails
Ballard paige28@adventure-works.com ;joshua24@adventure-works.com ;javier12@adventure-works.com ;...
Baltimore gilbert9@adventure-works.com
Barstow kristen4@adventure-works.com
Basingstoke Hants dale10@adventure-works.com ;heidi9@adventure-works.com
Baytown kelvin15@adventure-works.com
Beaverton billy6@adventure-works.com ;dalton35@adventure-works.com ;lawrence1@adventure-works.com ;...
Bell Gardens christy8@adventure-works.com
Bellevue min0@adventure-works.com ;gigi0@adventure-works.com ;terry18@adventure-works.com ;...
Bellflower philip0@adventure-works.com ;emma34@adventure-works.com ;jorge8@adventure-works.com ;...
Bellingham christopher23@adventure-works.com ;frederick7@adventure-works.com ;omar0@adventure-works.com ;...

Les adresses e-mail renvoyées dans la colonne emails peuvent être utilisées directement pour envoyer des e-mails à un groupe de personnes travaillant dans certaines villes particulières.

F. Générer une liste ordonnée d’adresses e-mail par ville

Similaire à l’exemple précédent, la requête suivante recherche les adresses e-mail des employés, les regroupe par ville, puis les trie par ordre alphabétique :

USE AdventureWorks2022;
GO

SELECT TOP 10 City, STRING_AGG(CONVERT(NVARCHAR(max), EmailAddress), ';') WITHIN GROUP (ORDER BY EmailAddress ASC) AS Emails 
FROM Person.BusinessEntityAddress AS BEA  
INNER JOIN Person.Address AS A ON BEA.AddressID = A.AddressID
INNER JOIN Person.EmailAddress AS EA ON BEA.BusinessEntityID = EA.BusinessEntityID 
GROUP BY City;
GO

Voici le jeu de résultats obtenu.

Notes

Les résultats sont affichés tronqués.

City E-mails
Barstow kristen4@adventure-works.com
Basingstoke Hants dale10@adventure-works.com ;heidi9@adventure-works.com
Braintree mindy20@adventure-works.com
Bell Gardens christy8@adventure-works.com
Byron louis37@adventure-works.com
Bordeaux ranjit0@adventure-works.com
Carnation don0@adventure-works.com ;douglas0@adventure-works.com ;george0@adventure-works.com ;...
Boulogne-Billancourt allen12@adventure-works.com ;bethany15@adventure-works.com ;carl5@adventure-works.com ;...
Berkshire barbara41@adventure-works.com ;brenda4@adventure-works.com ;carrie14@adventure-works.com ;...
Berks adriana6@adventure-works.com ;alisha13@adventure-works.com ;arthur19@adventure-works.com ;...

Étapes suivantes

En savoir plus sur les fonctions Transact-SQL dans les articles suivants :