sys.dm_exec_describe_first_result_set_for_object (Transact-SQL)

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

Cette fonction de gestion dynamique prend un @object_id paramètre et décrit les premières métadonnées de résultat du module avec cet ID. L’ID @object_id spécifié peut être l’ID d’une procédure stockée Transact-SQL ou d’un déclencheur Transact-SQL. S'il s'agit de l'ID de tout autre objet (tel qu'une vue, une table, une fonction ou une procédure CLR), une erreur sera spécifiée dans les colonnes d'erreur du résultat.

sys.dm_exec_describe_first_result_set_for_object a la même définition de jeu de résultats que sys.dm_exec_describe_first_result_set (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_for_object   
    ( @object_id , @include_browse_information )  

Arguments

@object_id
D’une @object_id procédure stockée Transact-SQL ou d’un déclencheur Transact-SQL. @object_id est de type int.

@include_browse_information
@include_browse_informationest un bit de type. 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. Retourne des colonnes clés supplémentaires et des informations de table source.

Table retournée

Ces métadonnées communes sont retournées en tant que jeu de résultats avec une ligne pour chaque colonne dans les métadonnées de résultats. Chaque ligne décrit le type et la possibilité de valeur NULL de la colonne dans le format décrit dans la section suivante. 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

Nécessite l’autorisation d’exécuter l’argument @tsql .

Exemples

R. Retour de métadonnées avec et sans informations de navigation

L’exemple suivant crée une procédure stockée nommée TestProc2 qui retourne deux jeux de résultats. L’exemple montre ensuite que sys.dm_exec_describe_first_result_set retourne des informations sur le premier jeu de résultats de la procédure, avec et sans les informations de navigation.

CREATE PROC TestProc2  
AS  
SELECT object_id, name FROM sys.objects ;  
SELECT name, schema_id, create_date FROM sys.objects ;  
GO  
  
SELECT * FROM sys.dm_exec_describe_first_result_set_for_object(OBJECT_ID('TestProc2'), 0) ;  
SELECT * FROM sys.dm_exec_describe_first_result_set_for_object(OBJECT_ID('TestProc2'), 1) ;  
GO  

B. Combinaison de la fonction sys.dm_exec_describe_first_result_set_for_object avec une table ou une vue

L’exemple suivant utilise à la fois l’affichage catalogue système sys.procedures et la fonction sys.dm_exec_describe_first_result_set_for_object pour afficher les métadonnées pour les jeux de résultats de toutes les procédures stockées dans la AdventureWorks2022 base de données.

USE AdventureWorks2022;  
GO  
  
SELECT p.name, r.*   
FROM sys.procedures AS p  
CROSS APPLY sys.dm_exec_describe_first_result_set_for_object(p.object_id, 0) AS r;  
GO  
  

Voir aussi

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