sys.dm_exec_describe_first_result_set (Transact-SQL)

S’applique à : SQL ServerAzure SQL Database Azure SQL Managed Instance

Cette fonction de gestion dynamique prend une instruction Transact-SQL en tant que paramètre et décrit les métadonnées du premier jeu de résultats pour l’instruction.

sys.dm_exec_describe_first_result_set a la même définition de jeu de résultats que sys.dm_exec_describe_first_result_set_for_object (Transact-SQL) et est similaire à sp_describe_first_result_set (Transact-SQL).

Conventions de la syntaxe Transact-SQL

Syntaxe

  
sys.dm_exec_describe_first_result_set(@tsql, @params, @include_browse_information)  

Arguments

@tsql
Une ou plusieurs instructions Transact-SQL. Transact-SQL_batch peut être de type nvarchar(n) ou nvarchar(max).

@params
@params fournit une chaîne de déclaration pour les paramètres du lot Transact-SQL, comme sp_executesql. Les paramètres peuvent être de type nvarchar(n) ou nvarchar(max).

Chaîne contenant les définitions de tous les paramètres qui ont été incorporés dans Transact-SQL_batch. Cette chaîne doit être une constante Unicode ou une variable Unicode. Chaque définition de paramètre se compose d'un nom de paramètre et d'un type de données. n correspond à un espace réservé pour d’autres définitions de paramètres. Chaque paramètre spécifié dans stmt doit être défini dans @params. Si l'instruction Transact-SQL ou le lot dans l'instruction ne contient aucun paramètre, il est inutile d'utiliser @params. La valeur par défaut de ce paramètre est NULL.

@include_browse_information
Lorsque la valeur 1 est définie, chaque requête est analysée comme si elle comportait une option FOR BROWSE sur la requête. Des colonnes clés supplémentaires et les informations de table source sont retournées.

Table retournée

Ces métadonnées communes sont retournées en tant que jeu de résultats. Une ligne pour chaque colonne dans les métadonnées de résultats décrit le type et la possibilité de valeur NULL de la colonne dans le format indiqué dans le tableau suivant. S'il n'existe pas de première instruction pour chaque chemin d'accès de contrôle, un jeu de résultats avec des lignes nulles est retourné.

Notes

Cette fonction utilise le même algorithme que sp_describe_first_result_set. Pour plus d’informations, consultez sp_describe_first_result_set (Transact-SQL).

Le tableau suivant répertorie les types d'erreur et leur description.

autorisations

Requiert l'autorisation d'exécuter l'argument @tsql.

Exemples

Des exemples supplémentaires dans la rubrique sp_describe_first_result_set (Transact-SQL) peuvent être adaptés pour utiliser sys.dm_exec_describe_first_result_set.

A. Retour d'informations sur une instruction Transact-SQL unique

Le code suivant retourne des informations sur les résultats d’une instruction Transact-SQL.

USE AdventureWorks2022;  
GO  
SELECT * FROM sys.dm_exec_describe_first_result_set  
(N'SELECT object_id, name, type_desc FROM sys.indexes', null, 0) ;  

B. Retour d'informations sur une procédure

L’exemple suivant crée une procédure stockée nommée pr_TestProc qui retourne deux jeux de résultats. Ensuite, l’exemple montre que sys.dm_exec_describe_first_result_set retourne des informations sur le premier jeu de résultats dans la procédure.

USE AdventureWorks2022;  
GO  
  
CREATE PROC Production.TestProc  
AS  
SELECT Name, ProductID, Color FROM Production.Product ;  
SELECT Name, SafetyStockLevel, SellStartDate FROM Production.Product ;  
GO  
  
SELECT * FROM sys.dm_exec_describe_first_result_set  
('Production.TestProc', NULL, 0) ;  

C. Retour de métadonnées à partir d'un lot qui contient plusieurs instructions

L’exemple suivant évalue un lot qui contient deux instructions Transact-SQL. Le jeu de résultats décrit le premier jeu de résultats retourné.

USE AdventureWorks2022;  
GO  
  
SELECT * FROM sys.dm_exec_describe_first_result_set(  
N'SELECT CustomerID, TerritoryID, AccountNumber FROM Sales.Customer WHERE CustomerID = @CustomerID;  
SELECT * FROM Sales.SalesOrderHeader;',  
N'@CustomerID int', 0) AS a;  
GO  

Voir aussi

sp_describe_first_result_set (Transact-SQL)
sp_describe_undeclared_parameters (Transact-SQL)
sys.dm_exec_describe_first_result_set_for_object (Transact-SQL)