STRING_AGG (Transact-SQL)

S’applique à : point de terminaison d’analytique SQL Server 2017 (14.x) et ultérieur Azure SQL Database Azure SQL Managed Instance Azure Synapse Analytics SQL Analytics dans Microsoft Fabric Warehouse

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 ] )   

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 :

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é.

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.

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

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.

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.

D. Retourner des articles d’actualité avec les balises associées

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.

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.

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.

Étapes suivantes

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

• STRING_ESCAPE (Transact-SQL)
• STUFF (Transact-SQL)
• CONCAT (Transact-SQL)
• CONCAT_WS (Transact-SQL)
• Fonctions d'agrégation (Transact-SQL)
• Fonctions de chaîne (Transact-SQL)