Passer au contenu principal
Affiche le plan d’exécution d’une instruction.
Syntaxe :
Exemple :

​
Types d’EXPLAIN

  • AST — Arbre syntaxique abstrait.
  • SYNTAX — Texte de la requête après les optimisations au niveau de l’AST.
  • QUERY TREE — Arbre de requête après les optimisations au niveau de l’arbre de requête.
  • PLAN — Plan d’exécution de la requête.
  • PIPELINE — Pipeline d’exécution de la requête.

​
EXPLAIN AST

Affiche l’AST de la requête. Prend en charge tous les types de requêtes, pas uniquement SELECT. Paramètres :
  • graph – Affiche l’AST sous forme de graphe, décrit dans le langage de description de graphes DOT. Par défaut : 0.
Exemples :

​
EXPLAIN SYNTAX

Affiche l’arbre syntaxique abstrait (AST) d’une requête après l’analyse syntaxique. Cela consiste à analyser la requête, à construire l’AST et l’arbre de requête, à exécuter éventuellement l’analyseur de requêtes et les passes d’optimisation, puis à reconvertir l’arbre de requête en AST. Paramètres :
  • oneline – Affiche la requête sur une seule ligne. Valeur par défaut : 0.
  • run_query_tree_passes – Exécute les passes de l’arbre de requête avant d’en produire le dump. Valeur par défaut : 0.
  • query_tree_passes – Si run_query_tree_passes est défini, indique combien de passes exécuter. Si query_tree_passes n’est pas spécifié, toutes les passes sont exécutées.
Exemples :
Query
Response
Avec run_query_tree_passes :
Query
Response

​
EXPLAIN QUERY TREE

Paramètres :
  • run_passes — Exécute toutes les passes de l’arbre de requête avant d’en afficher le contenu. Valeur par défaut : 1.
  • dump_passes — Affiche des informations sur les passes utilisées avant d’afficher l’arbre de requête. Valeur par défaut : 0.
  • passes — Indique le nombre de passes à exécuter. S’il est défini sur -1, exécute toutes les passes. Valeur par défaut : -1.
  • dump_tree — Affiche l’arbre de requête. Valeur par défaut : 1.
  • dump_ast — Affiche l’AST de la requête généré à partir de l’arbre de requête. Valeur par défaut : 0.
Exemple :

​
EXPLAIN PLAN

Affiche les étapes du plan de requête. Paramètres :
  • optimize — Détermine si les optimisations du plan de requête sont appliquées avant l’affichage du plan. Par défaut : 1.
  • header — Affiche l’en-tête de sortie pour l’étape. Par défaut : 0.
  • description — Affiche la description de l’étape. Par défaut : 1.
  • indexes — Affiche les index utilisés, le nombre de parts filtrées et le nombre de granules filtrés pour chaque index appliqué. Par défaut : 0. Pris en charge pour les tables MergeTree. À partir de ClickHouse >= v25.9, cette instruction ne produit un résultat pertinent que lorsqu’elle est utilisée avec SETTINGS use_query_condition_cache = 0, use_skip_indexes_on_data_read = 0.
  • projections — Affiche toutes les projections analysées et leur effet sur le filtrage au niveau des parts en fonction des conditions sur la clé primaire de la projection. Pour chaque projection, cette section inclut des statistiques comme le nombre de parts, de lignes, de marks et de plages évaluées à l’aide de la clé primaire de la projection. Elle indique également combien de parts de données ont été ignorées grâce à ce filtrage, sans lecture depuis la projection elle-même. Le champ description permet de déterminer si une projection a réellement été utilisée pour la lecture ou seulement analysée pour le filtrage. Par défaut : 0. Pris en charge pour les tables MergeTree.
  • actions — Affiche des informations détaillées sur les actions de l’étape. Par défaut : 0.
  • sorting — Affiche la description du tri pour chaque étape du plan produisant une sortie triée. Par défaut : 0.
  • keep_logical_steps — Conserve les étapes logiques du plan pour les jointures au lieu de les convertir en implémentations physiques de jointure. Par défaut : 0.
  • json — Affiche les étapes du plan de requête sous la forme d’une ligne au format JSON. Par défaut : 0. Il est recommandé d’utiliser le format TabSeparatedRaw (TSVRaw) pour éviter les séquences d’échappement inutiles.
  • input_headers — Affiche les en-têtes d’entrée pour l’étape. Par défaut : 0. Utile principalement aux développeurs pour le Débogage des problèmes liés à une incompatibilité entre les en-têtes d’entrée et de sortie.
  • column_structure — Affiche également la structure des colonnes dans les en-têtes, en plus de leur nom et de leur type. Par défaut : 0. Utile principalement aux développeurs pour le Débogage des problèmes liés à une incompatibilité entre les en-têtes d’entrée et de sortie.
  • distributed — Affiche les plans de requête exécutés sur des nœuds distants pour les tables distribuées ou les répliques parallèles. Par défaut : 0.
  • compact — Lorsqu’il est activé, masque dans le plan les étapes d’expression et les informations détaillées sur les actions (entrées, fonctions, alias et positions de sortie). N’a d’effet que lorsque actions = 1. Par défaut : 0.
  • pretty — Affiche l’arborescence du plan à l’aide de caractères de dessin de lignes (├──, └──, │) au lieu de l’indentation, afin de visualiser la hiérarchie. Formate également les propriétés des étapes de jointure de manière intégrée. Par défaut : 0.
Lorsque json=1, les noms des étapes contiennent un suffixe supplémentaire avec un identifiant d’étape unique. Exemple :
L’estimation du coût des étapes et de la requête n’est pas prise en charge.
Lorsque json = 1, le plan de requête est représenté au format JSON. Chaque nœud est un dictionnaire qui contient toujours les clés Node Type et Plans. Node Type est une chaîne de caractères contenant le nom d’une étape. Plans est un tableau contenant la description des étapes enfants. D’autres clés facultatives peuvent être ajoutées selon le type de nœud et les paramètres. Exemple :
Avec description = 1, la clé Description est ajoutée à l’étape :
Avec header = 1, la clé Header est ajoutée à l’étape sous forme d’un tableau de colonnes. Exemple :
Avec indexes = 1, la clé Indexes est ajoutée. Elle contient un tableau des index utilisés. Chaque index est décrit en JSON avec la clé Type (une chaîne Partition Min-Max, Partition, Statistics, PrimaryKey ou Skip) et, éventuellement, les clés suivantes :
  • Name — Le nom de l’index (actuellement utilisé uniquement pour les index Skip).
  • Keys — Le tableau des colonnes utilisées par l’index.
  • Condition — La condition utilisée.
  • Description — La description de l’index (actuellement utilisée uniquement pour les index Skip).
  • Parts — Le nombre de parts après/avant l’application de l’index.
  • Granules — Le nombre de granules après/avant l’application de l’index.
  • Ranges — Le nombre de plages de granules après l’application de l’index.
Exemple :
Avec projections = 1, la clé Projections est ajoutée. Elle contient un tableau des projections analysées. Chaque projection est décrite au format JSON avec les clés suivantes :
  • Name — Le nom de la projection.
  • Condition — La condition sur la clé primaire de la projection utilisée.
  • Description — La description de la façon dont la projection est utilisée (par ex. filtrage au niveau des parts).
  • Selected Parts — Nombre de parts sélectionnées par la projection.
  • Selected Marks — Nombre de marks sélectionnées.
  • Selected Ranges — Nombre de plages sélectionnées.
  • Selected Rows — Nombre de lignes sélectionnées.
  • Filtered Parts — Nombre de parts ignorées en raison du filtrage au niveau des parts.
Exemple :
Avec actions = 1, les clés ajoutées dépendent du type d’étape. Exemple :
Avec compact = 1, chaque étape Expression est supprimée. Par ailleurs, si actions = 1 est défini, les lignes Actions et Positions sont masquées, ne laissant que les descriptions des étapes :
Avec distributed = 1, la sortie inclut non seulement le plan de requête local, mais également les plans de requête qui seront exécutés sur les nœuds distants. Cela s’avère utile pour analyser et déboguer les requêtes distribuées. Exemple avec une table distribuée :
Exemple avec des répliques parallèles :
Dans les deux exemples, le plan de requête affiche le flux d’exécution complet, y compris les étapes locales et distantes. Avec pretty = 1, l’arbre du plan est affiché à l’aide de caractères de tracé plutôt que par indentation, et des informations supplémentaires sont affichées pour les étapes clés :
  • Les colonnes de sortie de la query sont affichées en haut du plan.
  • Les expressions dans les filtres, les clés d’agrégation, les descriptions de tri et les fonctions de fenêtre sont affichées dans une notation de type SQL lisible par l’humain (par ex. a + 1 > 5 au lieu de greater(plus(a, 1), 5)). Les préfixes internes des identifiants de colonne (tels que __table1.) sont supprimés pour plus de clarté.
  • Les étapes source (telles que ReadFromMergeTree) affichent leurs colonnes de sortie.
  • Les étapes de filtre affichent la condition de filtre en notation SQL. Lorsque des filtres de jointure à l’exécution sont présents, ils sont affichés séparément.
  • Les étapes d’agrégation affichent les clés et les fonctions d’agrégation avec leurs arguments (par ex. sum(c), count()).
  • Les ensembles IN issus de littéraux de tuple affichent leurs valeurs (tronquées pour les grands ensembles), les ensembles basés sur des sous-requêtes sont étiquetés subquery1, subquery2, etc., et les ensembles provenant de tables utilisant le moteur Set affichent le nom de la table.
  • Les étapes de jointure affichent la relation de jointure à l’aide d’une notation mathématique, le nombre estimé de lignes du résultat, ainsi que les colonnes de sortie provenant du côté gauche ou du côté droit. Les symboles suivants sont utilisés pour représenter les différents types de jointure :
SymboleType de jointure
⋈Jointure interne
⟕Jointure gauche
⟖Jointure droite
⟗Jointure complète
⋉Semi-jointure gauche
⋊Semi-jointure droite
⋉ with strikethroughAnti-jointure gauche
⋊ with strikethroughAnti-jointure droite
×Jointure croisée
Par exemple, t1 ⟕ t2 signifie une jointure gauche entre les tables t1 et t2. Le nombre entre crochets après le nom de la table (par ex. t1[100]) indique le nombre estimé de lignes lorsque les statistiques de table sont disponibles. L’option pretty fonctionne bien avec compact = 1, qui masque les étapes Expression et les informations détaillées sur les actions, ce qui rend le plan plus lisible.
Un exemple plus détaillé avec des jointures :

​
EXPLAIN PIPELINE

Paramètres :
  • header — Affiche l’en-tête de chaque port de sortie. Valeur par défaut : 0.
  • graph — Affiche un graphe décrit dans le langage de description de graphes DOT. Valeur par défaut : 0.
  • compact — Affiche le graphe en mode compact si le paramètre graph est activé. Valeur par défaut : 1.
  • compact_repeated_processor_chains — Regroupe les chaînes de processeurs répétées et adjacentes dans la sortie texte en n’affichant qu’une seule occurrence de la chaîne avec un nombre de répétitions. Cela peut faciliter la lecture des pipelines parallèles lorsque la même chaîne apparaît de nombreuses fois, par exemple dans des jointures. Cela n’affecte pas la sortie du graphe. Valeur par défaut : 0.
Lorsque compact=0 et graph=1, les noms des processeurs contiendront un suffixe supplémentaire indiquant un identifiant de processeur unique. Exemple :

​
EXPLAIN ESTIMATE

Affiche le nombre estimé de lignes, de marks et de parts à lire dans les tables lors du traitement de la requête. Fonctionne avec les tables de la famille MergeTree. Exemple Création d’une table :
Query
Query
Response

​
EXPLAIN TABLE OVERRIDE

Affiche le résultat d’une surcharge de table appliquée au schéma d’une table accessible via une fonction de table. Effectue également certaines vérifications et lève une exception si la surcharge aurait entraîné un échec. Exemple Supposons que vous ayez une table MySQL distante comme celle-ci :
Query
Query
Response
La validation n’est pas exhaustive ; une requête réussie ne garantit donc pas que l’override ne posera pas de problèmes.
Dernière modification le 2 juillet 2026