sys.dm_exec_describe_first_result_set (Transact-SQL)

  • Article

Cette fonction de gestion dynamique accepte 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 semblable à sp_describe_first_result_set (Transact-SQL).

Icône Lien de rubrique Conventions de la syntaxe Transact-SQL

Syntaxe

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

Arguments

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

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

    Chaîne contenant les définitions de tous les paramètres qui ont été incorporés dans le _batch Transact-SQL. 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 le lot ou l'instruction Transact-SQL 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é.

Nom de la colonne

Type de données

Description

is_hidden

bit

Spécifie que la colonne est une colonne supplémentaire ajoutée pour la navigation et à des fins d'informations qui ne s'affiche pas réellement dans le jeu de résultats.

column_ordinal

int

Contient la position ordinale de la colonne dans le jeu de résultats. La position de la première colonne sera spécifiée comme 1.

name

sysname

Contient le nom de la colonne si un nom peut être déterminé. Sinon, la valeur est NULL.

is_nullable

bit

Contient les valeurs suivantes :

  • Valeur 1 si la colonne autorise des valeurs NULL.

  • Valeur 0 si la colonne n'autorise pas de valeurs NULL.

  • Valeur 1 s'il est impossible de déterminer que la colonne autorise des valeurs NULL.

system_type_id

int

Contient 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_name

nvarchar(256)

Contient le nom et les 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.

Si le type de données est un type clr défini par l'utilisateur, NULL est retourné dans cette colonne.

max_length

smallint

Longueur maximale (en octets) de la colonne.

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

Pour les colonnes de text, la valeur max_length sera 16 ou la valeur définie par sp_tableoption 'text in row'.

precision

tinyint

Précision de la colonne si elle est numérique. Dans le cas contraire, retourne la valeur 0.

scale

tinyint

Échelle de la colonne si elle est numérique. Dans le cas contraire, retourne la valeur 0.

collation_name

sysname

Nom du classement de la colonne si elle est basée sur les caractères. Dans le cas contraire, la valeur NULL est retournée.

user_type_id

int

Pour 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, la valeur est NULL.

user_type_database

sysname

Pour les types d'alias et CLR, contient le nom de la base de données dans laquelle le type est défini. Sinon, la valeur est NULL.

user_type_schema

sysname

Pour les types d'alias et CLR, contient le nom du schéma dans lequel le type est défini. Sinon, la valeur est NULL.

user_type_name

sysname

Pour les types d'alias et CLR, contient le nom du type. Sinon, la valeur est NULL.

assembly_qualified_type_name

nvarchar(4000)

Pour les types CLR, retourne le nom de l'assembly et de la classe définissant le type. Sinon, la valeur est NULL.

xml_collection_id

int

Contient l'information xml_collection_id du type de données de la colonne comme spécifié dans sys.columns. Cette colonne retourne NULL si le type retourné n'est pas associé à une collection de schémas XML.

xml_collection_database

sysname

Contient la base de données dans laquelle la collection de schémas XML associée à ce type est définie. Cette colonne retourne NULL si le type retourné n'est pas associé à une collection de schémas XML.

xml_collection_schema

sysname

Contient le schéma dans lequel la collection de schémas XML associée à ce type est définie. Cette colonne retourne NULL si le type retourné n'est pas associé à une collection de schémas XML.

xml_collection_name

sysname

Contient le nom de la collection de schémas XML associé à ce type. Cette colonne retourne NULL si le type retourné n'est pas associé à une collection de schémas XML.

is_xml_document

bit

Retourne 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_sensitive

bit

Retourne 1 si la colonne est d'un type chaîne sensible à la casse. Retourne 0 dans le cas contraire.

is_fixed_length_clr_type

bit

Retourne 1 si la colonne est d'un type CLR de longueur fixe. Retourne 0 dans le cas contraire.

source_server

sysname

Nom du serveur d'origine (s'il provient d'un serveur distant). Le nom est donné tel qu'il s'affiche dans sys.servers. Retourne NULL si la colonne provient du serveur local, ou s'il est impossible de déterminer la provenance du serveur. Fourni uniquement si les informations de navigation sont demandées.

source_database

sysname

Nom 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. Fourni uniquement si les informations de navigation sont demandées.

source_schema

sysname

Nom 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é. Fourni uniquement si les informations de navigation sont demandées.

source_table

sysname

Nom 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. Fourni uniquement si les informations de navigation sont demandées.

source_column

sysname

Nom de la colonne d'origine retourné par la colonne de résultat. Retourne NULL si la colonne ne peut pas être déterminée. Fourni uniquement si les informations de navigation sont demandées.

is_identity_column

bit

Retourne 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_key

bit

Retourne 1 si la colonne fait partie d'un index unique (notamment les contraintes 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_updateable

bit

Retourne 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_column

bit

Retourne 1 si la colonne est une colonne calculée et 0 dans le cas contraire. Retourne NULL s'il est impossible de déterminer que la colonne est une colonne calculée.

is_sparse_column_set

bit

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

ordinal_in_order_by_list

smallint

Position 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_length

smallint

Longueur 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_descending

smallint NULL

Si la valeur ordinal_in_order_by_list n'est pas NULL, la colonne order_by_is_descending indique la direction de la clause ORDER BY pour cette colonne. Sinon, elle indique NULL.

error_number

int

Contient le numéro d'erreur retourné par la fonction. Si aucune erreur ne s'est produite, la colonne contiendra NULL.

error_severity

int

Contient la gravité retournée par la fonction. Si aucune erreur ne s'est produite, la colonne contiendra NULL.

error_state

int

Contient le message d'état. retourné par la fonction. Si aucune erreur ne s'est produite, la colonne contiendra NULL.

error_message

nvarchar(4096)

Contient le message retourné par la fonction. Si aucune erreur ne s'est produite, la colonne contiendra NULL.

error_type

int

Contient un entier qui représente l'erreur retournée. Mappé à error_type_desc. Consultez la liste sous les notes.

error_type_desc

nvarchar(60)

Contient une chaîne majuscule courte qui représente l'erreur retournée. Mappé à error_type. Consultez la liste sous les notes.

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_type

error_type

Description

1

MISC

Toutes les erreurs qui ne font pas l'objet d'une description.

2

SYNTAX

Une erreur de syntaxe s'est produite dans le lot.

3

CONFLICTING_RESULTS

Le résultat n'a pas pu être déterminé en raison d'un conflit entre deux premières instructions possibles.

4

DYNAMIC_SQL

Le résultat n'a pas pu être déterminé en raison du SQL dynamique qui pourrait éventuellement retourner le premier résultat.

5

CLR_PROCEDURE

Le résultat n'a pas pu être déterminé parce qu'une procédure stockée clr pourrait éventuellement retourner le premier résultat.

6

CLR_TRIGGER

Le résultat n'a pas pu être déterminé parce qu'un déclencheur CLR pourrait éventuellement retourner le premier résultat.

7

EXTENDED_PROCEDURE

Le résultat n'a pas pu être déterminé parce qu'une procédure stockée étendue pourrait éventuellement retourner le premier résultat.

8

UNDECLARED_PARAMETER

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

9

RECURSION

Le résultat n'a pas pu être déterminé car le lot contient une instruction récursive.

10

TEMPORARY_TABLE

Le résultat n'a pas pu être déterminé car le lot contient une table temporaire qui n'est pas prise en charge par sp_describe_first_result_set.

11

UNSUPPORTED_STATEMENT

Le résultat n'a pas pu être déterminé car le lot contient une instruction qui n'est pas prise en charge par sp_describe_first_result_set (par exemple, FETCH, REVERT etc.).

12

OBJECT_TYPE_NOT_SUPPORTED

L'identifiant @object_id passé à la fonction n'est pas pris en charge (autrement dit, il ne s'agit pas d'une procédure stockée)

13

OBJECT_DOES_NOT_EXIST

L'identifiant @object_id passé à la fonction était introuvable dans le catalogue système.

Autorisations

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

Exemples

Les exemples supplémentaires de 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 AdventureWorks2012;
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. Puis 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 AdventureWorks2012;
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 AdventureWorks2012;
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

Référence

sp_describe_first_result_set (Transact-SQL)

sp_describe_undeclared_parameters (Transact-SQL)

sys.dm_exec_describe_first_result_set_for_object (Transact-SQL)