sys.dm_exec_text_query_plan (Transact-SQL)
Retourne le Showplan au format texte pour un traitement Transact-SQL ou pour une instruction spécifique dans le traitement. Le plan de requête spécifié par le descripteur de plan peut être en cache ou en cours d'exécution. Cette fonction à valeur de table est similaire à sys.dm_exec_query_plan (Transact-SQL), mais présente les différences suivantes :
La sortie du plan de requête est au format texte.
La taille de cette sortie n'est pas limitée.
Les instructions individuelles dans le traitement peuvent être spécifiées.
.gif "Icône Lien de rubrique")
Syntaxe
sys.dm_exec_text_query_plan
(
plan_handle
, { statement_start_offset | 0 | DEFAULT }
, { statement_end_offset | -1 | DEFAULT }
)
Argument
plan_handle
Identifie de façon univoque un plan de requête pour un traitement en cache ou en cours d'exécution. plan_handle est de type varbinary(64).Le descripteur de plan peut être obtenu à partir des objets de gestion dynamiques suivants :
statement_start_offset | 0 | DEFAULT
Indique, en octets, la position de début de la requête que la ligne décrit dans le texte de son traitement ou de son objet persistant. statement_start_offset est de type int. La valeur 0 indique le début du traitement. La valeur par défaut est 0.Le décalage de début de l'instruction peut être obtenu à partir des objets de gestion dynamiques suivants :
statement_end_offset | -1 | DEFAULT
Indique, en octets, la position de fin de la requête que la ligne décrit dans le texte de son traitement ou de son objet persistant.L'argument statement_start_offset est de type int.
La valeur -1 indique la fin du traitement. La valeur par défaut est -1.
Table renvoyée
Nom de colonne |
Type de données |
Description |
|---|---|---|
dbid |
smallint |
ID de la base de données de contexte qui était en fonction lorsque l'instruction Transact-SQL correspondant à ce plan a été compilée. Pour les traitements appropriés et préparés, cette colonne est null. Colonne acceptant la valeur NULL. |
objectid |
int |
ID de l'objet (par exemple, procédure stockée ou fonction définie par l'utilisateur) pour ce plan de requête. Pour les traitements appropriés et préparés, cette colonne est null. Colonne acceptant la valeur NULL. |
number |
smallint |
Entier servant à la numérotation des procédures stockées. Par exemple, un groupe de procédures pour l'application orders peuvent être appelées orderproc;1, orderproc;2, etc. Pour les traitements appropriés et préparés, cette colonne est null. Colonne acceptant la valeur NULL. |
encrypted |
bit |
Indique si la procédure stockée correspondante est chiffrée. 0 = Non chiffrée. 1 = Chiffrée. La colonne n'accepte pas de valeur NULL. |
query_plan |
nvarchar(max) |
Contient la représentation du plan d'exécution (Showplan) à la compilation du plan d'exécution de requête qui est spécifié à l'aide de l'argument plan_handle. Le Showplan est au format texte. Un plan est généré pour chaque traitement contenant par exemple des instructions Transact-SQL appropriées, des appels de procédures stockées et des appels de fonctions définies par l'utilisateur. Colonne acceptant la valeur NULL. |
Notes
Aucune sortie Showplan n'est retournée dans la colonne plan de la table retournée pour l'objet sys.dm_exec_text_query_plan dans les conditions suivantes :
Si le plan de requête spécifié au moyen de l'argument plan_handle a été supprimé de la mémoire cache des plans, la valeur de la colonne query_plan de la table retournée est null. Ceci peut se produire par exemple s'il existe un délai entre le moment où le descripteur de plan est capturé et le moment de son utilisation avec sys.dm_exec_text_query_plan.
Certaines instructions Transact-SQL ne sont pas mises en mémoire cache, par exemple les instructions d'opérations en bloc ou les instructions contenant des littéraux de chaîne dont la taille est supérieure à 8 Ko. Il est impossible de récupérer pour de telles instructions des plans d'exécution XML à l'aide de sys.dm_exec_text_query_plan car elles n'existent pas dans la mémoire cache.
Si une procédure stockée ou un traitement Transact-SQL contient un appel à une fonction définie par l'utilisateur ou un appel à du code SQL dynamique, par exemple via la commande EXEC (string), le plan d'exécution XML compilé pour cette fonction n'est pas inclus dans la table renvoyée par sys.dm_exec_text_query_plan pour la procédure stockée ou le traitement. Vous devez donc procéder à un appel distinct à sys.dm_exec_text_query_plan pour l'argument plan_handle correspondant à la fonction définie par l'utilisateur.
Lorsqu'une requête ad hoc utilise un paramétrage simple ou forcé, la colonne query_plan contient uniquement le texte de l'instruction, pas le plan de requête réel. Pour retourner le plan de requête, appelez sys.dm_exec_text_query_plan pour le descripteur de plan de la requête paramétrée préparée. Vous pouvez déterminer si la requête a été paramétrée par le référencement de la colonne sql de la vue sys.syscacheobjects ou le texte de colonne de la vue de gestion dynamique sys.dm_exec_sql_text. Pour plus d'informations sur le paramétrage, consultez Paramétrage simple et Paramétrage forcé.
Autorisations
Pour exécuter sys.dm_exec_text_query_plan, l'utilisateur doit être membre du rôle de serveur fixe sysadmin ou disposer de l'autorisation VIEW SERVER STATE sur le serveur.
Exemples
A. Récupération du plan de requête mis en mémoire cache pour un traitement ou une requête Transact-SQL à exécution lente
Si une requête ou un traitement Transact-SQL s'exécute longtemps sur une connexion à SQL Server spécifique, récupérez le plan d'exécution de cette requête ou de ce traitement pour trouver la raison de ce retard. L'exemple suivant montre la récupération du plan d'exécution pour une requête ou un traitement s'exécutant lentement.
[!REMARQUE]
Pour utiliser cet exemple, remplacez les valeurs de session_id et de plan_handle par des valeurs spécifiques à votre serveur.
Récupérez tout d'abord à l'aide de la procédure stockée sp_who l'ID de processus serveur (SPID) pour le processus exécutant la requête ou le traitement.
USE master;
GO
EXEC sp_who;
GO
L'ensemble de résultats renvoyé par sp_who indique que le SPID est 54. Utilisez cet identificateur avec la vue de gestion dynamique sys.dm_exec_requests pour récupérer le descripteur de plan via la requête suivante :
USE master;
GO
SELECT * FROM sys.dm_exec_requests
WHERE session_id = 54;
GO
La table retournée par sys.dm_exec_requests indique que le descripteur de plan pour la requête ou le traitement à exécution lente est 0x06000100A27E7C1FA821B10600. L'exemple suivant retourne le plan de requête pour le descripteur de plan spécifié et utilise les valeurs par défaut 0 et -1 pour retourner toutes les instructions dans la requête ou le traitement.
USE master;
GO
SELECT query_plan
FROM sys.dm_exec_text_query_plan (0x06000100A27E7C1FA821B10600,0,-1);
GO
B. Récupération de chaque plan de requête à partir de la mémoire cache des plans
Pour récupérer une capture instantanée de tous les plans de requête résidant dans la mémoire cache des plans, procurez-vous les descripteurs de tous les plans de requête dans la mémoire cache via une requête dans la vue de gestion dynamique sys.dm_exec_cached_plans. Les descripteurs de plan sont stockés dans la colonne plan_handle de sys.dm_exec_cached_plans. Utilisez ensuite l'opérateur CROSS APPLY pour transmettre les descripteurs à sys.dm_exec_text_query_plan comme suit. La sortie du plan d'exécution XML pour chaque plan actuellement dans la mémoire cache des plans se trouve dans la colonne query_plan de la table retournée.
USE master;
GO
SELECT *
FROM sys.dm_exec_cached_plans AS cp
CROSS APPLY sys.dm_exec_text_query_plan(cp.plan_handle, DEFAULT, DEFAULT);
GO
C. Récupération dans la mémoire cache des plans de chaque plan de requête pour lequel le serveur a regroupé des statistiques de requête
Pour récupérer une capture instantanée de tous les plans de requête pour lesquels le serveur a regroupé des statistiques actuellement dans la mémoire cache des plans, procurez-vous les descripteurs de ces plans dans la mémoire cache via une requête formulée dans la vue de gestion dynamique sys.dm_exec_query_stats. Les descripteurs de plan sont stockés dans la colonne plan_handle de sys.dm_exec_query_stats. Utilisez ensuite l'opérateur CROSS APPLY pour transmettre les descripteurs à sys.dm_exec_text_query_plan comme suit. La sortie du plan d'exécution pour chaque plan est dans la colonne query_plan de la table retournée.
USE master;
GO
SELECT * FROM sys.dm_exec_query_stats AS qs
CROSS APPLY sys.dm_exec_text_query_plan(qs.plan_handle, qs.statement_start_offset, qs.statement_end_offset);
GO
D. Récupération d'informations sur les cinq premières requêtes d'après le temps processeur moyen
L'exemple suivant retourne les plans de requête et le temps processeur moyen pour les cinq premières requêtes. La fonction sys.dm_exec_text_query_plan spécifie les valeurs par défaut 0 et -1 pour retourner toutes les instructions dans le traitement du plan de requête.
SELECT TOP 5 total_worker_time/execution_count AS [Avg CPU Time],
Plan_handle, query_plan
FROM sys.dm_exec_query_stats AS qs
CROSS APPLY sys.dm_exec_text_query_plan(qs.plan_handle, 0, -1)
ORDER BY total_worker_time/execution_count DESC;
GO
Voir aussi