sys.dm_exec_describe_first_result_set_for_object (Transact-SQL)

 

CETTE RUBRIQUE S’APPLIQUE À :ouiSQL Server (à partir de la version 2012)ouiAzure SQL DatabasenonAzure SQL Data WarehousenonParallel Data Warehouse

Cette fonction de gestion dynamique accepte un @object_id en tant que paramètre et décrit les premières métadonnées de résultat pour le module avec cet ID. Le @object_id spécifié peut être l’ID d’un Transact-SQL procédure stockée ou un Transact-SQL déclencheur. 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 le même jeu de résultats en tant que définition de sys.dm_exec_describe_first_result_set ( ; Transact-SQL ) ; Il est semblable à sp_describe_first_result_set ( ; Transact-SQL ) ;.

Topic link icon Conventions de la syntaxe Transact-SQL

  
sys.dm_exec_describe_first_result_set_for_object   
    ( @object_id , @include_browse_information )  

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

@include_browse_information
@include_browse_information est de type bits. 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.

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

Nom de colonneType de donnéesDescription
is_hiddenbitsSpécifie si la colonne est une colonne supplémentaire ajoutée à titre d'informations de navigation qui ne s'affiche pas réellement dans le jeu de résultats.
column_ordinalintContient la position ordinale de la colonne dans le jeu de résultats. Position de la première colonne sera spécifiée comme 1.
nomsysnameContient le nom de la colonne si un nom peut être déterminé. Sinon, a la valeur NULL.
is_nullablebitsContient la valeur 1 si la colonne autorise des valeurs NULL, 0 si la colonne n'autorise pas de valeurs NULL et 1 s'il est impossible de déterminer que la colonne autorise des valeurs NULL.
system_type_idintContient le system_type_id du type de données de la colonne comme spécifié dans sys.types. Pour les types CLR, bien que la colonne system_type_name retourne NULL, cette colonne retournera la valeur 240.
system_type_namenvarchar (256)Contient le nom du type de données. Inclut des arguments (tels que la longueur, la précision, l'échelle) spécifiés pour le type de données de la colonne. Si le type de données est un type d'alias défini par l'utilisateur, le type de système sous-jacent est spécifié ici. S'il s'agit d'un type clr défini par l'utilisateur, NULL est retourné dans cette colonne.
max_lengthsmallintLongueur maximale (en octets) de la colonne.

-1 = la colonne type de données est varchar (max), nvarchar (max), varbinary (max), ou xml.

Pour texte colonnes, le max_length valeur à 16 ou à la valeur définie par sp_tableoption 'text in row'.
précisiontinyintPrécision de la colonne si elle est numérique. Dans le cas contraire, retourne la valeur 0.
mise à l’échelletinyintÉchelle de la colonne si elle est numérique. Dans le cas contraire, retourne la valeur 0.
collation_namesysnameNom du classement de la colonne si elle est basée sur les caractères. Sinon, retourne NULL.
user_type_idintPour les types d'alias et CLR, contient l'information user_type_id du type de données de la colonne comme spécifié dans sys.types. Sinon, a la valeur NULL.
user_type_databasesysnamePour les types d'alias et CLR, contient le nom de la base de données dans laquelle le type est défini. Sinon, a la valeur NULL.
user_type_schemasysnamePour les types d'alias et CLR, contient le nom du schéma dans lequel le type est défini. Sinon, a la valeur NULL.
user_type_namesysnamePour les types d'alias et CLR, contient le nom du type. Sinon, a la valeur NULL.
assembly_qualified_type_namenvarchar (4000)Pour les types CLR, retourne le nom de l'assembly et de la classe définissant le type. Sinon, a la valeur NULL.
xml_collection_idintContient l'information xml_collection_id du type de données de la colonne comme spécifié dans sys.columns. Cette colonne retournera NULL si le type retourné n'est pas associé à une collection de schémas XML.
xml_collection_databasesysnameContient la base de données dans laquelle la collection de schémas XML associée à ce type est définie. Cette colonne retournera NULL si le type retourné n'est pas associé à une collection de schémas XML.
xml_collection_schemasysnameContient le schéma dans lequel la collection de schémas XML associée à ce type est définie. Cette colonne retournera NULL si le type retourné n'est pas associé à une collection de schémas XML.
xml_collection_namesysnameContient le nom de la collection de schémas XML associé à ce type. Cette colonne retournera NULL si le type retourné n'est pas associé à une collection de schémas XML.
is_xml_documentbitsRetourne 1 si le type de données retourné est XML et que ce type est garanti être un document XML complet (nœud racine compris), par opposition à un fragment XML. Dans le cas contraire, retourne la valeur 0.
is_case_sensitivebitsRetourne 1 si la colonne est d'un type chaîne sensible à la casse et 0 si ce n'est pas le cas.
is_fixed_length_clr_typebitsRetourne 1 si la colonne est d'un type CLR de longueur fixe et 0 si ce n'est pas le cas.
serveur_sourcesysnameNom du serveur d'origine retourné par la colonne dans ce résultat (s'il provient d'un serveur distant). Le nom est donné tel qu’il apparaît dans sysservers. Retourne NULL si la colonne est initiée sur le serveur local, ou si elle ne peut pas être déterminé quel serveur elle provenance. Est remplie uniquement si les informations de navigation sont demandées.
source_databasesysnameNom de la base de données d'origine retourné par la colonne dans ce résultat. Retourne NULL si la base de données ne peut pas être déterminée. Est remplie uniquement si les informations de navigation sont demandées.
source_schemasysnameNom du schéma d'origine retourné par la colonne dans ce résultat. Retourne NULL si le schéma ne peut pas être déterminé. Est remplie uniquement si les informations de navigation sont demandées.
table_sourcesysnameNom de la table d'origine retourné par la colonne dans ce résultat. Retourne NULL si la table ne peut pas être déterminée. Est remplie uniquement si les informations de navigation sont demandées.
source_columnsysnameNom de la colonne d'origine retourné par la colonne dans ce résultat. Retourne NULL si la colonne ne peut pas être déterminée. Est remplie uniquement si les informations de navigation sont demandées.
is_identity_columnbitsRetourne 1 si la colonne est une colonne d'identité et 0 dans le cas contraire. Retourne NULL s'il est impossible de déterminer que la colonne est une colonne d'identité.
is_part_of_unique_keybitsRetourne 1 si la colonne fait partie d'un index unique (notamment la contrainte unique et primaire) et 0 dans le cas contraire. Retourne NULL s'il est impossible de déterminer que la colonne fait partie d'un index unique. Fourni uniquement si les informations de navigation sont demandées.
is_updateablebitsRetourne 1 si la colonne peut être mise à jour et 0 dans le cas contraire. Retourne NULL s'il est impossible de déterminer que la colonne peut être mise à jour.
is_computed_columnbitsRetourne 1 si la colonne est une colonne calculée et 0 dans le cas contraire. Renvoie la valeur NULL s’il ne peut pas être déterminé que la colonne est une colonne calculée.
is_sparse_column_setbitsRetourne 1 si la colonne est une colonne éparse et 0 dans le cas contraire. Retourne NULL s'il est impossible de déterminer que la colonne fait partie d'un jeu de colonnes éparses.
valeur ordinal_in_order_by_listsmallintPosition de cette colonne dans la liste ORDER BY. Retourne NULL si la colonne ne s'affiche pas dans la liste ORDER BY ou si la liste ORDER BY ne peut pas être déterminée de manière unique.
order_by_list_lengthsmallintLongueur de la liste ORDER BY. Retourne NULL s'il n'existe aucune liste ORDER BY ou si la liste ORDER BY ne peut pas être déterminée de manière unique. Notez que cette valeur sera la même pour toutes les lignes retournées par sp_describe_first_result_set.
order_by_is_descendingsmallint NULLSi la valeur ordinal_in_order_by_list n’est pas NULL, la order_by_is_descending colonne indique la direction de la clause ORDER BY pour cette colonne. Sinon, elle indique NULL.
error_numberintContient le numéro d'erreur retourné par la fonction. Contient NULL si aucune erreur ne s'est produite dans la colonne.
error_severityintContient la gravité retournée par la fonction. Contient NULL si aucune erreur ne s'est produite dans la colonne.
error_stateintContient le message d’état retourné par la fonction. Si aucune erreur ne s'est produite, la colonne contiendra NULL.
error_messagenvarchar(4096)Contient le message retourné par la fonction. Si aucune erreur ne s'est produite, la colonne contiendra NULL.
error_typeintContient un entier qui représente l'erreur retournée. Mappé à error_type_desc. Consultez la liste sous les notes.
error_type_descnvarchar (60)Contient une chaîne majuscule courte qui représente l'erreur retournée. Mappé à error_type. Consultez la liste sous les 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.

error_typeerror_typeDescription
1MISCToutes les erreurs qui ne font pas l'objet d'une description.
2SYNTAXUne erreur de syntaxe s'est produite dans le lot.
3CONFLICTING_RESULTSLe résultat n'a pas pu être déterminé en raison d'un conflit entre deux premières instructions possibles.
4DYNAMIC_SQLLe résultat n'a pas pu être déterminé en raison du SQL dynamique qui pourrait éventuellement retourner le premier résultat.
5CLR_PROCEDURELe résultat n'a pas pu être déterminé parce qu'une procédure stockée clr pourrait éventuellement retourner le premier résultat.
6CLR_TRIGGERLe résultat n'a pas pu être déterminé parce qu'un déclencheur CLR pourrait éventuellement retourner le premier résultat.
7EXTENDED_PROCEDURELe résultat n'a pas pu être déterminé parce qu'une procédure stockée étendue pourrait éventuellement retourner le premier résultat.
8UNDECLARED_PARAMETERLe résultat n'a pas pu être déterminé car le type de données d'une ou plusieurs des colonnes du jeu de résultats dépend potentiellement d'un paramètre non déclaré.
9RECURSIONLe résultat n'a pas pu être déterminé car le lot contient une instruction récursive.
10TEMPORARY_TABLELe résultat n’a pas pu être déterminé car le lot contient une table temporaire n’est pas pris en charge par sp_describe_first_result_set .
11UNSUPPORTED_STATEMENTLe résultat n’a pas pu être déterminé car le lot contient une instruction qui n’est pas pris en charge par sp_describe_first_result_set (par exemple, FETCH, REVERT etc.).
12OBJECT_ID_NOT_SUPPORTEDLe @object_id transmis à la fonction est pas pris en charge (c'est-à-dire, pas une procédure stockée)
13OBJECT_ID_DOES_NOT_EXISTLe @object_id transmis à la fonction est introuvable dans le catalogue système.

Requiert l’autorisation d’exécuter le @tsql argument.

A. 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 renvoie deux jeux de résultats. Puis l’exemple montre que sys.dm_exec_describe_first_result_set renvoie des informations sur le premier jeu de résultats dans 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 la vue de catalogue de système sys.procedures et sys.dm_exec_describe_first_result_set_for_object (fonction) pour afficher les métadonnées pour les jeux de résultats de toutes les procédures stockées dans les AdventureWorks2012 base de données.

USE AdventureWorks2012;  
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  
  

sp_describe_first_result_set ( ; Transact-SQL ) ;
sp_describe_undeclared_parameters ( ; Transact-SQL ) ;
Sys.dm_exec_describe_first_result_set ( ; Transact-SQL ) ;

Ajouts de la communauté

AJOUTER
Afficher: