Instructions SHOW - ClickHouse Documentation

SHOW CREATE (TABLE|DATABASE|USER) masque les secrets, sauf si les paramètres suivants sont activés :

display_secrets_in_show_and_select (paramètre serveur)
format_display_secrets_in_show_and_select (paramètre de format)

De plus, l’utilisateur doit disposer du privilège displaySecretsInShowAndSelect.

SHOW CREATE TABLE | DICTIONARY | VIEW | DATABASE

Ces instructions renvoient une unique colonne de type String, contenant la requête CREATE utilisée pour créer l’objet indiqué.

Syntaxe

Syntax

SHOW [CREATE] TABLE | TEMPORARY TABLE | DICTIONARY | VIEW | DATABASE [db.]table|view [INTO OUTFILE filename] [FORMAT format]

Si vous utilisez cette instruction pour obtenir la requête CREATE des tables système, vous obtiendrez une requête factice, qui ne fait que déclarer la structure de la table et ne peut pas être utilisée pour créer une table.

SHOW DATABASES

Cette instruction affiche la liste de toutes les bases de données.

Syntaxe

Syntax

SHOW DATABASES [[NOT] LIKE | ILIKE '<pattern>'] [LIMIT <N>] [INTO OUTFILE filename] [FORMAT format]

Elle est identique à la requête :

SELECT name FROM system.databases [WHERE name [NOT] LIKE | ILIKE '<pattern>'] [LIMIT <N>] [INTO OUTFILE filename] [FORMAT format]

Exemples

Dans cet exemple, nous utilisons SHOW pour afficher les noms des bases de données contenant la séquence de caractères ‘de’ dans leur nom :

Query

SHOW DATABASES LIKE '%de%'

Response

┌─name────┐
│ default │
└─────────┘

Nous pouvons également le faire sans tenir compte de la casse :

Query

SHOW DATABASES ILIKE '%DE%'

Response

┌─name────┐
│ default │
└─────────┘

Ou obtenez les noms des bases de données qui ne contiennent pas ‘de’ :

Query

SHOW DATABASES NOT LIKE '%de%'

Response

┌─name───────────────────────────┐
│ _temporary_and_external_tables │
│ system                         │
│ test                           │
│ tutorial                       │
└────────────────────────────────┘

Enfin, nous pouvons obtenir les noms des deux premières bases de données :

Query

SHOW DATABASES LIMIT 2

Response

┌─name───────────────────────────┐
│ _temporary_and_external_tables │
│ default                        │
└────────────────────────────────┘

Voir aussi

CREATE DATABASE

SHOW TABLES

L’instruction SHOW TABLES affiche la liste des tables.

Syntaxe

Syntax

SHOW [FULL] [TEMPORARY] TABLES [{FROM | IN} <db>] [[NOT] LIKE | ILIKE '<pattern>'] [LIMIT <N>] [INTO OUTFILE <filename>] [FORMAT <format>]

Si la clause FROM n’est pas spécifiée, la requête renvoie la liste des tables de la base de données courante. Cette instruction est identique à la requête suivante :

SELECT name FROM system.tables [WHERE name [NOT] LIKE | ILIKE '<pattern>'] [LIMIT <N>] [INTO OUTFILE <filename>] [FORMAT <format>]

Exemples

Dans cet exemple, nous utilisons l’instruction SHOW TABLES pour répertorier toutes les tables contenant ‘user’ dans leur nom :

Query

SHOW TABLES FROM system LIKE '%user%'

Response

┌─name─────────────┐
│ user_directories │
│ users            │
└──────────────────┘

Nous pouvons également le faire sans tenir compte de la casse :

Query

SHOW TABLES FROM system ILIKE '%USER%'

Response

┌─name─────────────┐
│ user_directories │
│ users            │
└──────────────────┘

Ou, pour trouver des tables dont le nom ne contient pas la lettre ‘s’ :

Query

SHOW TABLES FROM system NOT LIKE '%s%'

Response

┌─name─────────┐
│ metric_log   │
│ metric_log_0 │
│ metric_log_1 │
└──────────────┘

Enfin, nous pouvons obtenir uniquement les noms des deux premières tables :

Query

SHOW TABLES FROM system LIMIT 2

Response

┌─name───────────────────────────┐
│ aggregate_function_combinators │
│ asynchronous_metric_log        │
└────────────────────────────────┘

Voir aussi

SHOW COLUMNS

L’instruction SHOW COLUMNS affiche la liste des colonnes.

Syntaxe

Syntax

SHOW [EXTENDED] [FULL] COLUMNS {FROM | IN} <table> [{FROM | IN} <db>] [{[NOT] {LIKE | ILIKE} '<pattern>' | WHERE <expr>}] [LIMIT <N>] [INTO
OUTFILE <filename>] [FORMAT <format>]

Le nom de la base de données et de la table peut être indiqué sous une forme abrégée, <db>.<table>, ce qui signifie que FROM tab FROM db et FROM db.tab sont équivalents. Si aucune base de données n’est indiquée, la requête renvoie la liste des colonnes de la base de données courante. Il existe également deux mots-clés optionnels : EXTENDED et FULL. Le mot-clé EXTENDED n’a actuellement aucun effet et existe pour la compatibilité avec MySQL. Le mot-clé FULL ajoute à la sortie les colonnes collation, commentaire et privilège. L’instruction SHOW COLUMNS produit un tableau de résultats avec la structure suivante :

Colonne	Description	Type
`field`	Le nom de la colonne	`String`
`type`	Le type de données de la colonne. Si la requête a été effectuée via le MySQL wire protocol, le type équivalent dans MySQL est affiché.	`String`
`null`	`YES` si le type de données de la colonne est Nullable, sinon `NO`	`String`
`key`	`PRI` si la colonne fait partie de la clé primaire, `SOR` si la colonne fait partie de la clé de tri, vide sinon	`String`
`default`	Expression par défaut de la colonne si elle est de type `ALIAS`, `DEFAULT` ou `MATERIALIZED`, sinon `NULL`.	`Nullable(String)`
`extra`	Informations supplémentaires, actuellement inutilisées	`String`
`collation`	(uniquement si le mot-clé `FULL` a été spécifié) Collation de la colonne, toujours `NULL` car ClickHouse n’a pas de collations par colonne	`Nullable(String)`
`comment`	(uniquement si le mot-clé `FULL` a été spécifié) Commentaire de la colonne	`String`
`privilege`	(uniquement si le mot-clé `FULL` a été spécifié) Le privilège dont vous disposez sur cette colonne, actuellement indisponible	`String`

Exemples

Dans cet exemple, nous utiliserons l’instruction SHOW COLUMNS pour obtenir des informations sur toutes les colonnes de la table ‘orders’, à partir de ‘delivery_’:

Query

SHOW COLUMNS FROM 'orders' LIKE 'delivery_%'

Response

┌─field───────────┬─type─────┬─null─┬─key─────┬─default─┬─extra─┐
│ delivery_date   │ DateTime │    0 │ PRI SOR │ ᴺᵁᴸᴸ    │       │
│ delivery_status │ Bool     │    0 │         │ ᴺᵁᴸᴸ    │       │
└─────────────────┴──────────┴──────┴─────────┴─────────┴───────┘

Voir aussi

system.columns

SHOW DICTIONARIES

L’instruction SHOW DICTIONARIES affiche la liste des Dictionaries.

Syntaxe

Syntax

SHOW DICTIONARIES [FROM <db>] [LIKE '<pattern>'] [LIMIT <N>] [INTO OUTFILE <filename>] [FORMAT <format>]

Si la clause FROM n’est pas spécifiée, la requête renvoie la liste des dictionnaires de la base de données courante. Vous pouvez obtenir le même résultat que la requête SHOW DICTIONARIES de la manière suivante :

SELECT name FROM system.dictionaries WHERE database = <db> [AND name LIKE <pattern>] [LIMIT <N>] [INTO OUTFILE <filename>] [FORMAT <format>]

Exemples

La requête suivante sélectionne les deux premières lignes de la liste des tables dans la base de données system, dont le nom contient reg.

Query

SHOW DICTIONARIES FROM db LIKE '%reg%' LIMIT 2

Response

┌─name─────────┐
│ regions      │
│ region_names │
└──────────────┘

SHOW INDEX

Affiche une liste des index primaires et des index de saut de données d’une table. Cette instruction existe principalement pour assurer la compatibilité avec MySQL. Les tables système system.tables (pour les clés primaires) et system.data_skipping_indices (pour les index de saut de données) fournissent des informations équivalentes, mais d’une manière plus conforme aux usages natifs de ClickHouse.

Syntaxe

Syntax

SHOW [EXTENDED] {INDEX | INDEXES | INDICES | KEYS } {FROM | IN} <table> [{FROM | IN} <db>] [WHERE <expr>] [INTO OUTFILE <filename>] [FORMAT <format>]

Le nom de la base de données et celui de la table peuvent être indiqués sous forme abrégée sous la forme <db>.<table> ; autrement dit, FROM tab FROM db et FROM db.tab sont équivalents. Si aucune base de données n’est spécifiée, la requête utilise la base de données courante. Le mot-clé facultatif EXTENDED n’a actuellement aucun effet et est présent pour assurer la compatibilité avec MySQL. L’instruction produit un tableau de résultats ayant la structure suivante :

Column	Description	Type
`table`	Le nom de la table.	`String`
`non_unique`	Toujours `1`, car ClickHouse ne prend pas en charge les contraintes d’unicité.	`UInt8`
`key_name`	Le nom de l’index ; `PRIMARY` si l’index est un index de clé primaire.	`String`
`seq_in_index`	Pour un index de clé primaire, la position de la colonne à partir de `1`. Pour un index de saut de données : toujours `1`.	`UInt8`
`column_name`	Pour un index de clé primaire, le nom de la colonne. Pour un index de saut de données : `''` (chaîne vide), voir le champ “expression”.	`String`
`collation`	L’ordre de tri de la colonne dans l’index : `A` pour croissant, `D` pour décroissant, `NULL` si non trié.	`Nullable(String)`
`cardinality`	Une estimation de la cardinalité de l’index (nombre de valeurs uniques dans l’index). Actuellement toujours 0.	`UInt64`
`sub_part`	Toujours `NULL`, car ClickHouse ne prend pas en charge les préfixes d’index comme MySQL.	`Nullable(String)`
`packed`	Toujours `NULL`, car ClickHouse ne prend pas en charge les index compactés (comme MySQL).	`Nullable(String)`
`null`	Actuellement inutilisé.
`index_type`	Le type d’index, par ex. `PRIMARY`, `MINMAX`, `BLOOM_FILTER`, etc.	`String`
`comment`	Informations supplémentaires sur l’index, actuellement toujours `''` (chaîne vide).	`String`
`index_comment`	`''` (chaîne vide), car les index dans ClickHouse ne peuvent pas avoir de champ `COMMENT` (comme dans MySQL).	`String`
`visible`	Si l’index est visible pour l’optimiseur, toujours `YES`.	`String`
`expression`	Pour un index de saut de données, l’expression de l’index. Pour un index de clé primaire : `''` (chaîne vide).	`String`

Exemples

Dans cet exemple, nous utilisons l’instruction SHOW INDEX pour obtenir des informations sur tous les index de la table ‘tbl’

Query

SHOW INDEX FROM 'tbl'

Response

┌─table─┬─non_unique─┬─key_name─┬─seq_in_index─┬─column_name─┬─collation─┬─cardinality─┬─sub_part─┬─packed─┬─null─┬─index_type───┬─comment─┬─index_comment─┬─visible─┬─expression─┐
│ tbl   │          1 │ blf_idx  │ 1            │ 1           │ ᴺᵁᴸᴸ      │ 0           │ ᴺᵁᴸᴸ     │ ᴺᵁᴸᴸ   │ ᴺᵁᴸᴸ │ BLOOM_FILTER │         │               │ YES     │ d, b       │
│ tbl   │          1 │ mm1_idx  │ 1            │ 1           │ ᴺᵁᴸᴸ      │ 0           │ ᴺᵁᴸᴸ     │ ᴺᵁᴸᴸ   │ ᴺᵁᴸᴸ │ MINMAX       │         │               │ YES     │ a, c, d    │
│ tbl   │          1 │ mm2_idx  │ 1            │ 1           │ ᴺᵁᴸᴸ      │ 0           │ ᴺᵁᴸᴸ     │ ᴺᵁᴸᴸ   │ ᴺᵁᴸᴸ │ MINMAX       │         │               │ YES     │ c, d, e    │
│ tbl   │          1 │ PRIMARY  │ 1            │ c           │ A         │ 0           │ ᴺᵁᴸᴸ     │ ᴺᵁᴸᴸ   │ ᴺᵁᴸᴸ │ PRIMARY      │         │               │ YES     │            │
│ tbl   │          1 │ PRIMARY  │ 2            │ a           │ A         │ 0           │ ᴺᵁᴸᴸ     │ ᴺᵁᴸᴸ   │ ᴺᵁᴸᴸ │ PRIMARY      │         │               │ YES     │            │
│ tbl   │          1 │ set_idx  │ 1            │ 1           │ ᴺᵁᴸᴸ      │ 0           │ ᴺᵁᴸᴸ     │ ᴺᵁᴸᴸ   │ ᴺᵁᴸᴸ │ SET          │         │               │ YES     │ e          │
└───────┴────────────┴──────────┴──────────────┴─────────────┴───────────┴─────────────┴──────────┴────────┴──────┴──────────────┴─────────┴───────────────┴─────────┴────────────┘

Voir aussi

SHOW PROCESSLIST

Affiche le contenu de la table system.processes, qui contient la liste des requêtes en cours de traitement à cet instant, à l’exception des requêtes SHOW PROCESSLIST.

Syntaxe

Syntax

SHOW PROCESSLIST [INTO OUTFILE filename] [FORMAT format]

La requête SELECT * FROM system.processes renvoie des informations sur toutes les requêtes actuellement en cours d’exécution.

Exécutez dans le terminal :

$ watch -n1 "clickhouse-client --query='SHOW PROCESSLIST'"

SHOW GRANTS

L’instruction SHOW GRANTS affiche les privilèges d’un utilisateur.

Syntaxe

Syntax

SHOW GRANTS [FOR user1 [, user2 ...]] [WITH IMPLICIT] [FINAL]

SHOW ACCESS

SHOW CLUSTER(S)

L’instruction SHOW CLUSTER(S) renvoie une liste de clusters. Tous les clusters disponibles sont répertoriés dans la table system.clusters.

La requête SHOW CLUSTER name affiche les valeurs cluster, shard_num, replica_num, host_name, host_address et port de la table system.clusters pour le nom de cluster spécifié.

Syntaxe

Syntax

SHOW CLUSTER '<name>'
SHOW CLUSTERS [[NOT] LIKE|ILIKE '<pattern>'] [LIMIT <N>]

Exemples

Query

SHOW CLUSTERS;

Response

┌─cluster──────────────────────────────────────┐
│ test_cluster_two_shards                      │
│ test_cluster_two_shards_internal_replication │
│ test_cluster_two_shards_localhost            │
│ test_shard_localhost                         │
│ test_shard_localhost_secure                  │
│ test_unavailable_shard                       │
└──────────────────────────────────────────────┘

Query

SHOW CLUSTERS LIKE 'test%' LIMIT 1;

Response

┌─cluster─────────────────┐
│ test_cluster_two_shards │
└─────────────────────────┘

Query

SHOW CLUSTER 'test_shard_localhost' FORMAT Vertical;

Response

Row 1:
──────
cluster:                 test_shard_localhost
shard_num:               1
replica_num:             1
host_name:               localhost
host_address:            127.0.0.1
port:                    9000

SHOW SETTINGS

L’instruction SHOW SETTINGS renvoie la liste des paramètres système et de leurs valeurs. Elle extrait les données de la table system.settings.

Syntaxe

Syntax

SHOW [CHANGED] SETTINGS LIKE|ILIKE <name>

Clauses

LIKE|ILIKE permettent de définir un motif de correspondance pour le nom du paramètre. Ce motif peut contenir des caractères génériques tels que % ou _. La clause LIKE est sensible à la casse, ILIKE ne l’est pas. Lorsque la clause CHANGED est utilisée, la requête renvoie uniquement les paramètres dont la valeur diffère de leur valeur par défaut.

Exemples

Requête avec la clause LIKE :

Query

SHOW SETTINGS LIKE 'send_timeout';

Response

┌─name─────────┬─type────┬─value─┐
│ send_timeout │ Seconds │ 300   │
└──────────────┴─────────┴───────┘

Requête utilisant la clause ILIKE :

Query

SHOW SETTINGS ILIKE '%CONNECT_timeout%'

Response

┌─name────────────────────────────────────┬─type─────────┬─value─┐
│ connect_timeout                         │ Seconds      │ 10    │
│ connect_timeout_with_failover_ms        │ Milliseconds │ 50    │
│ connect_timeout_with_failover_secure_ms │ Milliseconds │ 100   │
└─────────────────────────────────────────┴──────────────┴───────┘

Requête avec la clause CHANGED :

Query

SHOW CHANGED SETTINGS ILIKE '%MEMORY%'

Response

┌─name─────────────┬─type───┬─value───────┐
│ max_memory_usage │ UInt64 │ 10000000000 │
└──────────────────┴────────┴─────────────┘

SHOW SETTING

L’instruction SHOW SETTING affiche la valeur du paramètre pour le nom de paramètre indiqué.

Syntaxe

Syntax

SHOW SETTING <name>

Voir aussi

table system.settings

SHOW FILESYSTEM CACHES

Exemples

Query

SHOW FILESYSTEM CACHES

Response

┌─Caches────┐
│ s3_cache  │
└───────────┘

Voir aussi

table system.settings

SHOW ENGINES

L’instruction SHOW ENGINES affiche le contenu de la table system.table_engines, qui contient la description des moteurs de table pris en charge par le serveur, ainsi que des informations sur les fonctionnalités qu’ils prennent en charge.

Syntaxe

Syntax

SHOW ENGINES [INTO OUTFILE filename] [FORMAT format]

Voir aussi

table system.table_engines

SHOW FUNCTIONS

L’instruction SHOW FUNCTIONS affiche le contenu de la table system.functions.

Syntaxe

Syntax

SHOW FUNCTIONS [LIKE | ILIKE '<pattern>']

Si l’une des clauses LIKE ou ILIKE est spécifiée, la requête renvoie une liste des fonctions système dont le nom correspond au <pattern> fourni.

Voir aussi

table system.functions

SHOW MERGES

L’instruction SHOW MERGES renvoie la liste des fusions. Toutes les fusions sont répertoriées dans la table system.merges :

Colonne	Description
`table`	Nom de la table.
`database`	Nom de la base de données à laquelle appartient la table.
`estimate_complete`	Temps estimé avant la fin (en secondes).
`elapsed`	Temps écoulé (en secondes) depuis le début de la fusion.
`progress`	Pourcentage de travail effectué (de 0 à 100 %).
`is_mutation`	1 si ce processus correspond à une mutation de part.
`size_compressed`	Taille totale des données compressées des parts fusionnées.
`memory_usage`	Consommation mémoire du processus de fusion.

Syntaxe

Syntax

SHOW MERGES [[NOT] LIKE|ILIKE '<table_name_pattern>'] [LIMIT <N>]

Exemples

Query

SHOW MERGES;

Response

┌─table──────┬─database─┬─estimate_complete─┬─elapsed─┬─progress─┬─is_mutation─┬─size_compressed─┬─memory_usage─┐
│ your_table │ default  │              0.14 │    0.36 │    73.01 │           0 │        5.40 MiB │    10.25 MiB │
└────────────┴──────────┴───────────────────┴─────────┴──────────┴─────────────┴─────────────────┴──────────────┘

Query

SHOW MERGES LIKE 'your_t%' LIMIT 1;

Response

┌─table──────┬─database─┬─estimate_complete─┬─elapsed─┬─progress─┬─is_mutation─┬─size_compressed─┬─memory_usage─┐
│ your_table │ default  │              0.14 │    0.36 │    73.01 │           0 │        5.40 MiB │    10.25 MiB │
└────────────┴──────────┴───────────────────┴─────────┴──────────┴─────────────┴─────────────────┴──────────────┘

SHOW CREATE MASKING POLICY

L’instruction SHOW CREATE MASKING POLICY affiche les paramètres utilisés lors de la création d’une politique de masquage.

Syntaxe

Syntax

SHOW CREATE MASKING POLICY name ON [database.]table

​SHOW CREATE TABLE | DICTIONARY | VIEW | DATABASE

​Syntaxe

​SHOW DATABASES

​Syntaxe

​Exemples

​Voir aussi

​SHOW TABLES

​Syntaxe

​Exemples

​Voir aussi

​SHOW COLUMNS

​Syntaxe

​Exemples

​Voir aussi

​SHOW DICTIONARIES

​Syntaxe

​Exemples

​SHOW INDEX

​Syntaxe

​Exemples

​Voir aussi

​SHOW PROCESSLIST

​Syntaxe

​SHOW GRANTS

​Syntaxe

​SHOW CREATE USER

​Syntaxe

​SHOW CREATE ROLE

​Syntaxe

​SHOW CREATE ROW POLICY

​Syntaxe

​SHOW CREATE QUOTA

​Syntaxe

​SHOW CREATE SETTINGS PROFILE

​Syntaxe

​SHOW USERS

​Syntaxe

​SHOW ROLES

​Syntaxe

​SHOW PROFILES

​Syntaxe

​SHOW POLICIES

​Syntaxe

​SHOW QUOTAS

​Syntaxe

​SHOW QUOTA

​Syntaxe

​SHOW ACCESS

​Syntaxe

​SHOW CLUSTER(S)

​Syntaxe

​Exemples

​SHOW SETTINGS

​Syntaxe

​Clauses

​Exemples

​SHOW SETTING

​Syntaxe

​Voir aussi

​SHOW FILESYSTEM CACHES

​Exemples

​Voir aussi

​SHOW ENGINES

​Syntaxe

​Voir aussi

​SHOW FUNCTIONS

​Syntaxe

​Voir aussi

​SHOW MERGES

​Syntaxe

​Exemples

​SHOW CREATE MASKING POLICY

​Syntaxe

SHOW CREATE TABLE | DICTIONARY | VIEW | DATABASE

Syntaxe

SHOW DATABASES

Syntaxe

Exemples

Voir aussi

SHOW TABLES

Syntaxe

Exemples

Voir aussi

SHOW COLUMNS

Syntaxe

Exemples

Voir aussi

SHOW DICTIONARIES

Syntaxe

Exemples

SHOW INDEX

Syntaxe

Exemples

Voir aussi

SHOW PROCESSLIST

Syntaxe

SHOW GRANTS

Syntaxe

SHOW CREATE USER

Syntaxe

SHOW CREATE ROLE

Syntaxe

SHOW CREATE ROW POLICY

Syntaxe

SHOW CREATE QUOTA

Syntaxe

SHOW CREATE SETTINGS PROFILE

Syntaxe

SHOW USERS

Syntaxe

SHOW ROLES

Syntaxe

SHOW PROFILES

Syntaxe

SHOW POLICIES

Syntaxe

SHOW QUOTAS

Syntaxe

SHOW QUOTA

Syntaxe

SHOW ACCESS

Syntaxe

SHOW CLUSTER(S)

Syntaxe

Exemples

SHOW SETTINGS

Syntaxe

Clauses

Exemples

SHOW SETTING

Syntaxe

Voir aussi

SHOW FILESYSTEM CACHES

Exemples

Voir aussi

SHOW ENGINES

Syntaxe

Voir aussi

SHOW FUNCTIONS

Syntaxe

Voir aussi

SHOW MERGES

Syntaxe

Exemples

SHOW CREATE MASKING POLICY

Syntaxe