Autres fonctions - ClickHouse Documentation

La documentation de la fonction ci-dessous est générée à partir de la table système system.functions.

FQDN

Introduit dans : v20.1.0 Renvoie le nom de domaine pleinement qualifié du serveur ClickHouse. Syntaxe

FQDN()

Alias : fullHostName Arguments

Aucun.

Valeur renvoyée Renvoie le nom de domaine pleinement qualifié du serveur ClickHouse. String Exemples Exemple d’utilisation

Query

SELECT fqdn()

Response

┌─FQDN()──────────────────────────┐
│ clickhouse.us-east-2.internal │
└─────────────────────────────────┘

MACNumToString

Introduite dans : v1.1.0 Interprète un nombre UInt64 comme une adresse MAC au format big-endian. Renvoie l’adresse MAC correspondante au format AA:BB:CC:DD:EE:FF (nombres hexadécimaux séparés par des deux-points) sous forme de chaîne. Syntaxe

MACNumToString(num)

Arguments

num — nombre de type UInt64. UInt64

Valeur renvoyée Renvoie une adresse MAC au format AA:BB:CC:DD:EE:FF. String Exemples Exemple d’utilisation

Query

SELECT MACNumToString(149809441867716) AS mac_address;

Response

┌─mac_address───────┐
│ 88:00:11:22:33:44 │
└───────────────────┘

MACStringToNum

Introduite dans : v1.1.0 MACStringToNum est la fonction inverse de MACNumToString. Si l’adresse MAC a un format invalide, elle renvoie 0. Syntaxe

MACStringToNum(s)

Arguments

s — Chaîne d’adresse MAC. String

Valeur renvoyée Renvoie un nombre UInt64. UInt64 Exemples Exemple d’utilisation

Query

SELECT MACStringToNum('01:02:03:04:05:06') AS mac_numeric;

Response

1108152157446

MACStringToOUI

Introduit dans : v1.1.0 Étant donné une adresse MAC au format AA:BB:CC:DD:EE:FF (nombres hexadécimaux séparés par des deux-points), renvoie les trois premiers octets sous la forme d’un nombre UInt64. Si l’adresse MAC n’a pas un format valide, renvoie 0. Syntaxe

MACStringToOUI(s)

Arguments

s — adresse MAC sous forme de chaîne. String

Valeur renvoyée Les trois premiers octets, sous forme de nombre UInt64. UInt64 Exemples Exemple d’utilisation

Query

SELECT MACStringToOUI('00:50:56:12:34:56') AS oui;

Response

authenticatedUser

Introduite dans : v25.11.0 Si l’utilisateur de la session a été remplacé à l’aide de la commande EXECUTE AS, cette fonction renvoie le nom de l’utilisateur d’origine ayant servi à l’authentification et à la création de la session. Alias : authUser() Syntaxe

authenticatedUser()

Alias : authUser Arguments

Aucun.

Valeur renvoyée Le nom de l’utilisateur authentifié. String Exemples Exemple d’utilisation

Query

EXECUTE as u1;
            SELECT currentUser(), authenticatedUser();

Response

┌─currentUser()─┬─authenticatedUser()─┐
│ u1            │ default             │
└───────────────┴─────────────────────┘

bar

Introduit dans : v1.1.0 Génère un graphique en barres. Dessine une bande dont la largeur est proportionnelle à (x - min) et égale à width caractères lorsque x = max. La bande est dessinée avec une précision d’un huitième de caractère. Syntaxe

bar(x, min, max[, width])

Arguments

x — Taille à afficher. (U)Int* ou Float* ou Decimal
min — La valeur minimale. (U)Int* ou Float* ou Decimal
max — La valeur maximale. (U)Int* ou Float* ou Decimal
width — Facultatif. Largeur de la barre en caractères. La valeur par défaut est 80. const (U)Int* ou const Float* ou const Decimal

Valeur renvoyée Chaîne de caractères représentant une barre en art Unicode. String Exemples Exemple d’utilisation

Query

SELECT
toHour(EventTime) AS h,
count() AS c,
bar(c, 0, 600000, 20) AS bar
FROM test.hits
GROUP BY h
ORDER BY h ASC

Response

┌──h─┬──────c─┬─bar────────────────┐
│  0 │ 292907 │ █████████▋         │
│  1 │ 180563 │ ██████             │
│  2 │ 114861 │ ███▋               │
│  3 │  85069 │ ██▋                │
│  4 │  68543 │ ██▎                │
│  5 │  78116 │ ██▌                │
│  6 │ 113474 │ ███▋               │
│  7 │ 170678 │ █████▋             │
│  8 │ 278380 │ █████████▎         │
│  9 │ 391053 │ █████████████      │
│ 10 │ 457681 │ ███████████████▎   │
│ 11 │ 493667 │ ████████████████▍  │
│ 12 │ 509641 │ ████████████████▊  │
│ 13 │ 522947 │ █████████████████▍ │
│ 14 │ 539954 │ █████████████████▊ │
│ 15 │ 528460 │ █████████████████▌ │
│ 16 │ 539201 │ █████████████████▊ │
│ 17 │ 523539 │ █████████████████▍ │
│ 18 │ 506467 │ ████████████████▊  │
│ 19 │ 520915 │ █████████████████▎ │
│ 20 │ 521665 │ █████████████████▍ │
│ 21 │ 542078 │ ██████████████████ │
│ 22 │ 493642 │ ████████████████▍  │
│ 23 │ 400397 │ █████████████▎     │
└────┴────────┴────────────────────┘

blockNumber

Introduit dans : v1.1.0 Renvoie un numéro de séquence monotone croissant du bloc contenant la ligne. Le numéro de bloc renvoyé est mis à jour au mieux, c’est-à-dire qu’il peut ne pas être parfaitement exact. Syntaxe

blockNumber()

Arguments

Aucun.

Valeur renvoyée Numéro de séquence du bloc de données dans lequel se trouve la ligne. UInt64 Exemples Utilisation de base

Query

SELECT blockNumber()
FROM
(
    SELECT *
    FROM system.numbers
    LIMIT 10
) SETTINGS max_block_size = 2

Response

┌─blockNumber()─┐
│             7 │
│             7 │
└───────────────┘
┌─blockNumber()─┐
│             8 │
│             8 │
└───────────────┘
┌─blockNumber()─┐
│             9 │
│             9 │
└───────────────┘
┌─blockNumber()─┐
│            10 │
│            10 │
└───────────────┘
┌─blockNumber()─┐
│            11 │
│            11 │
└───────────────┘

blockSerializedSize

Introduit dans : v20.3.0 Renvoie la taille non compressée en octets d’un bloc de valeurs sur disque. Syntaxe

blockSerializedSize(x1[, x2[, ...]])

Arguments

x1[, x2, ...] — Nombre quelconque de valeurs dont on souhaite obtenir la taille non compressée du bloc. Any

Valeur renvoyée Renvoie le nombre d’octets qui seront écrits sur le disque pour un bloc de valeurs sans compression. UInt64 Exemples Exemple d’utilisation

Query

SELECT blockSerializedSize(maxState(1)) AS x;

Response

┌─x─┐
│ 2 │
└───┘

blockSize

Introduit dans : v1.1.0 Dans ClickHouse, les requêtes sont traitées par blocs (fragments). Cette fonction renvoie la taille (nombre de lignes) du bloc sur lequel elle est appelée. Syntaxe

blockSize()

Arguments

Aucun.

Valeur renvoyée Renvoyer le nombre de lignes du bloc actuel. UInt64 Exemples Exemple d’utilisation

Query

SELECT blockSize()
FROM system.numbers LIMIT 5

Response

┌─blockSize()─┐
│           5 │
│           5 │
│           5 │
│           5 │
│           5 │
└─────────────┘

buildId

Introduit dans : v20.5.0 Renvoie l’ID de build généré par un compilateur pour le binaire du serveur ClickHouse en cours d’exécution. Si elle est exécutée dans le contexte d’une table distribuée, cette fonction génère une colonne ordinaire avec des valeurs propres à chaque shard. Sinon, elle renvoie une valeur constante. Syntaxe

buildId()

Arguments

Aucun.

Valeur renvoyée Renvoie l’ID du build. String Exemples Exemple d’utilisation

Query

SELECT buildId()

Response

┌─buildId()────────────────────────────────┐
│ AB668BEF095FAA6BD26537F197AC2AF48A927FB4 │
└──────────────────────────────────────────┘

byteSize

Introduit dans : v21.1.0 Renvoie une estimation de la taille en octets non compressée de ses arguments en mémoire. Pour les arguments String, la fonction renvoie la longueur de la chaîne + 8 (longueur). Si la fonction comporte plusieurs arguments, elle additionne leurs tailles en octets. Syntaxe

byteSize(arg1[, arg2, ...])

Arguments

arg1[, arg2, ...] — Valeurs de n’importe quel type de données dont il faut estimer la taille non compressée, en octets. Any

Valeur renvoyée Renvoie une estimation de la taille en octets des arguments en mémoire. UInt64 Exemples Exemple d’utilisation

Query

SELECT byteSize('string')

Response

┌─byteSize('string')─┐
│                 15 │
└────────────────────┘

Arguments multiples

Query

SELECT byteSize(NULL, 1, 0.3, '')

Response

┌─byteSize(NULL, 1, 0.3, '')─┐
│                         19 │
└────────────────────────────┘

catboostEvaluate

Introduit dans : v22.9.0 Évalue un modèle CatBoost externe. CatBoost est une bibliothèque open-source de gradient boosting développée par Yandex pour le machine learning. Accepte un chemin vers un modèle CatBoost et des arguments du modèle (features). Prérequis

Compiler la bibliothèque d’évaluation CatBoost

Avant d’évaluer des modèles CatBoost, la bibliothèque libcatboostmodel.<so|dylib> doit être accessible. Consultez la documentation CatBoost pour savoir comment la compiler. Ensuite, indiquez le chemin vers libcatboostmodel.<so|dylib> dans la configuration de ClickHouse :

<clickhouse>
...
    <catboost_lib_path>/path/to/libcatboostmodel.so</catboost_lib_path>
...
</clickhouse>

Pour des raisons de sécurité et d’isolation, l’évaluation du modèle ne s’exécute pas dans le processus serveur, mais dans le processus clickhouse-library-bridge. Lors de la première exécution de catboostEvaluate(), le serveur démarre le processus clickhouse-library-bridge s’il n’est pas déjà en cours d’exécution. Les deux processus communiquent via une interface HTTP. Par défaut, le port 9012 est utilisé. Un autre port peut être spécifié comme suit - cela est utile si le port 9012 est déjà attribué à un autre service.

<library_bridge>
    <port>9019</port>
</library_bridge>

Entraîner un modèle catboost avec libcatboost

Consultez Training and applying models pour savoir comment entraîner des modèles catboost à partir d’un jeu de données d’entraînement. Syntaxe

catboostEvaluate(path_to_model, feature_1[, feature_2, ..., feature_n])

Arguments

path_to_model — Chemin vers le modèle CatBoost. const String
feature — Une ou plusieurs caractéristiques/arguments du modèle. Float*

Valeur renvoyée Renvoie le résultat de l’évaluation du modèle. Float64 Exemples catboostEvaluate

Query

SELECT catboostEvaluate('/root/occupy.bin', Temperature, Humidity, Light, CO2, HumidityRatio) AS prediction FROM occupancy LIMIT 1

Response

4.695691092573497

colorOKLABToSRGB

Introduit dans : v26.2.0 Convertit une couleur de l’espace colorimétrique perceptuel OKLab vers l’espace colorimétrique sRGB. La couleur d’entrée est spécifiée dans l’espace colorimétrique OKLab. Si les valeurs d’entrée sont en dehors des plages OKLab habituelles, le résultat est défini par l’implémentation. OKLab utilise trois composantes :

L : luminosité perceptuelle (généralement dans l’intervalle [0..1])
- a : axe d’opposition vert-rouge
- b : axe d’opposition bleu-jaune

Les composantes a et b ne sont théoriquement pas bornées, mais en pratique elles se situent entre -0.4 et 0.4. OKLab est conçu pour être perceptuellement uniforme tout en restant peu coûteux à calculer. La conversion est conçue pour être l’inverse de colorSRGBToOKLAB et se compose des étapes suivantes :

Conversion d’OKLab vers sRGB linéaire. 2) Conversion de sRGB linéaire vers sRGB encodé avec gamma.

L’argument gamma facultatif spécifie l’exposant utilisé lors de la conversion de sRGB linéaire vers des valeurs RGB encodées avec gamma. S’il n’est pas spécifié, une valeur gamma par défaut est utilisée pour garantir la cohérence avec colorSRGBToOKLAB. Pour plus d’informations sur l’espace colorimétrique OKLab et sa relation avec sRGB, consultez https://developer.mozilla.org/en-US/docs/Web/CSS/Reference/Values/color_value/oklab . Syntaxe

colorOKLABToSRGB(tuple [, gamma])

Arguments

tuple — Un tuple de trois valeurs numériques L, a, b, où L est compris dans l’intervalle [0...1]. Tuple(Float64, Float64, Float64)
gamma — Facultatif. L’exposant utilisé pour reconvertir le sRGB linéaire en sRGB en appliquant (x ^ (1 / gamma)) * 255 à chaque canal x. La valeur par défaut est 2.2. Float64

Valeur renvoyée Renvoie un tuple (R, G, B) représentant des valeurs de couleur sRGB. Tuple(Float64, Float64, Float64) Exemples Convertir OKLAB en sRGB (Float)

Query

SELECT colorOKLABToSRGB((0.4466, 0.0991, 0.44)) AS rgb;

Response

┌─rgb──────────────────────┐
│ (198.07056923258935,0,0) │
└──────────────────────────┘

Convertir OKLAB en sRGB (UInt8)

Query

WITH colorOKLABToSRGB((0.7, 0.1, 0.54)) AS t
SELECT tuple(toUInt8(t.1), toUInt8(t.2), toUInt8(t.3)) AS RGB;

Response

┌─RGB──────────┐
│ (255,0,0)    │
└──────────────┘

colorOKLCHToSRGB

Introduit dans : v25.7.0 Convertit une couleur de l’espace colorimétrique perceptuellement uniforme OKLCH vers l’espace colorimétrique sRGB familier. Si L est hors de la plage [0...1], si C est négatif, ou si H est hors de la plage [0...360], le résultat est défini par l’implémentation.

OKLCH est une version cylindrique de l’espace colorimétrique OKLab. Ses trois coordonnées sont L (la clarté dans la plage [0...1]), C (chroma >= 0) et H (teinte en degrés dans [0...360]). OKLab/OKLCH est conçu pour être perceptuellement uniforme tout en restant peu coûteux en calcul.

La conversion est l’inverse de colorSRGBToOKLCH :

D’OKLCH vers OKLab. 2) D’OKLab vers sRGB linéaire 3) De sRGB linéaire vers sRGB

Le second argument gamma est utilisé à la dernière étape. Pour voir des références de couleurs dans l’espace OKLCH ainsi que leur correspondance avec les couleurs sRGB, consultez https://oklch.com/. Syntaxe

colorOKLCHToSRGB(tuple [, gamma])

Arguments

tuple — Un tuple de trois valeurs numériques L, C, H, où L est dans l’intervalle [0...1], C >= 0 et H est dans l’intervalle [0...360]. Tuple(Float64, Float64, Float64)
gamma — Facultatif. L’exposant utilisé pour reconvertir le sRGB linéaire en sRGB en appliquant (x ^ (1 / gamma)) * 255 à chaque canal x. La valeur par défaut est 2.2. Float64

Valeur renvoyée Renvoie un tuple (R, G, B) représentant des valeurs de couleur sRGB. Tuple(Float64, Float64, Float64) Exemples Convertir OKLCH en sRGB

Query

SELECT colorOKLCHToSRGB((0.6, 0.12, 40)) AS rgb;

Response

┌─rgb───────────────────────────────────────────────────────┐
│ (186.02058688365264,100.68677189684993,71.67819977081575) │
└───────────────────────────────────────────────────────────┘

Convertir OKLCH en sRGB (UInt8)

Query

WITH colorOKLCHToSRGB((0.6, 0.12, 40)) AS t
SELECT tuple(toUInt8(t.1), toUInt8(t.2), toUInt8(t.3)) AS RGB;

Response

┌─RGB──────────┐
│ (186,100,71) │
└──────────────┘

colorSRGBToOKLAB

Introduit dans : v26.2.0 Convertit une couleur codée dans l’espace colorimétrique sRGB en espace colorimétrique OKLAB, perceptuellement uniforme. Si un canal d’entrée est en dehors de [0...255] ou si la valeur de gamma n’est pas positive, le comportement dépend de l’implémentation.

OKLAB est un espace colorimétrique perceptuellement uniforme. Ses trois coordonnées sont L (la clarté dans la plage [0...1]), a (Green-Red axis) et b (Blue-Yellow axis). OKLab est conçu pour être perceptuellement uniforme tout en restant peu coûteux en calcul.

La conversion se déroule en deux étapes :

sRGB vers sRGB linéaire 2) sRGB linéaire vers OKLab

Syntaxe

colorSRGBToOKLAB(tuple[, gamma])

Arguments

tuple — Tuple de trois valeurs R, G, B comprises dans l’intervalle [0...255]. Tuple(UInt8, UInt8, UInt8)
gamma — Facultatif. Exposant utilisé pour linéariser sRGB en appliquant (x / 255)^gamma à chaque canal x. La valeur par défaut est 2.2. Float64

Valeur renvoyée Renvoie un tuple (L, a, b) représentant les valeurs de l’espace colorimétrique OKLAB. Tuple(Float64, Float64, Float64) Exemples Convertir sRGB en OKLAB

Query

SELECT colorSRGBToOKLAB((128, 64, 32), 2.2) AS lab;

Response

┌─lab──────────────────────────────────────────────────────────┐
│ (0.4436238384931984,0.07266246769242975,0.07500108778529994) │
└──────────────────────────────────────────────────────────────┘

colorSRGBToOKLCH

Introduit dans : v25.7.0 Convertit une couleur encodée dans l’espace colorimétrique sRGB en espace colorimétrique OKLCH, perceptuellement uniforme. Si un canal d’entrée est hors de [0...255] ou si la valeur de gamma n’est pas positive, le comportement est défini par l’implémentation.

OKLCH est une version cylindrique de l’espace colorimétrique OKLab. Ses trois coordonnées sont L (la clarté dans l’intervalle [0...1]), C (la chroma >= 0) et H (la teinte, en degrés, dans [0...360]). OKLab/OKLCH est conçu pour être perceptuellement uniforme tout en restant peu coûteux en calcul.

La conversion se déroule en trois étapes :

sRGB vers sRGB linéaire 2) sRGB linéaire vers OKLab 3) OKLab vers OKLCH.

Pour obtenir des références de couleurs dans l’espace OKLCH et voir leur correspondance avec les couleurs sRGB, veuillez consulter https://OKLCH.com/. Syntaxe

colorSRGBToOKLCH(tuple[, gamma])

Arguments

tuple — Tuple de trois valeurs R, G, B comprises dans l’intervalle [0...255]. Tuple(UInt8, UInt8, UInt8)
gamma — Facultatif. Exposant utilisé pour linéariser sRGB en appliquant (x / 255)^gamma à chaque canal x. La valeur par défaut est 2.2. Float64

Valeur renvoyée Renvoie un tuple (L, C, H) représentant les valeurs dans l’espace colorimétrique OKLCH. Tuple(Float64, Float64, Float64) Exemples Convertir sRGB en OKLCH

Query

SELECT colorSRGBToOKLCH((128, 64, 32), 2.2) AS lch;

Response

┌─lch───────────────────────────────────────────────────────┐
│ (0.4436238384931984,0.1044269954567863,45.90734548193018) │
└───────────────────────────────────────────────────────────┘

connectionId

Introduit dans : v21.3.0 Renvoie l’identifiant de la connexion du client qui a soumis la requête en cours. Cette fonction est particulièrement utile dans les scénarios de débogage. Elle a été créée pour assurer la compatibilité avec la fonction CONNECTION_ID de MySQL. Elle n’est généralement pas utilisée dans les requêtes de production. Syntaxe

connectionId()

Arguments

Aucun.

Valeur renvoyée Renvoie l’ID de connexion du client courant. UInt64 Exemples Exemple d’utilisation

Query

SELECT connectionId();

Response

┌─connectionId()─┐
│              0 │
└────────────────┘

countDigits

Introduit dans : v20.8.0 Renvoyer le nombre de chiffres décimaux nécessaires pour représenter une valeur.

Cette fonction tient compte de l’échelle des valeurs décimales, c’est-à-dire qu’elle calcule le résultat à partir du type entier sous-jacent, soit (value * scale).Par exemple :

countDigits(42) = 2
countDigits(42.000) = 5
countDigits(0.04200) = 4

Vous pouvez vérifier le débordement de Decimal64 avec countDigits(x) > 18, bien que cela soit plus lent que isDecimalOverflow.

Syntaxe

countDigits(x)

Arguments

x — Une valeur entière ou décimale. (U)Int* ou Decimal

Valeur renvoyée Renvoie le nombre de chiffres nécessaires pour représenter x. UInt8 Exemples Exemple d’utilisation

Query

SELECT countDigits(toDecimal32(1, 9)), countDigits(toDecimal32(-1, 9)),
       countDigits(toDecimal64(1, 18)), countDigits(toDecimal64(-1, 18)),
       countDigits(toDecimal128(1, 38)), countDigits(toDecimal128(-1, 38));

Response

┌─countDigits(toDecimal32(1, 9))─┬─countDigits(toDecimal32(-1, 9))─┬─countDigits(toDecimal64(1, 18))─┬─countDigits(toDecimal64(-1, 18))─┬─countDigits(toDecimal128(1, 38))─┬─countDigits(toDecimal128(-1, 38))─┐
│                             10 │                              10 │                              19 │                               19 │                               39 │                                39 │
└────────────────────────────────┴─────────────────────────────────┴─────────────────────────────────┴──────────────────────────────────┴──────────────────────────────────┴───────────────────────────────────┘

currentDatabase

Introduit dans : v1.1.0 Renvoie le nom de la base de données courante. Utile dans les paramètres de moteur de table des requêtes CREATE TABLE, lorsque vous devez spécifier la base de données. Voir aussi l’instruction SET. Syntaxe

currentDatabase()

Alias : current_database, SCHEMA, DATABASE Arguments

Aucun.

Valeur renvoyée Renvoie le nom de la base de données courante. String Exemples Exemple d’utilisation

Query

SELECT currentDatabase()

Response

┌─currentDatabase()─┐
│ default           │
└───────────────────┘

Syntaxe SQL standard sans parenthèses

Query

SELECT CURRENT_DATABASE

Response

┌─CURRENT_DATABASE─┐
│ default          │
└──────────────────┘

currentProfiles

Introduit dans : v21.9.0 Renvoie un tableau des profils de paramètres de l’utilisateur courant. Syntaxe

currentProfiles()

Arguments

Aucun.

Valeur renvoyée Renvoie un tableau de profils de paramètres pour l’utilisateur courant. Array(String) Exemples Exemple d’utilisation

Query

SELECT currentProfiles();

Response

┌─currentProfiles()─────────────────────────────┐
│ ['default', 'readonly_user', 'web_analytics'] │
└───────────────────────────────────────────────┘

currentQueryID

Introduit dans : v25.2.0 Renvoie l’ID de la requête en cours. Syntaxe

currentQueryID()

Alias : current_query_id Arguments

Aucun argument.

Valeur renvoyée Exemples Exemple

Query

SELECT currentQueryID();

Response

┌─currentQueryID()─────────────────────┐
│ 1280d0e8-1a08-4524-be6e-77975bb68e7d │
└──────────────────────────────────────┘

currentRoles

Introduit dans : v21.9.0 Renvoie un Array contenant les rôles attribués à l’utilisateur courant. Syntaxe

currentRoles()

Arguments

Aucun.

Valeur renvoyée Renvoie un tableau contenant les rôles attribués à l’utilisateur courant. Array(String) Exemples Exemple d’utilisation

Query

SELECT currentRoles();

Response

┌─currentRoles()─────────────────────────────────┐
│ ['sql-console-role:jane.smith@clickhouse.com'] │
└────────────────────────────────────────────────┘

currentSchemas

Introduit dans : v23.7.0 Identique à la fonction currentDatabase, mais :

accepte un argument booléen qui est ignoré
renvoie le nom de la base de données dans un tableau ne contenant qu’une seule valeur.

La fonction currentSchemas n’existe que pour assurer la compatibilité avec PostgreSQL. Utilisez plutôt currentDatabase. Voir aussi l’instruction SET. Syntaxe

currentSchemas(bool)

Alias : current_schemas Arguments

bool — Une valeur booléenne, qui est ignorée. Bool

Valeur de retour Renvoie un tableau à un seul élément contenant le nom de la base de données courante. Array(String) Exemples Exemple d’utilisation

Query

SELECT currentSchemas(true)

Response

┌─currentSchemas(true)─┐
│ ['default']          │
└──────────────────────┘

currentUser

Introduit dans : v20.1.0 Renvoie le nom de l’utilisateur courant. Dans le cas d’une requête distribuée, le nom de l’utilisateur qui a initié la requête est renvoyé. Syntaxe

currentUser()

Alias : session_user, user, current_user Arguments

Aucun.

Valeur renvoyée Renvoie le nom de l’utilisateur courant ou, à défaut, l’identifiant de l’utilisateur qui a lancé la requête. String Exemples Exemple d’utilisation

Query

SELECT currentUser()

Response

┌─currentUser()─┐
│ default       │
└───────────────┘

Syntaxe SQL standard sans parenthèses

Query

SELECT CURRENT_USER

Response

┌─CURRENT_USER─┐
│ default      │
└──────────────┘

defaultProfiles

Introduit dans : v21.9.0 Renvoie un tableau contenant les noms des profils de paramètres par défaut de l’utilisateur courant. Syntaxe

defaultProfiles()

Arguments

Aucun.

Valeur renvoyée Renvoie un tableau contenant les noms des profils de paramètres par défaut de l’utilisateur courant. Array(String) Exemples Exemple d’utilisation

Query

SELECT defaultProfiles();

Response

┌─defaultProfiles()─┐
│ ['default']       │
└───────────────────┘

defaultRoles

Introduit dans : v21.9.0 Renvoie un tableau des rôles par défaut de l’utilisateur courant. Syntaxe

defaultRoles()

Arguments

Aucun.

Valeur renvoyée Renvoie un tableau des rôles par défaut de l’utilisateur courant. Array(String) Exemples Exemple d’utilisation

Query

SELECT defaultRoles();

Response

┌─defaultRoles()─────────────────────────────────┐
│ ['sql-console-role:jane.smith@clickhouse.com'] │
└────────────────────────────────────────────────┘

defaultValueOfArgumentType

Introduit dans : v1.1.0 Renvoie la valeur par défaut d’un type de données donné. N’inclut pas les valeurs par défaut des colonnes personnalisées définies par l’utilisateur. Syntaxe

defaultValueOfArgumentType(expression)

Arguments

expression — Valeur de type arbitraire ou expression produisant une valeur de type arbitraire. Any

Valeur renvoyée Renvoie 0 pour les nombres, une chaîne vide pour les chaînes de caractères ou NULL pour les types Nullable. UInt8 ou String ou NULL Exemples Exemple d’utilisation

Query

SELECT defaultValueOfArgumentType(CAST(1 AS Int8));

Response

┌─defaultValueOfArgumentType(CAST(1, 'Int8'))─┐
│                                           0 │
└─────────────────────────────────────────────┘

Exemple avec Nullable

Query

SELECT defaultValueOfArgumentType(CAST(1 AS Nullable(Int8)));

Response

┌─defaultValueOfArgumentType(CAST(1, 'Nullable(Int8)'))─┐
│                                                  ᴺᵁᴸᴸ │
└───────────────────────────────────────────────────────┘

defaultValueOfTypeName

Introduit dans : v1.1.0 Renvoie la valeur par défaut du nom de type donné. Syntaxe

defaultValueOfTypeName(type)

Arguments

type — Une chaîne représentant un nom de type. String

Valeur renvoyée Renvoie la valeur par défaut pour le nom de type donné : 0 pour les nombres, une chaîne vide pour les chaînes, ou NULL pour UInt8 Nullable, String ou NULL Exemples Exemple d’utilisation

Query

SELECT defaultValueOfTypeName('Int8');

Response

┌─defaultValueOfTypeName('Int8')─┐
│                              0 │
└────────────────────────────────┘

Exemple de Nullable

Query

SELECT defaultValueOfTypeName('Nullable(Int8)');

Response

┌─defaultValueOfTypeName('Nullable(Int8)')─┐
│                                     ᴺᵁᴸᴸ │
└──────────────────────────────────────────┘

displayName

Introduit dans : v22.11.0 Renvoie la valeur de display_name dans config ou, si elle n’est pas définie, le nom de domaine pleinement qualifié (FQDN) du serveur. Syntaxe

displayName()

Arguments

Aucun.

Valeur renvoyée Renvoie la valeur de display_name dans la config ou, si elle n’est pas définie, le FQDN du serveur. String Exemples Exemple d’utilisation

Query

SELECT displayName();

Response

┌─displayName()─┐
│ production    │
└───────────────┘

dumpColumnStructure

Introduit dans : v1.1.0 Affiche une description détaillée de la structure interne d’une colonne et de son type de données. Syntaxe

dumpColumnStructure(x)

Arguments

x — Valeur dont il faut obtenir la description. Any

Valeur renvoyée Renvoie une description de la structure de colonne servant à représenter la valeur. String Exemples Exemple d’utilisation

Query

SELECT dumpColumnStructure(CAST('2018-01-01 01:02:03', 'DateTime'));

Response

┌─dumpColumnStructure(CAST('2018-01-01 01:02:03', 'DateTime'))─┐
│ DateTime, Const(size = 1, UInt32(size = 1))                  │
└──────────────────────────────────────────────────────────────┘

enabledProfiles

Introduit dans : v21.9.0 Renvoie un tableau contenant les noms des profils de paramètres activés pour l’utilisateur courant. Syntaxe

enabledProfiles()

Arguments

Aucun.

Valeur renvoyée Renvoie un tableau contenant les noms des profils de paramètres activés pour l’utilisateur courant. Array(String) Exemples Exemple d’utilisation

Query

SELECT enabledProfiles();

Response

┌─enabledProfiles()─────────────────────────────────────────────────┐
│ ['default', 'readonly_user', 'web_analytics', 'batch_processing'] │
└───────────────────────────────────────────────────────────────────┘

enabledRoles

Introduit dans : v21.9.0 Renvoie un tableau des rôles activés pour l’utilisateur courant. Syntaxe

enabledRoles()

Arguments

Aucun.

Valeur renvoyée Renvoie un tableau contenant les noms des rôles activés pour l’utilisateur courant. Array(String) Exemples Exemple d’utilisation

Query

SELECT enabledRoles();

Response

┌─enabledRoles()─────────────────────────────────────────────────┐
│ ['general_data', 'sql-console-role:jane.smith@clickhouse.com'] │
└────────────────────────────────────────────────────────────────┘

errorCodeToName

Introduit dans : v20.12.0 Renvoyer le nom textuel d’un code d’erreur numérique ClickHouse. La correspondance entre les codes d’erreur numériques et les noms d’erreur est disponible ici. Syntaxe

errorCodeToName(error_code)

Arguments

error_code — Code d’erreur ClickHouse. (U)Int* ou Float* ou Decimal

Valeur renvoyée Renvoie le nom textuel de error_code. String Exemples Exemple d’utilisation

Query

SELECT errorCodeToName(252);

Response

┌─errorCodeToName(252)─┐
│ TOO_MANY_PARTS       │
└──────────────────────┘

file

Introduit dans : v21.3.0 Lit un fichier sous forme de chaîne de caractères et charge les données dans la colonne spécifiée. Le contenu du fichier n’est pas interprété. Voir aussi la fonction de table file. Syntaxe

file(path[, default])

Arguments

path — Le chemin du fichier par rapport à user_files_path. Prend en charge les caractères génériques *, **, ?, {abc,def} et {N..M}, où N et M sont des nombres et 'abc', 'def' des chaînes. String
default — La valeur renvoyée si le fichier n’existe pas ou n’est pas accessible. String ou NULL

Valeur renvoyée Renvoie le contenu du fichier sous forme de chaîne de caractères. String Exemples Insérer des fichiers dans une table

Query

INSERT INTO table SELECT file('a.txt'), file('b.txt');

Response

filesystemAvailable

Introduit dans : v20.1.0 Renvoie la quantité d’espace libre dans le système de fichiers qui héberge le stockage persistant de la base de données. La valeur renvoyée est toujours inférieure à l’espace libre total (filesystemUnreserved), car une partie de cet espace est réservée au système d’exploitation. Syntaxe

filesystemAvailable([disk_name])

Arguments

disk_name — Facultatif. Nom du disque dont il faut déterminer l’espace libre. S’il est omis, le disque par défaut est utilisé. String ou FixedString

Valeur renvoyée Renvoie l’espace libre restant en octets. UInt64 Exemples Exemple d’utilisation

Query

SELECT formatReadableSize(filesystemAvailable()) AS "Available space";

Response

┌─Available space─┐
│ 30.75 GiB       │
└─────────────────┘

filesystemCapacity

Introduit dans : v20.1.0 Renvoie la capacité du système de fichiers en octets. Nécessite que le path vers le répertoire de données soit configuré. Syntaxe

filesystemCapacity([disk_name])

Arguments

disk_name — Facultatif. Nom du disque dont il faut obtenir la capacité. S’il est omis, le disque par défaut est utilisé. String ou FixedString

Valeur renvoyée Renvoie la capacité du système de fichiers en octets. UInt64 Exemples Exemple d’utilisation

Query

SELECT formatReadableSize(filesystemCapacity()) AS "Capacity";

Response

┌─Capacity──┐
│ 39.32 GiB │
└───────────┘

filesystemUnreserved

Introduit dans : v22.12.0 Renvoie la quantité totale d’espace libre sur le système de fichiers qui héberge le stockage persistant de la base de données (anciennement filesystemFree). Voir aussi filesystemAvailable. Syntaxe

filesystemUnreserved([disk_name])

Arguments

disk_name — Facultatif. Nom du disque pour lequel trouver la quantité totale d’espace libre. S’il est omis, le disque default est utilisé. String ou FixedString

Valeur renvoyée Renvoie la quantité d’espace libre en octets. UInt64 Exemples Exemple d’utilisation

Query

SELECT formatReadableSize(filesystemUnreserved()) AS "Free space";

Response

┌─Free space─┐
│ 32.39 GiB  │
└────────────┘

finalizeAggregation

Introduit dans : v1.1.0 À partir d’un état d’agrégation, cette fonction renvoie le résultat de l’agrégation (ou l’état finalisé lorsqu’un combinateur -State est utilisé). Syntaxe

finalizeAggregation(state)

Arguments

state — État de l’agrégation. AggregateFunction

Valeur renvoyée Renvoie le résultat final de l’agrégation. Any Exemples Exemple d’utilisation

Query

SELECT finalizeAggregation(arrayReduce('maxState', [1, 2, 3]));

Response

┌─finalizeAggregation(arrayReduce('maxState', [1, 2, 3]))─┐
│                                                       3 │
└─────────────────────────────────────────────────────────┘

Combiné à initializeAggregation

Query

WITH initializeAggregation('sumState', number) AS one_row_sum_state
SELECT
    number,
    finalizeAggregation(one_row_sum_state) AS one_row_sum,
    runningAccumulate(one_row_sum_state) AS cumulative_sum
FROM numbers(5);

Response

┌─number─┬─one_row_sum─┬─cumulative_sum─┐
│      0 │           0 │              0 │
│      1 │           1 │              1 │
│      2 │           2 │              3 │
│      3 │           3 │              6 │
│      4 │           4 │             10 │
└────────┴─────────────┴────────────────┘

flipCoordinates

Introduite dans : v25.11.0 Inverse les coordonnées x et y des objets géométriques. Cette opération permute la latitude et la longitude, ce qui est utile pour passer d’un système de coordonnées à un autre ou corriger l’ordre des coordonnées. Pour un Point, elle permute les coordonnées x et y. Pour les géométries complexes (LineString, Polygon, MultiPolygon, Ring, MultiLineString), elle applique récursivement la transformation à chaque paire de coordonnées. La fonction prend en charge à la fois les types géométriques individuels (Point, Ring, Polygon, MultiPolygon, LineString, MultiLineString) et le type Variant Geometry. Syntaxe

flipCoordinates(geometry)

Arguments

geometry — Géométrie à transformer. Types pris en charge : Point (Tuple(Float64, Float64)), Ring (Array(Point)), Polygon (Array(Ring)), MultiPolygon (Array(Polygon)), LineString (Array(Point)), MultiLineString (Array(LineString)) ou Geometry (un variant contenant l’un de ces types).

Valeur renvoyée La géométrie dont les coordonnées sont permutées. Le type de retour correspond au type d’entrée. Point ou Ring ou Polygon ou MultiPolygon ou LineString ou MultiLineString ou Geometry Exemples basic_point

Query

SELECT flipCoordinates((1.0, 2.0));

Response

(2.0, 1.0)

anneau

Query

SELECT flipCoordinates([(1.0, 2.0), (3.0, 4.0)]);

Response

[(2.0, 1.0), (4.0, 3.0)]

polygone

Query

SELECT flipCoordinates([[(1.0, 2.0), (3.0, 4.0)], [(5.0, 6.0), (7.0, 8.0)]]);

Response

[[(2.0, 1.0), (4.0, 3.0)], [(6.0, 5.0), (8.0, 7.0)]]

geometry_wkt

Query

SELECT flipCoordinates(readWkt('POINT(10 20)'));

Response

(20, 10)

geometry_polygon_wkt

Query

SELECT flipCoordinates(readWkt('POLYGON((0 0, 5 0, 5 5, 0 5, 0 0))'));

Response

[[(0, 0), (0, 5), (5, 5), (5, 0), (0, 0)]]

formatQuery

Introduit dans : v23.10.0 Renvoie une version formatée, éventuellement sur plusieurs lignes, de la requête SQL fournie. Déclenche une erreur en cas d’erreur d’analyse syntaxique. [example:multiline] Syntaxe

formatQuery(query)

Arguments

query — La requête SQL à mettre en forme. String

Valeur renvoyée La requête mise en forme String Exemples multiligne

Query

SELECT formatQuery('select a,    b FRom tab WHERE a > 3 and  b < 3');

Response

SELECT
    a,
    b
FROM tab
WHERE (a > 3) AND (b < 3)

formatQueryOrNull

Introduit dans : v23.11.0 Renvoie une version formatée, éventuellement sur plusieurs lignes, de la requête SQL fournie. Renvoie NULL en cas d’erreur d’analyse syntaxique. [example:multiline] Syntaxe

formatQueryOrNull(query)

Arguments

query — La requête SQL à mettre en forme. String

Valeur renvoyée La requête mise en forme String Exemples multiligne

Query

SELECT formatQuery('select a,    b FRom tab WHERE a > 3 and  b < 3');

Response

SELECT
    a,
    b
FROM tab
WHERE (a > 3) AND (b < 3)

formatQuerySingleLine

Introduit dans : v23.10.0 Comme formatQuery(), mais la chaîne formatée renvoyée ne contient aucun saut de ligne. Lève une exception en cas d’erreur d’analyse syntaxique. [example:multiline] Syntaxe

formatQuerySingleLine(query)

Arguments

query — La requête SQL à formater. String

Valeur renvoyée La requête formatée String Exemples multiligne

Query

SELECT formatQuerySingleLine('select a,    b FRom tab WHERE a > 3 and  b < 3');

Response

SELECT a, b FROM tab WHERE (a > 3) AND (b < 3)

formatQuerySingleLineOrNull

Introduit dans : v23.11.0 Comme formatQuery(), mais la chaîne formatée renvoyée ne contient aucun saut de ligne. Renvoie NULL en cas d’erreur d’analyse syntaxique. [example:multiline] Syntaxe

formatQuerySingleLineOrNull(query)

Arguments

query — La requête SQL à formater. String

Valeur renvoyée La requête formatée String Exemples multiligne

Query

SELECT formatQuerySingleLine('select a,    b FRom tab WHERE a > 3 and  b < 3');

Response

SELECT a, b FROM tab WHERE (a > 3) AND (b < 3)

formatReadableDecimalSize

Introduit dans : v22.11.0 À partir d’une taille (nombre d’octets), cette fonction renvoie une taille lisible et arrondie avec un suffixe (KB, MB, etc.), sous forme de chaîne. Les opérations inverses de cette fonction sont parseReadableSize. Syntaxe

formatReadableDecimalSize(value[, precision])

Arguments

value — Taille en octets. Int8 ou Int16 ou Int32 ou Int64 ou UInt8 ou UInt16 ou UInt32 ou UInt64 ou Float32 ou Float64 ou Decimal
precision — Facultatif. Nombre de chiffres après la virgule. La valeur par défaut est 2. const UInt8

Valeur renvoyée Renvoie une taille lisible et arrondie avec un suffixe, sous forme de chaîne. String Exemples Formater les tailles de fichier

Query

SELECT
    arrayJoin([1, 1024, 1024*1024, 192851925]) AS filesize_bytes,
    formatReadableDecimalSize(filesize_bytes) AS filesize

Response

┌─filesize_bytes─┬─filesize───┐
│              1 │ 1.00 B     │
│           1024 │ 1.02 KB    │
│        1048576 │ 1.05 MB    │
│      192851925 │ 192.85 MB  │
└────────────────┴────────────┘

Avec une précision explicite

Query

SELECT
    formatReadableDecimalSize(192851925, 0) AS no_decimals,
    formatReadableDecimalSize(192851925, 4) AS four_decimals

Response

┌─no_decimals─┬─four_decimals─┐
│ 193 MB      │ 192.8519 MB   │
└─────────────┴───────────────┘

formatReadableQuantity

Introduit dans : v20.10.0 Étant donné un nombre, cette fonction renvoie une valeur arrondie avec un suffixe (mille, million, milliard, etc.) sous forme de chaîne. Cette fonction accepte en entrée n’importe quel type numérique, mais le convertit en interne en Float64. Les résultats peuvent être moins précis pour les grandes valeurs. Syntaxe

formatReadableQuantity(value[, precision])

Arguments

value — Un nombre à formater. Int8 ou Int16 ou Int32 ou Int64 ou UInt8 ou UInt16 ou UInt32 ou UInt64 ou Float32 ou Float64 ou Decimal
precision — Facultatif. Nombre de chiffres après le séparateur décimal. Valeur par défaut : 2. const UInt8

Valeur renvoyée Renvoie un nombre arrondi avec un suffixe, sous forme de chaîne. String Exemples Formater des nombres avec des suffixes

Query

SELECT
    arrayJoin([1024, 1234 * 1000, (4567 * 1000) * 1000, 98765432101234]) AS number,
    formatReadableQuantity(number) AS number_for_humans

Response

┌─────────number─┬─number_for_humans─┐
│           1024 │ 1.02 thousand     │
│        1234000 │ 1.23 million      │
│     4567000000 │ 4.57 billion      │
│ 98765432101234 │ 98.77 trillion    │
└────────────────┴───────────────────┘

Avec une précision définie

Query

SELECT
    formatReadableQuantity(98765432101234, 0) AS no_decimals,
    formatReadableQuantity(98765432101234, 4) AS four_decimals

Response

┌─no_decimals──┬─four_decimals─────┐
│ 99 trillion  │ 98.7654 trillion  │
└──────────────┴───────────────────┘

formatReadableSize

Introduit dans : v1.1.0 À partir d’une taille (nombre d’octets), cette fonction renvoie une taille lisible et arrondie avec un suffixe (KiB, MiB, etc.) sous forme de chaîne. Les opérations inverses de cette fonction sont parseReadableSize, parseReadableSizeOrZero et parseReadableSizeOrNull. Cette fonction accepte en entrée n’importe quel type numérique, mais les convertit en interne en Float64. Les résultats peuvent être moins précis avec de grandes valeurs. Syntaxe

formatReadableSize(value[, precision])

Alias : FORMAT_BYTES Arguments

value — Taille en octets. Int8 ou Int16 ou Int32 ou Int64 ou UInt8 ou UInt16 ou UInt32 ou UInt64 ou Float32 ou Float64 ou Decimal
precision — Facultatif. Nombre de chiffres après la virgule. La valeur par défaut est 2. const UInt8

Valeur renvoyée Renvoie une taille lisible et arrondie avec suffixe, sous forme de chaîne. String Exemples Formater les tailles de fichiers

Query

SELECT
    arrayJoin([1, 1024, 1024*1024, 192851925]) AS filesize_bytes,
    formatReadableSize(filesize_bytes) AS filesize

Response

┌─filesize_bytes─┬─filesize───┐
│              1 │ 1.00 B     │
│           1024 │ 1.00 KiB   │
│        1048576 │ 1.00 MiB   │
│      192851925 │ 183.92 MiB │
└────────────────┴────────────┘

Avec une précision définie explicitement

Query

SELECT
    formatReadableSize(192851925, 0) AS no_decimals,
    formatReadableSize(192851925, 4) AS four_decimals

Response

┌─no_decimals─┬─four_decimals──┐
│ 184 MiB     │ 183.9179 MiB   │
└─────────────┴────────────────┘

formatReadableTimeDelta

Introduit dans : v20.12.0 Étant donné un intervalle de temps (delta) en secondes ou une expression INTERVAL, cette fonction renvoie un delta temporel sous forme de chaîne, avec année/mois/jour/heure/minute/seconde/milliseconde/microseconde/nanoseconde. Cette fonction accepte n’importe quel type numérique en entrée, mais les convertit en interne en Float64. Les résultats peuvent être moins précis avec des valeurs élevées. Lorsqu’une expression INTERVAL est transmise, sa valeur est convertie en secondes. Les unités d’intervalle MONTH et supérieures (MONTH, QUARTER, YEAR) ne sont pas prises en charge, car elles ne représentent pas un intervalle de durée fixe en secondes. Syntaxe

formatReadableTimeDelta(column[, maximum_unit, minimum_unit])

Arguments

column — Une colonne contenant un écart de temps numérique, ou une expression INTERVAL. Les unités d’intervalle MONTH et supérieures ne sont pas prises en charge. Float64 ou Interval
maximum_unit — Facultatif. Unité maximale à afficher. Valeurs acceptables : nanoseconds, microseconds, milliseconds, seconds, minutes, hours, days, months, years. Valeur par défaut : years. const String
minimum_unit — Facultatif. Unité minimale à afficher. Toutes les unités plus petites sont tronquées. Valeurs acceptables : nanoseconds, microseconds, milliseconds, seconds, minutes, hours, days, months, years. Si la valeur explicitement spécifiée est supérieure à maximum_unit, une exception est levée. Valeur par défaut : seconds si maximum_unit vaut seconds ou une unité supérieure, nanoseconds sinon. const String

Valeur renvoyée Renvoie un écart de temps sous forme de chaîne. String Exemples Exemple d’utilisation

Query

SELECT
    arrayJoin([100, 12345, 432546534]) AS elapsed,
    formatReadableTimeDelta(elapsed) AS time_delta

Response

┌────elapsed─┬─time_delta─────────────────────────────────────────────────────┐
│        100 │ 1 minute and 40 seconds                                        │
│      12345 │ 3 hours, 25 minutes and 45 seconds                             │
│  432546534 │ 13 years, 8 months, 17 days, 7 hours, 48 minutes and 54 seconds│
└────────────┴────────────────────────────────────────────────────────────────┘

Avec l’unité la plus grande

Query

SELECT
    arrayJoin([100, 12345, 432546534]) AS elapsed,
    formatReadableTimeDelta(elapsed, 'minutes') AS time_delta

Response

┌────elapsed─┬─time_delta─────────────────────────────────────────────────────┐
│        100 │ 1 minute and 40 seconds                                         │
│      12345 │ 205 minutes and 45 seconds                                      │
│  432546534 │ 7209108 minutes and 54 seconds                                  │
└────────────┴─────────────────────────────────────────────────────────────────┘

Avec l’expression INTERVAL

Query

SELECT formatReadableTimeDelta(INTERVAL 12345 SECOND) AS time_delta

Response

┌─time_delta─────────────────────────┐
│ 3 hours, 25 minutes and 45 seconds │
└────────────────────────────────────┘

fuzzQuery

Introduite dans : v26.2.0 Analyse la chaîne de requête fournie et lui applique des mutations aléatoires de l’AST (fuzzing). Renvoie la requête modifiée sous forme de chaîne de caractères. Non déterministe : chaque appel peut produire un résultat différent. Nécessite allow_fuzz_query_functions = 1. Syntaxe

fuzzQuery(query)

Arguments

query — La requête SQL à soumettre au fuzzing. String

Valeur renvoyée La chaîne de requête fuzzée String Exemples simple

Query

SET allow_fuzz_query_functions = 1; SELECT fuzzQuery('SELECT 1');

Response

generateRandomStructure

Introduit dans : v23.5.0 Génère une structure de table aléatoire au format column1_name column1_type, column2_name column2_type, .... Syntaxe

generateRandomStructure([number_of_columns, seed])

Arguments

number_of_columns — Le nombre souhaité de colonnes dans la structure de table générée. S’il est défini sur 0 ou Null, le nombre de colonnes sera choisi aléatoirement entre 1 et 128. Valeur par défaut : Null. UInt64
seed — Graine aléatoire utilisée pour produire des résultats stables. Si la graine n’est pas spécifiée ou si elle est définie sur Null, elle est générée aléatoirement. UInt64

Valeur renvoyée Structure de table générée aléatoirement. String Exemples Exemple d’utilisation

Query

SELECT generateRandomStructure()

Response

c1 Decimal32(5), c2 Date, c3 Tuple(LowCardinality(String), Int128, UInt64, UInt16, UInt8, IPv6), c4 Array(UInt128), c5 UInt32, c6 IPv4, c7 Decimal256(64), c8 Decimal128(3), c9 UInt256, c10 UInt64, c11 DateTime

avec le nombre de colonnes indiqué

Query

SELECT generateRandomStructure(1)

Response

c1 Map(UInt256, UInt16)

avec la seed spécifiée

Query

SELECT generateRandomStructure(NULL, 33)

Response

c1 DateTime, c2 Enum8('c2V0' = 0, 'c2V1' = 1, 'c2V2' = 2, 'c2V3' = 3), c3 LowCardinality(Nullable(FixedString(30))), c4 Int16, c5 Enum8('c5V0' = 0, 'c5V1' = 1, 'c5V2' = 2, 'c5V3' = 3), c6 Nullable(UInt8), c7 String, c8 Nested(e1 IPv4, e2 UInt8, e3 UInt16, e4 UInt16, e5 Int32, e6 Map(Date, Decimal256(70)))

generateSerialID

Introduit dans : v25.1.0 Génère et renvoie des nombres séquentiels à partir de la valeur précédente du compteur. Cette fonction prend un argument de type String — un identifiant de série — ainsi qu’une valeur initiale facultative. Le serveur doit être configuré avec Keeper. Les séries sont stockées dans des nœuds Keeper sous le chemin, qui peut être configuré via series_keeper_path dans la configuration du serveur. Syntaxe

generateSerialID(series_identifier[, start_value])

Arguments

series_identifier — Identifiant de série const String
start_value — Facultatif. Valeur initiale du compteur. La valeur par défaut est 0. Remarque : cette valeur n’est utilisée que lors de la création d’une nouvelle série et est ignorée si la série existe déjà UInt*

Valeur renvoyée Renvoie des nombres séquentiels à partir de la valeur précédente du compteur. UInt64 Exemples premier appel

Query

SELECT generateSerialID('id1')

Response

┌─generateSerialID('id1')──┐
│                        1 │
└──────────────────────────┘

deuxième appel

Query

SELECT generateSerialID('id1')

Response

┌─generateSerialID('id1')──┐
│                        2 │
└──────────────────────────┘

appel de la colonne

Query

SELECT *, generateSerialID('id1') FROM test_table

Response

┌─CounterID─┬─UserID─┬─ver─┬─generateSerialID('id1')──┐
│         1 │      3 │   3 │                        3 │
│         1 │      1 │   1 │                        4 │
│         1 │      2 │   2 │                        5 │
│         1 │      5 │   5 │                        6 │
│         1 │      4 │   4 │                        7 │
└───────────┴────────┴─────┴──────────────────────────┘

avec une valeur initiale

Query

SELECT generateSerialID('id2', 100)

Response

┌─generateSerialID('id2', 100)──┐
│                           100 │
└───────────────────────────────┘

avec valeur initiale, deuxième appel

Query

SELECT generateSerialID('id2', 100)

Response

┌─generateSerialID('id2', 100)──┐
│                           101 │
└───────────────────────────────┘

getClientHTTPHeader

Introduit dans : v24.5.0 Renvoie la valeur d’un en-tête HTTP. S’il n’existe pas d’en-tête de ce type ou si la requête actuelle n’est pas effectuée via l’interface HTTP, la fonction renvoie une chaîne vide. Certains en-têtes HTTP (par ex. Authentication et X-ClickHouse-*) sont soumis à des restrictions.

Le paramètre allow_get_client_http_header est requisLa fonction nécessite que le paramètre allow_get_client_http_header soit activé. Ce paramètre n’est pas activé par défaut pour des raisons de sécurité, car certains en-têtes, tels que Cookie, peuvent contenir des informations sensibles.

Pour cette fonction, les en-têtes HTTP sont sensibles à la casse. Si la fonction est utilisée dans le contexte d’une requête distribuée, elle ne renvoie un résultat non vide que sur le nœud initiateur. Syntaxe

getClientHTTPHeader(name)

Arguments

name — Le nom de l’en-tête HTTP. String

Valeur renvoyée Renvoie la valeur de l’en-tête. String Exemples Exemple d’utilisation

Query

SELECT getClientHTTPHeader('Content-Type');

Response

┌─getClientHTTPHeader('Content-Type')─┐
│ application/x-www-form-urlencoded   │
└─────────────────────────────────────┘

getMacro

Introduit dans : v20.1.0 Renvoie la valeur d’une macro du fichier de configuration du serveur. Les macros sont définies dans la section <macros> du fichier de configuration et peuvent être utilisées pour distinguer les serveurs à l’aide de noms explicites, même si leurs noms d’hôte sont complexes. Si la fonction est exécutée dans le contexte d’une table distribuée, elle génère une colonne normale avec des valeurs correspondant à chaque fragment. Syntaxe

getMacro(name)

Arguments

name — Le nom de la macro à récupérer. const String

Valeur renvoyée Renvoie la valeur de la macro spécifiée. String Exemples Utilisation de base

Query

SELECT getMacro('test');

Response

┌─getMacro('test')─┐
│ Value            │
└──────────────────┘

getMaxTableNameLengthForDatabase

Introduit dans : v25.1.0 Renvoie la longueur maximale d’un nom de table dans une base de données donnée. Syntaxe

getMaxTableNameLengthForDatabase(database_name)

Arguments

database_name — Nom de la base de données spécifiée. String

Valeur renvoyée Renvoie la longueur maximale d’un nom de table, sous forme d’entier Exemples type

Query

SELECT getMaxTableNameLengthForDatabase('default');

Response

┌─getMaxTableNameLengthForDatabase('default')─┐
            │                                         206 │
            └─────────────────────────────────────────────┘

getMergeTreeSetting

Introduit dans : v25.6.0 Renvoie la valeur actuelle d’un paramètre MergeTree. Syntaxe

getMergeTreeSetting(setting_name)

Arguments

setting_name — Nom du paramètre. String

Valeur renvoyée Renvoie la valeur actuelle du paramètre MergeTree. Exemples Exemple d’utilisation

Query

SELECT getMergeTreeSetting('index_granularity');

Response

┌─getMergeTreeSetting('index_granularity')─┐
│                                     8192 │
└──────────────────────────────────────────┘

getOSKernelVersion

Introduit dans : v21.11.0 Renvoie une chaîne de caractères contenant la version du noyau du système d’exploitation. Syntaxe

getOSKernelVersion()

Arguments

Aucun.

Valeur renvoyée Renvoie la version actuelle du noyau du système d’exploitation. String Exemples Exemple d’utilisation

Query

SELECT getOSKernelVersion();

Response

┌─getOSKernelVersion()────┐
│ Linux 4.15.0-55-generic │
└─────────────────────────┘

getServerPort

Introduit dans : v21.10.0 Renvoie le numéro de port du serveur pour un protocole donné. Syntaxe

getServerPort(port_name)

Arguments

port_name — Le nom du port. String

Valeur renvoyée Renvoie le numéro de port du serveur. UInt16 Exemples Exemple d’utilisation

Query

SELECT getServerPort('tcp_port');

Response

┌─getServerPort('tcp_port')─┐
│                      9000 │
└───────────────────────────┘

getServerSetting

Introduit dans : v25.6.0 Renvoie la valeur actuellement définie pour le paramètre serveur indiqué. Syntaxe

getServerSetting(setting_name')

Arguments

setting_name — Le nom du paramètre du serveur. String

Valeur renvoyée Renvoie la valeur actuelle du paramètre du serveur. Any Exemples Exemple d’utilisation

Query

SELECT getServerSetting('allow_use_jemalloc_memory');

Response

┌─getServerSetting('allow_use_jemalloc_memory')─┐
│ true                                          │
└───────────────────────────────────────────────┘

getSetting

Introduit dans : v20.7.0 Renvoie la valeur actuelle d’un paramètre. Syntaxe

getSetting(setting_name)

Arguments

setting_Name — Le nom du paramètre. const String

Valeur renvoyée Renvoie la valeur actuelle du paramètre. Any Exemples Exemple d’utilisation

Query

SELECT getSetting('enable_analyzer');
SET enable_analyzer = false;
SELECT getSetting('enable_analyzer');

Response

┌─getSetting('⋯_analyzer')─┐
│ true                     │
└──────────────────────────┘
┌─getSetting('⋯_analyzer')─┐
│ false                    │
└──────────────────────────┘

getSettingOrDefault

Introduit dans : v24.10.0 Renvoie la valeur actuelle d’un paramètre, ou la valeur par défaut spécifiée dans le deuxième argument si le paramètre n’est pas défini dans le profil actuel. Syntaxe

getSettingOrDefault(setting_name, default_value)

Arguments

setting_name — Le nom du paramètre. String
default_value — Valeur à renvoyer si custom_setting n’est pas défini. La valeur peut être de n’importe quel type de données ou de NULL.

Valeur renvoyée Renvoie la valeur actuelle du paramètre spécifié ou default_value si le paramètre n’est pas défini. Exemples Exemple d’utilisation

Query

SELECT getSettingOrDefault('custom_undef1', 'my_value');
SELECT getSettingOrDefault('custom_undef2', 100);
SELECT getSettingOrDefault('custom_undef3', NULL);

Response

my_value
100
NULL

getSizeOfEnumType

Introduit dans : v1.1.0 Renvoie le nombre de champs de l’Enum donné. Syntaxe

getSizeOfEnumType(x)

Arguments

x — Valeur de type Enum. Enum

Valeur renvoyée Renvoie le nombre de champs dont les valeurs d’entrée sont de type Enum. UInt8/16 Exemples Exemple d’utilisation

Query

SELECT getSizeOfEnumType(CAST('a' AS Enum8('a' = 1, 'b' = 2))) AS x;

Response

┌─x─┐
│ 2 │
└───┘

getSubcolumn

Introduit dans : v23.3.0 Reçoit l’expression ou l’identifiant, ainsi qu’une chaîne constante contenant le nom de la sous-colonne. Renvoie la sous-colonne demandée extraite de l’expression. Syntaxe

getSubcolumn(nested_value, subcolumn_name)

Arguments

Aucun.

Valeur renvoyée Exemples getSubcolumn

Query

SELECT getSubcolumn(array_col, 'size0'), getSubcolumn(tuple_col, 'elem_name')

Response

getTypeSerializationStreams

Introduit dans : v22.6.0 Répertorie les chemins des flux de sérialisation d’un type de données. Cette fonction est destinée à un usage de développement. Syntaxe

getTypeSerializationStreams(col)

Arguments

col — Colonne ou représentation sous forme de chaîne d’un type de données à partir de laquelle le type de données sera détecté. Any

Valeur renvoyée Renvoie un tableau contenant tous les chemins des sous-flux de sérialisation. Array(String) Exemples tuple

Query

SELECT getTypeSerializationStreams(tuple('a', 1, 'b', 2))

Response

['{TupleElement(1), Regular}','{TupleElement(2), Regular}','{TupleElement(3), Regular}','{TupleElement(4), Regular}']

map

Query

SELECT getTypeSerializationStreams('Map(String, Int64)')

Response

['{ArraySizes}','{ArrayElements, TupleElement(keys), Regular}','{ArrayElements, TupleElement(values), Regular}']

globalVariable

Introduit dans : v20.5.0 Prend un argument String constant et renvoie la valeur de la variable globale portant ce nom. Cette fonction est destinée à assurer la compatibilité avec MySQL et n’est ni nécessaire ni utile au fonctionnement normal de ClickHouse. Seules quelques variables globales factices sont définies. Syntaxe

globalVariable(name)

Arguments

name — Nom de variable globale. String

Valeur renvoyée Renvoie la valeur de la variable name. Any Exemples globalVariable

Query

SELECT globalVariable('max_allowed_packet')

Response

67108864

hasColumnInTable

Introduit dans : v1.1.0 Vérifie si une colonne spécifique existe dans une table d’une base de données. Pour les éléments d’une structure de données imbriquée, la fonction vérifie l’existence d’une colonne. Pour la structure de données imbriquée elle-même, la fonction renvoie 0. Syntaxe

hasColumnInTable([hostname[, username[, password]],]database, table, column)

Arguments

database — Nom de la base de données. const String
table — Nom de la table. const String
column — Nom de la colonne. const String
hostname — Facultatif. Nom du serveur distant sur lequel effectuer la vérification. const String
username — Facultatif. Nom d’utilisateur du serveur distant. const String
password — Facultatif. Mot de passe du serveur distant. const String

Valeur renvoyée Renvoie 1 si la colonne indiquée existe, 0 sinon. UInt8 Exemples Vérifier l’existence d’une colonne

Query

SELECT hasColumnInTable('system','metrics','metric')

Response

Vérifier une colonne qui n’existe pas

Query

SELECT hasColumnInTable('system','metrics','non-existing_column')

Response

hasThreadFuzzer

Introduit dans : v20.6.0 Indique si le thread fuzzer est activé. Cette fonction n’est utile que pour les tests et le débogage. Syntaxe

hasThreadFuzzer()

Arguments

Aucun.

Valeur renvoyée Indique si le Thread Fuzzer est actif. UInt8 Exemples Vérifier le statut du Thread Fuzzer

Query

SELECT hasThreadFuzzer()

Response

┌─hasThreadFuzzer()─┐
│                 0 │
└───────────────────┘

highlightQuery

Introduit dans : v26.5.0 Analyse une chaîne de requête SQL ClickHouse et renvoie un tableau de plages mises en surbrillance pour la coloration syntaxique. Chaque plage est un tuple nommé contenant la position de début (en octets), la position de fin et le type de surbrillance. Les types de surbrillance décrivent le rôle syntaxique du fragment (mot-clé, identifiant, fonction, etc.) et peuvent être utilisés pour attribuer des couleurs dans une UI. Dans les motifs de chaîne LIKE et REGEXP, les métacaractères et les caractères d’échappement sont mis en surbrillance séparément. Syntaxe

highlightQuery(query)

Arguments

query — Une chaîne de requête SQL ClickHouse. String.

Valeur renvoyée Un tableau de tuples nommés (begin UInt64, end UInt64, type Enum8(...)) représentant des plages mises en évidence. Array(Tuple(begin UInt64, end UInt64, type Enum8(...))) Exemples simple

Query

SELECT highlightQuery('SELECT 1')

Response

[(0,6,'keyword'),(7,8,'number')]

hostName

Introduit dans : v20.5.0 Renvoie le nom de l’hôte sur lequel cette fonction a été exécutée. Si la fonction s’exécute sur un serveur distant (traitement distribué), le nom du serveur distant est renvoyé. Si la fonction s’exécute dans le contexte d’une table distribuée, elle génère une colonne normale avec des valeurs correspondant à chaque shard. Sinon, elle produit une valeur constante. Syntaxe

hostName()

Alias : hostname Arguments

Aucun.

Valeur renvoyée Renvoie le nom d’hôte. String Exemples Exemple d’utilisation

Query

SELECT hostName()

Response

┌─hostName()─┐
│ clickhouse │
└────────────┘

icebergBucket

Introduit dans : v25.5.0 Implémente la logique de la transformation bucket d’Iceberg Syntaxe

icebergBucket(N, value)

Arguments

N — Le nombre de buckets (modulo). const (U)Int*
value — La valeur source à transformer. (U)Int* ou Bool ou Decimal ou Float* ou String ou FixedString ou UUID ou Date ou Time ou DateTime

Valeur renvoyée Renvoie un hachage de 32 bits de la valeur source. Int32 Exemples Exemple

Query

SELECT icebergBucket(5, 1.0 :: Float32)

Response

icebergTruncate

Introduit dans : v25.3.0 Implémente la logique de la transformation TRUNCATE d’Iceberg : https://iceberg.apache.org/spec/#truncate-transform-details. Syntaxe

icebergTruncate(N, value)

Arguments

value — La valeur à convertir. String ou (U)Int* ou Decimal

Valeur renvoyée Le même type que l’argument Exemples Exemple

Query

SELECT icebergTruncate(3, 'iceberg')

Response

ice

identity

Introduit dans : v1.1.0 Cette fonction renvoie l’argument que vous lui passez, ce qui est utile pour le débogage et les tests. Elle vous permet de contourner l’utilisation des index afin d’observer à la place les performances d’un parcours complet. L’analyseur de requêtes ignore tout ce qui se trouve à l’intérieur des fonctions identity lorsqu’il recherche les index à utiliser, et désactive également le constant folding. Syntaxe

identity(x)

Arguments

x — Valeur d’entrée. Any

Valeur renvoyée Renvoie la valeur d’entrée inchangée. Any Exemples Exemple d’utilisation

Query

SELECT identity(42)

Response

ignore

Introduit dans : v1.1.0 Accepte n’importe quels arguments et renvoie toujours 0. Syntaxe

ignore(x)

Arguments

x — Une valeur d’entrée non utilisée, transmise uniquement pour éviter une erreur de syntaxe. Any

Valeur renvoyée Renvoie toujours 0. UInt8 Exemples Exemple d’utilisation

Query

SELECT ignore(0, 'ClickHouse', NULL)

Response

┌─ignore(0, 'ClickHouse', NULL)─┐
│                             0 │
└───────────────────────────────┘

indexHint

Introduit dans : v1.1.0 Cette fonction est destinée au débogage et à l’introspection. Elle ignore son argument et renvoie toujours 1. Les arguments ne sont pas évalués. Lors de l’analyse de l’index, on suppose que l’argument de cette fonction n’est pas encapsulé dans indexHint. Cela vous permet de sélectionner des données dans des plages d’index à l’aide de la condition correspondante, mais sans filtrage supplémentaire sur cette condition. L’index de ClickHouse est sparse, et l’utilisation de indexHint renverra plus de données que si vous spécifiez directement la même condition.

Explication

Lorsque vous exécutez :

SELECT * FROM test WHERE key = 123;

ClickHouse effectue deux opérations :

Il utilise l’index pour trouver quelles granules (blocs d’environ 8192 lignes) peuvent contenir key = 123
Il lit ces granules et les filtre ligne par ligne pour ne renvoyer que les lignes où key = 123

Ainsi, même s’il lit 8 192 lignes sur disque, il ne renvoie que l’unique ligne qui correspond réellement.Avec indexHint, lorsque vous exécutez :

SELECT * FROM test WHERE indexHint(key = 123);

ClickHouse n’effectue qu’une seule opération :

Il utilise l’index pour trouver quelles granules peuvent contenir key = 123 et renvoie toutes les lignes de ces granules sans les filtrer.

Il renvoie les 8 192 lignes, y compris les lignes où key = 456, key = 789, etc. (Autrement dit, tout ce qui se trouvait stocké dans la même granule.) indexHint() n’est pas fait pour améliorer les performances. Il sert au débogage et à comprendre comment fonctionne l’index de ClickHouse :

Quelles granules ma condition sélectionne-t-elle ?
Combien de lignes y a-t-il dans ces granules ?
Mon index est-il utilisé efficacement ?

Remarque : il n’est pas possible d’optimiser une requête avec la fonction indexHint. La fonction indexHint n’optimise pas la requête, car elle ne fournit aucune information supplémentaire pour l’analyse de la requête. Mettre une expression à l’intérieur de la fonction indexHint n’est en aucun cas préférable à ne pas utiliser la fonction indexHint. La fonction indexHint ne peut être utilisée qu’à des fins d’introspection et de débogage, et n’améliore pas les performances. Si vous voyez indexHint utilisé par quelqu’un d’autre que les contributeurs de ClickHouse, il s’agit probablement d’une erreur et vous devriez le supprimer. Syntaxe

indexHint(expression)

Arguments

expression — Toute expression utilisée pour la sélection de plages d’index. Expression

Valeur renvoyée Renvoie 1 dans tous les cas. UInt8 Exemples Exemple d’utilisation avec filtrage sur la date

Query

SELECT FlightDate AS k, count() FROM ontime WHERE indexHint(k = '2025-09-15') GROUP BY k ORDER BY k ASC;

Response

┌──────────k─┬─count()─┐
│ 2025-09-14 │    7071 │
│ 2025-09-15 │   16428 │
│ 2025-09-16 │    1077 │
│ 2025-09-30 │    8167 │
└────────────┴─────────┘

initialQueryID

Introduit dans : v1.1.0 Renvoie l’ID de la requête initiale en cours. D’autres paramètres d’une requête peuvent être extraits du champ initial_query_id de system.query_log. Contrairement à la fonction queryID, initialQueryID renvoie les mêmes résultats sur différents shards. Syntaxe

initialQueryID()

Alias : initial_query_id Arguments

Aucun.

Valeur renvoyée Renvoie l’ID de la requête initiale. String Exemples Exemple d’utilisation

Query

CREATE TABLE tmp (str String) ENGINE = Log;
INSERT INTO tmp (*) VALUES ('a');
SELECT count(DISTINCT t) FROM (SELECT initialQueryID() AS t FROM remote('127.0.0.{1..3}', currentDatabase(), 'tmp') GROUP BY queryID());

Response

┌─count(DISTINCT t)─┐
│                 1 │
└───────────────────┘

initialQueryStartTime

Introduit dans : v25.4.0 Renvoie l’heure de début de la requête initiale en cours. initialQueryStartTime renvoie les mêmes résultats sur différents shards. Syntaxe

initialQueryStartTime()

Alias : initial_query_start_time Arguments

Aucun.

Valeur renvoyée Renvoie l’heure de début de la requête initiale en cours. DateTime Exemples Exemple d’utilisation

Query

CREATE TABLE tmp (str String) ENGINE = Log;
INSERT INTO tmp (*) VALUES ('a');
SELECT count(DISTINCT t) FROM (SELECT initialQueryStartTime() AS t FROM remote('127.0.0.{1..3}', currentDatabase(), 'tmp') GROUP BY queryID());

Response

┌─count(DISTINCT t)─┐
│                 1 │
└───────────────────┘

initializeAggregation

Introduit dans : v20.6.0 Calcule le résultat d’une fonction d’agrégation à partir d’une valeur unique. Cette fonction peut être utilisée pour initialiser des fonctions d’agrégation avec le combinateur -State. Vous pouvez créer des états de fonctions d’agrégation et les insérer dans des colonnes de type AggregateFunction, ou utiliser des agrégats initialisés comme valeurs par défaut. Syntaxe

initializeAggregation(aggregate_function, arg1[, arg2, ...])

Arguments

aggregate_function — Nom de la fonction d’agrégation à initialiser. String
arg1[, arg2, ...] — Arguments de la fonction d’agrégation. Any

Valeur renvoyée Renvoie le résultat de l’agrégation pour chaque ligne transmise à la fonction. Le type de retour est le même que celui de la fonction dont initializeAggregation prend le premier argument. Any Exemples Utilisation de base avec uniqState

Query

SELECT uniqMerge(state) FROM (SELECT initializeAggregation('uniqState', number % 3) AS state FROM numbers(10000));

Response

┌─uniqMerge(state)─┐
│                3 │
└──────────────────┘

Utilisation de sumState et de finalizeAggregation

Query

SELECT finalizeAggregation(state), toTypeName(state) FROM (SELECT initializeAggregation('sumState', number % 3) AS state FROM numbers(5));

Response

┌─finalizeAggregation(state)─┬─toTypeName(state)─────────────┐
│                          0 │ AggregateFunction(sum, UInt8) │
│                          1 │ AggregateFunction(sum, UInt8) │
│                          2 │ AggregateFunction(sum, UInt8) │
│                          0 │ AggregateFunction(sum, UInt8) │
│                          1 │ AggregateFunction(sum, UInt8) │
└────────────────────────────┴───────────────────────────────┘

isConstant

Introduit dans : v20.3.0 Indique si l’argument est une expression constante. Une expression constante est une expression dont le résultat est connu lors de l’analyse de la requête, c’est-à-dire avant l’exécution. Par exemple, les expressions construites à partir de littéraux sont des expressions constantes. Cette fonction est principalement destinée au développement, au débogage et à la démonstration. Syntaxe

isConstant(x)

Arguments

x — Une expression à vérifier. Any

Valeur renvoyée Renvoie 1 si x est constante, 0 si x ne l’est pas. UInt8 Exemples Expression constante

Query

SELECT isConstant(x + 1)
FROM (SELECT 43 AS x)

Response

┌─isConstant(plus(x, 1))─┐
│                      1 │
└────────────────────────┘

Constante avec une fonction

Query

WITH 3.14 AS pi
SELECT isConstant(cos(pi))

Response

┌─isConstant(cos(pi))─┐
│                   1 │
└─────────────────────┘

Expression non constante

Query

SELECT isConstant(number)
FROM numbers(1)

Response

┌─isConstant(number)─┐
│                  0 │
└────────────────────┘

Comportement de la fonction now()

Query

SELECT isConstant(now())

Response

┌─isConstant(now())─┐
│                 1 │
└───────────────────┘

isDecimalOverflow

Introduit dans : v20.8.0 Vérifie si un nombre décimal comporte trop de chiffres pour être correctement représenté dans un type de données Decimal avec la précision donnée. Syntaxe

isDecimalOverflow(value[, precision])

Arguments

value — Valeur Decimal à vérifier. Decimal
precision — Facultatif. Précision du type Decimal. Si elle est omise, la précision initiale du premier argument est utilisée. UInt8

Valeur renvoyée Renvoie 1 si la valeur décimale comporte plus de chiffres que n’en autorise sa précision, 0 si la valeur décimale respecte la précision spécifiée. UInt8 Exemples Exemple d’utilisation

Query

SELECT isDecimalOverflow(toDecimal32(1000000000, 0), 9),
       isDecimalOverflow(toDecimal32(1000000000, 0)),
       isDecimalOverflow(toDecimal32(-1000000000, 0), 9),
       isDecimalOverflow(toDecimal32(-1000000000, 0));

Response

┌─isDecimalOverflow(toDecimal32(1000000000, 0), 9)─┬─isDecimalOverflow(toDecimal32(1000000000, 0))─┬─isDecimalOverflow(toDecimal32(-1000000000, 0), 9)─┬─isDecimalOverflow(toDecimal32(-1000000000, 0))─┐
│                                                1 │                                             1 │                                                 1 │                                              1 │
└──────────────────────────────────────────────────┴───────────────────────────────────────────────┴───────────────────────────────────────────────────┴────────────────────────────────────────────────┘

joinGet

Introduit dans : v18.16.0 Permet d’extraire des données d’une table de la même manière que depuis un dictionnaire. Récupère des données à partir de tables Join à l’aide de la clé de jointure spécifiée.

Prend uniquement en charge les tables créées avec l’ENGINE = Join(ANY, LEFT, <join_keys>) instruction.

Syntaxe

joinGet(join_storage_table_name, value_column, join_keys)

Arguments

join_storage_table_name — Un identifiant qui indique où rechercher. L’identifiant est recherché dans la base de données default (voir le paramètre default_database dans le fichier de configuration). Pour remplacer la base de données par défaut, utilisez la requête USE database_name ou précisez la base de données et la table en les séparant par un point, comme database_name.table_name. String
value_column — Le nom de la colonne de la table qui contient les données requises. const String
join_keys — Une liste de clés de jointure. Any

Valeur renvoyée Renvoie une liste de valeurs correspondant à la liste des clés. Any Exemples Exemple d’utilisation

Query

CREATE TABLE db_test.id_val(`id` UInt32, `val` UInt32) ENGINE = Join(ANY, LEFT, id);
INSERT INTO db_test.id_val VALUES (1,11)(2,12)(4,13);

SELECT joinGet(db_test.id_val, 'val', toUInt32(1));

Response

┌─joinGet(db_test.id_val, 'val', toUInt32(1))─┐
│                                          11 │
└─────────────────────────────────────────────┘

Utilisation avec une table de la base de données courante

Query

USE db_test;
SELECT joinGet(id_val, 'val', toUInt32(2));

Response

┌─joinGet(id_val, 'val', toUInt32(2))─┐
│                                  12 │
└─────────────────────────────────────┘

Utiliser des tableaux comme clés de jointure

Query

CREATE TABLE some_table (id1 UInt32, id2 UInt32, name String) ENGINE = Join(ANY, LEFT, id1, id2);
INSERT INTO some_table VALUES (1, 11, 'a') (2, 12, 'b') (3, 13, 'c');

SELECT joinGet(some_table, 'name', 1, 11);

Response

┌─joinGet(some_table, 'name', 1, 11)─┐
│ a                                  │
└────────────────────────────────────┘

joinGetOrNull

Introduit dans : v20.4.0 Permet d’extraire des données d’une table de la même manière que depuis un dictionnaire. Récupère des données depuis des tables Join à l’aide de la clé de jointure spécifiée. Contrairement à joinGet, renvoie NULL lorsque la clé est absente.

Prend uniquement en charge les tables créées avec l’instruction ENGINE = Join(ANY, LEFT, <join_keys>).

Syntaxe

joinGetOrNull(join_storage_table_name, value_column, join_keys)

Arguments

join_storage_table_name — Un identifiant qui indique où effectuer la recherche. L’identifiant est recherché dans la base de données default (voir le paramètre default_database dans le fichier de configuration). Pour remplacer la base de données par défaut, utilisez la requête USE database_name ou indiquez la base de données et la table en les séparant par un point, comme database_name.table_name. String
value_column — Le nom de la colonne de la table qui contient les données requises. const String
join_keys — Une liste de clés de jointure. Any

Valeur renvoyée Renvoie une liste de valeurs correspondant à la liste des clés, ou NULL si une clé est introuvable. Any Exemples Exemple d’utilisation

Query

CREATE TABLE db_test.id_val(`id` UInt32, `val` UInt32) ENGINE = Join(ANY, LEFT, id);
INSERT INTO db_test.id_val VALUES (1,11)(2,12)(4,13);

SELECT joinGetOrNull(db_test.id_val, 'val', toUInt32(1)), joinGetOrNull(db_test.id_val, 'val', toUInt32(999));

Response

┌─joinGetOrNull(db_test.id_val, 'val', toUInt32(1))─┬─joinGetOrNull(db_test.id_val, 'val', toUInt32(999))─┐
│                                                11 │                                                ᴺᵁᴸᴸ │
└───────────────────────────────────────────────────┴─────────────────────────────────────────────────────┘

lowCardinalityIndices

Introduit dans : v18.12.0 Renvoie la position d’une valeur dans le dictionnaire d’une colonne LowCardinality. Les positions commencent à 1. Comme LowCardinality utilise des dictionnaires propres à chaque part, cette fonction peut renvoyer des positions différentes pour une même valeur selon les parts. Syntaxe

lowCardinalityIndices(col)

Arguments

col — Une colonne à faible cardinalité. LowCardinality

Valeur renvoyée La position de la valeur dans le dictionnaire de la part actuelle. UInt64 Exemples Exemples d’utilisation

Query

DROP TABLE IF EXISTS test;
CREATE TABLE test (s LowCardinality(String)) ENGINE = Memory;

-- create two parts:

INSERT INTO test VALUES ('ab'), ('cd'), ('ab'), ('ab'), ('df');
INSERT INTO test VALUES ('ef'), ('cd'), ('ab'), ('cd'), ('ef');

SELECT s, lowCardinalityIndices(s) FROM test;

Response

┌─s──┬─lowCardinalityIndices(s)─┐
│ ab │                        1 │
│ cd │                        2 │
│ ab │                        1 │
│ ab │                        1 │
│ df │                        3 │
└────┴──────────────────────────┘
┌─s──┬─lowCardinalityIndices(s)─┐
│ ef │                        1 │
│ cd │                        2 │
│ ab │                        3 │
│ cd │                        2 │
│ ef │                        1 │
└────┴──────────────────────────┘

lowCardinalityKeys

Introduit dans : v18.12.0 Renvoyer les valeurs du dictionnaire d’une colonne LowCardinality. Si le bloc est plus petit ou plus grand que la taille du dictionnaire, le résultat sera tronqué ou complété avec des valeurs par défaut. Comme LowCardinality utilise des dictionnaires par part, cette fonction peut renvoyer des valeurs de dictionnaire différentes d’une part à l’autre. Syntaxe

lowCardinalityKeys(col)

Arguments

col — Une colonne à faible cardinalité. LowCardinality

Valeur renvoyée Renvoie les clés du dictionnaire. UInt64 Exemples lowCardinalityKeys

Query

DROP TABLE IF EXISTS test;
CREATE TABLE test (s LowCardinality(String)) ENGINE = Memory;

-- create two parts:

INSERT INTO test VALUES ('ab'), ('cd'), ('ab'), ('ab'), ('df');
INSERT INTO test VALUES ('ef'), ('cd'), ('ab'), ('cd'), ('ef');

SELECT s, lowCardinalityKeys(s) FROM test;

Response

┌─s──┬─lowCardinalityKeys(s)─┐
│ ef │                       │
│ cd │ ef                    │
│ ab │ cd                    │
│ cd │ ab                    │
│ ef │                       │
└────┴───────────────────────┘
┌─s──┬─lowCardinalityKeys(s)─┐
│ ab │                       │
│ cd │ ab                    │
│ ab │ cd                    │
│ ab │ df                    │
│ df │                       │
└────┴───────────────────────┘

materialize

Introduit dans : v1.1.0 Transforme une constante en une colonne complète contenant une seule valeur. Les colonnes complètes et les constantes sont représentées différemment en mémoire. Les fonctions exécutent généralement un code différent pour les arguments normaux et constants, même si le résultat devrait en principe être le même. Cette fonction peut être utilisée pour déboguer ce comportement. Syntaxe

materialize(x)

Arguments

x — Une constante. Any

Valeur renvoyée Renvoie une colonne complète contenant la valeur constante. Any Exemples Exemple d’utilisation

Query

-- In the example below the `countMatches` function expects a constant second argument.
-- This behaviour can be debugged by using the `materialize` function to turn a constant into a full column,
-- verifying that the function throws an error for a non-constant argument.

SELECT countMatches('foobarfoo', 'foo');
SELECT countMatches('foobarfoo', materialize('foo'));

Response

2
Code: 44. DB::Exception: Received from localhost:9000. DB::Exception: Illegal type of argument #2 'pattern' of function countMatches, expected constant String, got String

minSampleSizeContinuous

Introduit dans : v23.10.0 Calcule la taille d’échantillon minimale requise pour un test A/B comparant les moyennes d’une métrique continue dans deux échantillons. Utilise la formule décrite dans cet article. Suppose des tailles égales pour les groupes de traitement et témoin. Renvoie la taille d’échantillon requise pour un groupe (c’est-à-dire que la taille d’échantillon requise pour l’ensemble de l’expérience est égale à deux fois la valeur renvoyée). Suppose également une variance égale de la métrique testée dans les groupes de traitement et témoin. Syntaxe

minSampleSizeContinuous(baseline, sigma, mde, power, alpha)

Alias : minSampleSizeContinous Arguments

baseline — Valeur de référence d’une métrique. (U)Int* ou Float*
sigma — Écart type de référence d’une métrique. (U)Int* ou Float*
mde — Effet minimal détectable (MDE) en pourcentage de la valeur de référence (par ex. pour une valeur de référence de 112.25, un MDE de 0.03 correspond à une variation attendue de 112.25 ± 112.25*0.03). (U)Int* ou Float*
power — Puissance statistique requise d’un test (1 - probabilité d’une erreur de type II). (U)Int* ou Float*
alpha — Niveau de signification requis d’un test (probabilité d’une erreur de type I). (U)Int* ou Float*

Valeur renvoyée Renvoie un Tuple nommé avec 3 éléments : minimum_sample_size, detect_range_lower et detect_range_upper. Il s’agit respectivement de la taille d’échantillon requise, de la borne inférieure de la plage de valeurs non détectables avec la taille d’échantillon requise renvoyée, calculée comme baseline * (1 - mde), et de la borne supérieure de la plage de valeurs non détectables avec la taille d’échantillon requise renvoyée, calculée comme baseline * (1 + mde) (Float64). Tuple(Float64, Float64, Float64) Exemples minSampleSizeContinuous

Query

SELECT minSampleSizeContinuous(112.25, 21.1, 0.03, 0.80, 0.05) AS sample_size

Response

(616.2931945826209,108.8825,115.6175)

minSampleSizeConversion

Introduit dans : v22.6.0 Calcule la taille d’échantillon minimale requise pour un test A/B comparant les conversions (proportions) entre deux échantillons. Utilise la formule décrite dans cet article. Suppose des tailles égales pour les groupes de traitement et témoin. Renvoie la taille d’échantillon requise pour un groupe (c.-à-d. que la taille d’échantillon requise pour l’ensemble de l’expérience est le double de la valeur renvoyée). Syntaxe

minSampleSizeConversion(baseline, mde, power, alpha)

Arguments

baseline — Conversion de référence. Float*
mde — Effet minimal détectable (MDE), exprimé en points de pourcentage (par ex., pour une conversion de référence de 0.25, un MDE de 0.03 correspond à une variation attendue vers 0.25 ± 0.03). Float*
power — Puissance statistique requise pour un test (1 - probabilité d’erreur de type II). Float*
alpha — Niveau de signification requis pour un test (probabilité d’erreur de type I). Float*

Valeur renvoyée Renvoie un Tuple nommé avec 3 éléments : minimum_sample_size, detect_range_lower, detect_range_upper. Il s’agit, respectivement, de la taille d’échantillon requise, de la borne inférieure de la plage de valeurs non détectables avec la taille d’échantillon requise renvoyée, calculée comme baseline - mde, et de la borne supérieure de la plage de valeurs non détectables avec la taille d’échantillon requise renvoyée, calculée comme baseline + mde. Tuple(Float64, Float64, Float64) Exemples minSampleSizeConversion

Query

SELECT minSampleSizeConversion(0.25, 0.03, 0.80, 0.05) AS sample_size

Response

(3396.077603219163,0.22,0.28)

neighbor

Introduit dans : v20.1.0 Renvoie une valeur d’une colonne à l’offset spécifié par rapport à la ligne courante. Cette fonction est déconseillée et sujette aux erreurs, car elle s’appuie sur l’ordre physique des blocs de données, qui peut ne pas correspondre à l’ordre logique attendu par les utilisateurs. Envisagez plutôt d’utiliser de véritables fonctions de fenêtre. La fonction peut être activée en définissant allow_deprecated_error_prone_window_functions = 1. Syntaxe

neighbor(column, offset[, default_value])

Arguments

column — La colonne source. Any
offset — Le décalage par rapport à la ligne actuelle. Les valeurs positives portent vers l’avant, les valeurs négatives vers l’arrière. Integer
default_value — Facultatif. Valeur à renvoyer si le décalage dépasse les limites des données. Si elle n’est pas spécifiée, la valeur par défaut du type de colonne est utilisée. Any

Valeur renvoyée Renvoie une valeur au décalage spécifié, ou la valeur par défaut si elle est hors limites. Any Exemples Exemple d’utilisation

Query

SELECT number, neighbor(number, 2) FROM system.numbers LIMIT 10;

Response

┌─number─┬─neighbor(number, 2)─┐
│      0 │                   2 │
│      1 │                   3 │
│      2 │                   4 │
│      3 │                   5 │
│      4 │                   6 │
│      5 │                   7 │
│      6 │                   8 │
│      7 │                   9 │
│      8 │                   0 │
│      9 │                   0 │
└────────┴─────────────────────┘

Avec une valeur par défaut

Query

SELECT number, neighbor(number, 2, 999) FROM system.numbers LIMIT 10;

Response

┌─number─┬─neighbor(number, 2, 999)─┐
│      0 │                        2 │
│      1 │                        3 │
│      2 │                        4 │
│      3 │                        5 │
│      4 │                        6 │
│      5 │                        7 │
│      6 │                        8 │
│      7 │                        9 │
│      8 │                      999 │
│      9 │                      999 │
└────────┴──────────────────────────┘

normalizeQuery

Introduit dans : v20.8.0 Remplace les littéraux, les suites de littéraux et les alias complexes (contenant des espaces, plus de deux chiffres ou d’au moins 36 octets, comme les UUID) par le caractère de substitution ?. Syntaxe

normalizeQuery(x)

Arguments

x — Séquence de caractères. String

Valeur renvoyée Renvoie la séquence de caractères donnée avec des placeholders. String Exemples Exemple d’utilisation

Query

SELECT normalizeQuery('[1, 2, 3, x]') AS query

Response

┌─query────┐
│ [?.., x] │
└──────────┘

normalizeQueryKeepNames

Introduit dans : v21.2.0 Remplace les littéraux et les séquences de littéraux par le caractère de substitution ?, mais ne remplace pas les alias complexes (contenant des espaces, plus de deux chiffres ou d’une longueur d’au moins 36 octets, comme les UUIDs). Cela permet de mieux analyser les journaux de requêtes complexes. Syntaxe

normalizeQueryKeepNames(x)

Arguments

x — Séquence de caractères. String

Valeur renvoyée Renvoie la séquence de caractères donnée avec des marqueurs de substitution. String Exemples Exemple d’utilisation

Query

SELECT normalizeQuery('SELECT 1 AS aComplexName123'), normalizeQueryKeepNames('SELECT 1 AS aComplexName123')

Response

┌─normalizeQuery('SELECT 1 AS aComplexName123')─┬─normalizeQueryKeepNames('SELECT 1 AS aComplexName123')─┐
│ SELECT ? AS `?`                               │ SELECT ? AS aComplexName123                            │
└───────────────────────────────────────────────┴────────────────────────────────────────────────────────┘

normalizedQueryHash

Introduit dans : v20.8.0 Renvoie des valeurs de hachage 64 bits identiques, sans les valeurs des littéraux, pour des requêtes similaires. Peut être utile pour l’analyse des journaux de requêtes. Syntaxe

normalizedQueryHash(x)

Arguments

x — Suite de caractères. String

Valeur renvoyée Renvoie une valeur de hachage sur 64 bits. UInt64 Exemples Exemple d’utilisation

Query

SELECT normalizedQueryHash('SELECT 1 AS `xyz`') != normalizedQueryHash('SELECT 1 AS `abc`') AS res

Response

┌─res─┐
│   1 │
└─────┘

normalizedQueryHashKeepNames

Introduit dans : v21.2.0 Comme normalizedQueryHash, elle renvoie des valeurs de hachage 64 bits identiques pour des requêtes similaires, sans les valeurs des littéraux, mais ne remplace pas les alias complexes (contenant des espaces, plus de deux chiffres ou d’une longueur d’au moins 36 octets, comme les UUID) par un caractère de substitution avant le hachage. Peut être utile pour analyser les journaux de requêtes. Syntaxe

normalizedQueryHashKeepNames(x)

Arguments

x — Séquence de caractères. String

Valeur renvoyée Renvoie une valeur de hachage sur 64 bits. UInt64 Exemples Exemple d’utilisation

Query

SELECT normalizedQueryHash('SELECT 1 AS `xyz123`') != normalizedQueryHash('SELECT 1 AS `abc123`') AS normalizedQueryHash;
SELECT normalizedQueryHashKeepNames('SELECT 1 AS `xyz123`') != normalizedQueryHashKeepNames('SELECT 1 AS `abc123`') AS normalizedQueryHashKeepNames;

Response

┌─normalizedQueryHash─┐
│                   0 │
└─────────────────────┘
┌─normalizedQueryHashKeepNames─┐
│                            1 │
└──────────────────────────────┘

obfuscateQuery

Introduit dans : v26.4.0 Masque une requête SQL en remplaçant les identifiants par des mots aléatoires et les littéraux par des valeurs aléatoires, tout en préservant la structure de la requête. Cette fonction est utile pour anonymiser les requêtes avant de les consigner dans les logs ou de les partager à des fins de débogage. Des lignes différentes produiront des résultats masqués différents, même pour la même requête en entrée, ce qui aide à préserver la confidentialité lors du traitement de plusieurs requêtes. Le paramètre facultatif tag empêche l’élimination des sous-expressions communes lorsque le même appel de fonction est utilisé plusieurs fois dans une requête. Cela garantit que chaque appel produit un résultat masqué différent. Fonctionnalités :

Remplace les noms de table, les noms de colonnes et les alias par des mots aléatoires
Remplace les littéraux numériques et textuels par des valeurs aléatoires
Préserve la structure globale de la requête et la syntaxe SQL
Produit des résultats différents pour des lignes différentes

Syntaxe

obfuscateQuery(query[, tag])

Arguments

query — La requête SQL à obfusquer. String
tag — Facultatif. Une valeur permettant d’éviter l’élimination des sous-expressions communes lorsque le même appel de fonction est utilisé plusieurs fois.

Valeur renvoyée La requête obfusquée, dans laquelle les identifiants et les littéraux sont remplacés tout en préservant la structure d’origine de la requête. String Exemples Utilisation de base

Query

SELECT obfuscateQuery('SELECT name, age FROM users WHERE age > 30')

Response

SELECT fruit, number FROM table WHERE number > 12

Avec un tag pour éviter l’élimination des sous-expressions communes

Query

SELECT obfuscateQuery('SELECT * FROM t', 1), obfuscateQuery('SELECT * FROM t', 2)

Response

SELECT a FROM b, SELECT c FROM d

Des lignes différentes donnent des résultats différents

Query

SELECT obfuscateQuery('SELECT 1') AS a, obfuscateQuery('SELECT 1') AS b

Response

A B

obfuscateQueryWithSeed

Introduite dans : v26.4.0 Obfusque une requête SQL à l’aide d’une seed spécifiée afin d’obtenir des résultats déterministes. Contrairement à obfuscateQuery(), cette fonction produit des résultats déterministes lorsqu’elle reçoit la même seed. Cela est utile lorsque vous avez besoin d’une obfuscation constante sur plusieurs exécutions, ou lorsque vous souhaitez reproduire la même requête obfusquée à des fins de test ou de débogage. Fonctionnalités :

Obfuscation déterministe basée sur la seed fournie
La même seed produit toujours le même résultat obfusqué
Des seeds différentes produisent des résultats différents
Préserve la structure de la requête, comme obfuscateQuery()

Cas d’utilisation :

Cas de test reproductibles
Anonymisation constante sur plusieurs exécutions
Débogage avec des requêtes obfusquées cohérentes

Syntaxe

obfuscateQueryWithSeed(query, seed)

Arguments

query — La requête SQL à obfusquer. String
seed — La valeur d’initialisation pour l’obfuscation. La même valeur d’initialisation produit des résultats déterministes. Integer ou String

Valeur renvoyée La requête obfusquée, générée de manière déterministe à partir de la valeur d’initialisation fournie. String Exemples Obfuscation déterministe avec une valeur d’initialisation entière

Query

SELECT obfuscateQueryWithSeed('SELECT name FROM users', 42)

Response

SELECT fruit FROM table

Obfuscation déterministe avec une valeur d’initialisation de type chaîne

Query

SELECT obfuscateQueryWithSeed('SELECT id, value FROM data', 'myseed')

Response

SELECT a, b FROM c

Même seed, même résultat

Query

SELECT obfuscateQueryWithSeed('SELECT 1', 100) = obfuscateQueryWithSeed('SELECT 1', 100)

Response

true

parseReadableSize

Introduit dans : v24.6.0 À partir d’une chaîne contenant une taille en octets et B, KiB, KB, MiB, MB, etc. comme unité (c.-à-d. ISO/IEC 80000-13 ou unité décimale d’octets), cette fonction renvoie le nombre d’octets correspondant. Si la fonction ne parvient pas à analyser la valeur d’entrée, elle lève une exception. Les opérations inverses de cette fonction sont formatReadableSize et formatReadableDecimalSize. Syntaxe

parseReadableSize(x)

Arguments

x — Taille dans un format lisible avec ISO/IEC 80000-13 ou une unité décimale d’octets. String

Valeur renvoyée Renvoyer le nombre d’octets, arrondi à l’entier supérieur le plus proche. UInt64 Exemples Exemple d’utilisation

Query

SELECT arrayJoin(['1 B', '1 KiB', '3 MB', '5.314 KiB']) AS readable_sizes, parseReadableSize(readable_sizes) AS sizes;

Response

┌─readable_sizes─┬───sizes─┐
│ 1 B            │       1 │
│ 1 KiB          │    1024 │
│ 3 MB           │ 3000000 │
│ 5.314 KiB      │    5442 │
└────────────────┴─────────┘

parseReadableSizeOrNull

Introduit dans : v24.6.0 Étant donnée une chaîne contenant une taille en octets et B, KiB, KB, MiB, MB, etc. comme unité (c.-à-d. ISO/IEC 80000-13 ou une unité d’octets décimale), cette fonction renvoie le nombre d’octets correspondant. Si la fonction ne parvient pas à analyser la valeur d’entrée, elle renvoie NULL. Les opérations inverses de cette fonction sont formatReadableSize et formatReadableDecimalSize. Syntaxe

parseReadableSizeOrNull(x)

Arguments

x — Taille en format lisible avec ISO/IEC 80000-13 ou une unité d’octets décimale. String

Valeur renvoyée Renvoie le nombre d’octets, arrondi à l’entier supérieur, ou NULL si l’entrée ne peut pas être interprétée Nullable(UInt64) Exemples Exemple d’utilisation

Query

SELECT arrayJoin(['1 B', '1 KiB', '3 MB', '5.314 KiB', 'invalid']) AS readable_sizes, parseReadableSizeOrNull(readable_sizes) AS sizes;

Response

┌─readable_sizes─┬───sizes─┐
│ 1 B            │       1 │
│ 1 KiB          │    1024 │
│ 3 MB           │ 3000000 │
│ 5.314 KiB      │    5442 │
│ invalid        │    ᴺᵁᴸᴸ │
└────────────────┴─────────┘

parseReadableSizeOrZero

Introduit dans : v24.6.0 Étant donnée une chaîne contenant une taille en octets avec B, KiB, KB, MiB, MB, etc. comme unité (c.-à-d. ISO/IEC 80000-13 ou unité d’octets décimale), cette fonction renvoie le nombre d’octets correspondant. Si la fonction ne parvient pas à analyser la valeur d’entrée, elle renvoie 0. Les opérations inverses de cette fonction sont formatReadableSize et formatReadableDecimalSize. Syntaxe

parseReadableSizeOrZero(x)

Arguments

x — Taille lisible avec une unité de taille ISO/IEC 80000-13 ou une unité de taille décimale. String

Valeur renvoyée Renvoie le nombre d’octets, arrondi à l’entier supérieur le plus proche, ou 0 s’il est impossible d’analyser l’entrée. UInt64 Exemples Exemple d’utilisation

Query

SELECT arrayJoin(['1 B', '1 KiB', '3 MB', '5.314 KiB', 'invalid']) AS readable_sizes, parseReadableSizeOrZero(readable_sizes) AS sizes;

Response

┌─readable_sizes─┬───sizes─┐
│ 1 B            │       1 │
│ 1 KiB          │    1024 │
│ 3 MB           │ 3000000 │
│ 5.314 KiB      │    5442 │
│ invalid        │       0 │
└────────────────┴─────────┘

parseTimeDelta

Introduit dans : v22.7.0 Analyse une suite de nombres suivie d’un élément ressemblant à une unité de temps. La chaîne de décalage temporel utilise les spécifications d’unité de temps suivantes :

years, year, yr, y
months, month, mo
weeks, week, w
days, day, d
hours, hour, hr, h
minutes, minute, min, m
seconds, second, sec, s
milliseconds, millisecond, millisec, ms
microseconds, microsecond, microsec, μs, µs, us
nanoseconds, nanosecond, nanosec, ns

Plusieurs unités de temps peuvent être combinées à l’aide de séparateurs (espace, ;, -, +, ,, :). La durée des années et des mois est approximative : une année correspond à 365 jours et un mois à 30,5 jours. Syntaxe

parseTimeDelta(timestr)

Arguments

timestr — Une suite de nombres suivie d’un élément ressemblant à une unité de temps. String

Valeur renvoyée Le nombre de secondes. Float64 Exemples Exemple d’utilisation

Query

SELECT parseTimeDelta('11s+22min')

Response

┌─parseTimeDelta('11s+22min')─┐
│                        1331 │
└─────────────────────────────┘

Unités temporelles complexes

Query

SELECT parseTimeDelta('1yr2mo')

Response

┌─parseTimeDelta('1yr2mo')─┐
│                 36806400 │
└──────────────────────────┘

partitionId

Introduit dans : v21.4.0 Calcule l’identifiant de partition.

Cette fonction est lente et ne doit pas être utilisée sur un grand nombre de lignes.

Syntaxe

partitionId(column1[, column2, ...])

Alias : partitionID Arguments

column1, column2, ... — Colonne pour laquelle l’identifiant de partition doit être renvoyé.

Valeur renvoyée Renvoie l’identifiant de partition de la ligne. String Exemples Exemple d’utilisation

Query

DROP TABLE IF EXISTS tab;

CREATE TABLE tab
(
  i int,
  j int
)
ENGINE = MergeTree
PARTITION BY i
ORDER BY tuple();

INSERT INTO tab VALUES (1, 1), (1, 2), (1, 3), (2, 4), (2, 5), (2, 6);

SELECT i, j, partitionId(i), _partition_id FROM tab ORDER BY i, j;

Response

┌─i─┬─j─┬─partitionId(i)─┬─_partition_id─┐
│ 1 │ 1 │ 1              │ 1             │
│ 1 │ 2 │ 1              │ 1             │
│ 1 │ 3 │ 1              │ 1             │
│ 2 │ 4 │ 2              │ 2             │
│ 2 │ 5 │ 2              │ 2             │
│ 2 │ 6 │ 2              │ 2             │
└───┴───┴────────────────┴───────────────┘

queryID

Introduit dans : v21.9.0 Renvoie l’ID de la requête en cours. Les autres paramètres d’une requête peuvent être extraits du champ query_id de la table system.query_log. Contrairement à la fonction initialQueryID, queryID peut renvoyer des résultats différents selon les shards. Syntaxe

queryID()

Alias : query_id Arguments

Aucun.

Valeur renvoyée Renvoie l’identifiant de la requête en cours. String Exemples Exemple d’utilisation

Query

CREATE TABLE tmp (str String) ENGINE = Log;
INSERT INTO tmp (*) VALUES ('a');
SELECT count(DISTINCT t) FROM (SELECT queryID() AS t FROM remote('127.0.0.{1..3}', currentDatabase(), 'tmp') GROUP BY queryID());

Response

┌─count(DISTINCT t)─┐
│                 3 │
└───────────────────┘

revision

Introduit dans : v22.7.0 Renvoie la révision actuelle du serveur ClickHouse. Syntaxe

revision()

Arguments

Aucun.

Valeur renvoyée Renvoie la révision actuelle du serveur ClickHouse. UInt32 Exemples Exemple d’utilisation

Query

SELECT revision()

Response

┌─revision()─┐
│      54485 │
└────────────┘

rowNumberInAllBlocks

Introduit dans : v1.1.0 Renvoie un numéro de ligne unique pour chaque ligne traitée. Syntaxe

rowNumberInAllBlocks()

Arguments

Aucun.

Valeur renvoyée Renvoie le numéro ordinal de la ligne dans le bloc de données, à partir de 0. UInt64 Exemples Exemple d’utilisation

Query

SELECT rowNumberInAllBlocks()
FROM
(
    SELECT *
    FROM system.numbers_mt
    LIMIT 10
)
SETTINGS max_block_size = 2

Response

┌─rowNumberInAllBlocks()─┐
│                      0 │
│                      1 │
└────────────────────────┘
┌─rowNumberInAllBlocks()─┐
│                      4 │
│                      5 │
└────────────────────────┘
┌─rowNumberInAllBlocks()─┐
│                      2 │
│                      3 │
└────────────────────────┘
┌─rowNumberInAllBlocks()─┐
│                      6 │
│                      7 │
└────────────────────────┘
┌─rowNumberInAllBlocks()─┐
│                      8 │
│                      9 │
└────────────────────────┘

rowNumberInBlock

Introduit dans : v1.1.0 Pour chaque bloc traité par rowNumberInBlock, renvoie le numéro de la ligne courante. Le numéro renvoyé commence à 0 pour chaque bloc. Syntaxe

rowNumberInBlock()

Arguments

Aucun.

Valeur renvoyée Renvoie le numéro ordinal de la ligne dans le bloc de données, à partir de 0. UInt64 Exemples Exemple d’utilisation

Query

SELECT rowNumberInBlock()
FROM
(
    SELECT *
    FROM system.numbers_mt
    LIMIT 10
) SETTINGS max_block_size = 2

Response

┌─rowNumberInBlock()─┐
│                  0 │
│                  1 │
└────────────────────┘
┌─rowNumberInBlock()─┐
│                  0 │
│                  1 │
└────────────────────┘
┌─rowNumberInBlock()─┐
│                  0 │
│                  1 │
└────────────────────┘
┌─rowNumberInBlock()─┐
│                  0 │
│                  1 │
└────────────────────┘
┌─rowNumberInBlock()─┐
│                  0 │
│                  1 │
└────────────────────┘

runningAccumulate

Introduit dans : v1.1.0 Accumule les états d’une fonction d’agrégation pour chaque ligne d’un bloc de données.

ObsolèteL’état est réinitialisé pour chaque nouveau bloc de données. En raison de ce comportement sujet aux erreurs, cette fonction est obsolète ; il est recommandé d’utiliser plutôt les fonctions de fenêtre. Vous pouvez utiliser le paramètre allow_deprecated_error_prone_window_functions pour autoriser l’utilisation de cette fonction.

Syntaxe

runningAccumulate(agg_state[, grouping])

Arguments

agg_state — État de la fonction d’agrégation. AggregateFunction
grouping — Facultatif. Clé de regroupement. L’état de la fonction est réinitialisé si la valeur de grouping change. Il peut s’agir de n’importe quel type de données pris en charge pour lequel l’opérateur d’égalité est défini. Any

Valeur renvoyée Renvoie le résultat accumulé pour chaque ligne. Any Exemples Exemple d’utilisation avec initializeAggregation

Query

WITH initializeAggregation('sumState', number) AS one_row_sum_state
SELECT
    number,
    finalizeAggregation(one_row_sum_state) AS one_row_sum,
    runningAccumulate(one_row_sum_state) AS cumulative_sum
FROM numbers(5);

Response

┌─number─┬─one_row_sum─┬─cumulative_sum─┐
│      0 │           0 │              0 │
│      1 │           1 │              1 │
│      2 │           2 │              3 │
│      3 │           3 │              6 │
│      4 │           4 │             10 │
└────────┴─────────────┴────────────────┘

runningConcurrency

Introduite dans : v21.3.0 Calcule le nombre d’événements simultanés. Chaque événement possède une heure de début et une heure de fin. L’heure de début est incluse dans l’événement, tandis que l’heure de fin ne l’est pas. Les colonnes contenant l’heure de début et l’heure de fin doivent être du même type de données. La fonction calcule le nombre total d’événements actifs (simultanés) pour chaque heure de début d’événement.

PrérequisLes événements doivent être triés par heure de début dans l’ordre croissant. Si cette condition n’est pas respectée, la fonction génère une exception. Chaque bloc de données est traité séparément. Si des événements provenant de différents blocs de données se chevauchent, ils ne peuvent pas être traités correctement.

ObsolèteIl est recommandé d’utiliser plutôt les fonctions de fenêtre.

Syntaxe

runningConcurrency(start, end)

Arguments

start — Colonne contenant l’horodatage de début des événements. Date ou DateTime ou DateTime64
end — Colonne contenant l’horodatage de fin des événements. Date ou DateTime ou DateTime64

Valeur renvoyée Renvoie le nombre d’événements simultanés pour chaque horodatage de début d’événement. UInt32 Exemples Exemple d’utilisation

Query

SELECT start, runningConcurrency(start, end) FROM example_table;

Response

┌──────start─┬─runningConcurrency(start, end)─┐
│ 2025-03-03 │                              1 │
│ 2025-03-06 │                              2 │
│ 2025-03-07 │                              3 │
│ 2025-03-11 │                              2 │
└────────────┴────────────────────────────────┘

runningDifference

Introduit dans : v1.1.0 Calcule la différence entre les valeurs de deux lignes consécutives dans le bloc de données. Renvoie 0 pour la première ligne, puis, pour les lignes suivantes, la différence par rapport à la ligne précédente.

ObsolèteRenvoie uniquement les différences à l’intérieur du bloc de données en cours de traitement. En raison de ce comportement sujet aux erreurs, cette fonction est obsolète. Il est recommandé d’utiliser à la place les fonctions de fenêtre.Vous pouvez utiliser le paramètre allow_deprecated_error_prone_window_functions pour autoriser l’utilisation de cette fonction.

Le résultat de la fonction dépend des blocs de données concernés et de l’ordre des données dans le bloc. L’ordre des lignes lors du calcul de runningDifference() peut différer de l’ordre des lignes renvoyées à l’utilisateur. Pour éviter cela, vous pouvez créer une sous-requête avec ORDER BY et appeler la fonction en dehors de la sous-requête. Veuillez noter que la taille du bloc influe sur le résultat. L’état interne de runningDifference est réinitialisé pour chaque nouveau bloc. Syntaxe

runningDifference(x)

Arguments

x — Colonne pour laquelle calculer la différence entre valeurs consécutives. Any

Valeur renvoyée Renvoie la différence entre des valeurs consécutives, avec 0 pour la première ligne. Exemples Exemple d’utilisation

Query

SELECT
    EventID,
    EventTime,
    runningDifference(EventTime) AS delta
FROM
(
    SELECT
        EventID,
        EventTime
    FROM events
    WHERE EventDate = '2025-11-24'
    ORDER BY EventTime ASC
    LIMIT 5
);

Response

┌─EventID─┬───────────EventTime─┬─delta─┐
│    1106 │ 2025-11-24 00:00:04 │     0 │
│    1107 │ 2025-11-24 00:00:05 │     1 │
│    1108 │ 2025-11-24 00:00:05 │     0 │
│    1109 │ 2025-11-24 00:00:09 │     4 │
│    1110 │ 2025-11-24 00:00:10 │     1 │
└─────────┴─────────────────────┴───────┘

Exemple d’impact de la taille des blocs

Query

SELECT
    number,
    runningDifference(number + 1) AS diff
FROM numbers(100000)
WHERE diff != 1;

Response

┌─number─┬─diff─┐
│      0 │    0 │
└────────┴──────┘
┌─number─┬─diff─┐
│  65536 │    0 │
└────────┴──────┘

runningDifferenceStartingWithFirstValue

Introduit dans : v1.1.0 Calcule la différence entre les valeurs de lignes consécutives dans un bloc de données, mais contrairement à runningDifference, cette fonction renvoie la valeur réelle de la première ligne au lieu de 0.

ObsolèteRenvoie uniquement les différences à l’intérieur du bloc de données en cours de traitement. En raison de ce comportement propice aux erreurs, cette fonction est obsolète. Il est recommandé d’utiliser plutôt les fonctions de fenêtre.Vous pouvez utiliser le paramètre allow_deprecated_error_prone_window_functions pour autoriser l’utilisation de cette fonction.

Syntaxe

runningDifferenceStartingWithFirstValue(x)

Arguments

x — Colonne pour laquelle calculer la différence entre valeurs consécutives. Any

Valeur renvoyée Renvoie la différence entre valeurs consécutives ; pour la première ligne, renvoie la valeur de cette ligne. Any Exemples Exemple d’utilisation

Query

SELECT
    number,
    runningDifferenceStartingWithFirstValue(number) AS diff
FROM numbers(5);

Response

┌─number─┬─diff─┐
│      0 │    0 │
│      1 │    1 │
│      2 │    1 │
│      3 │    1 │
│      4 │    1 │
└────────┴──────┘

serverUUID

Introduit dans : v20.1.0 Renvoie l’UUID (v4) aléatoire et unique généré au premier démarrage du serveur. Cet UUID est conservé, c’est-à-dire que les deuxième, troisième, etc. démarrages du serveur renvoient le même UUID. Syntaxe

serverUUID()

Arguments

Aucun.

Valeur renvoyée Renvoie l’UUID aléatoire du serveur. UUID Exemples Exemple d’utilisation

Query

SELECT serverUUID();

Response

┌─serverUUID()─────────────────────────────┐
│ 7ccc9260-000d-4d5c-a843-5459abaabb5f     │
└──────────────────────────────────────────┘

shardCount

Introduit dans : v21.9.0 Renvoyer le nombre total de shards pour une requête distribuée. Si une requête n’est pas distribuée, la valeur constante 0 est renvoyée. Syntaxe

shardCount()

Arguments

Aucun.

Valeur renvoyée Renvoie le nombre total de shards, ou 0. UInt32 Exemples Exemple d’utilisation

Query

-- See shardNum() example above which also demonstrates shardCount()
CREATE TABLE shard_count_example (dummy UInt8)
ENGINE=Distributed(test_cluster_two_shards_localhost, system, one, dummy);
SELECT shardCount() FROM shard_count_example;

Response

┌─shardCount()─┐
│            2 │
│            2 │
└──────────────┘

shardNum

Introduit dans : v21.9.0 Renvoie l’indice du shard qui traite une partie des données dans une requête distribuée. Les indices commencent à 1. Si une requête n’est pas distribuée, la valeur constante 0 est renvoyée. Syntaxe

shardNum()

Arguments

Aucun.

Valeur renvoyée Renvoie l’index du shard ou la constante 0. UInt32 Exemples Exemple d’utilisation

Query

CREATE TABLE shard_num_example (dummy UInt8)
ENGINE=Distributed(test_cluster_two_shards_localhost, system, one, dummy);
SELECT dummy, shardNum(), shardCount() FROM shard_num_example;

Response

┌─dummy─┬─shardNum()─┬─shardCount()─┐
│     0 │          1 │            2 │
│     0 │          2 │            2 │
└───────┴────────────┴──────────────┘

showCertificate

Introduit dans : v22.6.0 Affiche des informations sur le certificat Secure Sockets Layer (SSL) du serveur actuel, s’il est configuré. Consultez Configuration de TLS pour plus d’informations sur la façon de configurer ClickHouse pour utiliser des certificats OpenSSL afin de valider les connexions. Syntaxe

showCertificate()

Arguments

Aucun.

Valeur renvoyée Renvoie une map de paires clé-valeur associées au certificat SSL configuré. Map(String, String) Exemples Exemple d’utilisation

Query

SELECT showCertificate() FORMAT LineAsString;

Response

{'version':'1','serial_number':'2D9071D64530052D48308473922C7ADAFA85D6C5','signature_algo':'sha256WithRSAEncryption','issuer':'/CN=marsnet.local CA','not_before':'May  7 17:01:21 2024 GMT','not_after':'May  7 17:01:21 2025 GMT','subject':'/CN=chnode1','pkey_algo':'rsaEncryption'}

sleep

Introduit dans : v1.1.0 Suspend l’exécution d’une requête pendant le nombre de secondes indiqué. La fonction est principalement utilisée à des fins de test et de débogage. La fonction sleep() ne doit généralement pas être utilisée dans des environnements de production, car elle peut nuire aux performances des requêtes et à la réactivité du système. Cependant, elle peut s’avérer utile dans les scénarios suivants :

Test : lors de tests ou de benchmarking de ClickHouse, vous pouvez vouloir simuler des délais ou introduire des pauses afin d’observer comment le système se comporte dans certaines conditions.
Débogage : si vous devez examiner l’état du système ou l’exécution d’une requête à un moment précis, vous pouvez utiliser sleep() pour introduire une pause, ce qui vous permet d’inspecter ou de collecter des informations pertinentes.
Simulation : dans certains cas, vous pouvez vouloir simuler des situations réelles où des délais ou des pauses se produisent, comme la latence réseau ou des dépendances à des systèmes externes.

Il est important d’utiliser la fonction sleep() avec discernement et uniquement lorsque cela est nécessaire, car elle peut affecter les performances globales et la réactivité de votre système ClickHouse.

Pour des raisons de sécurité, la fonction ne peut être exécutée que dans le profil utilisateur par défaut (avec allow_sleep activé). Syntaxe

sleep(seconds)

Arguments

seconds — Le nombre de secondes pendant lequel suspendre l’exécution de la requête, dans la limite de 3 secondes. Il peut s’agir d’une valeur à virgule flottante pour spécifier des fractions de seconde. const UInt* ou const Float*

Valeur renvoyée Renvoie 0. UInt8 Exemples Exemple d’utilisation

Query

-- This query will pause for 2 seconds before completing.
-- During this time, no results will be returned, and the query will appear to be hanging or unresponsive.
SELECT sleep(2);

Response

┌─sleep(2)─┐
│        0 │
└──────────┘
1 row in set. Elapsed: 2.012 sec.

sleepEachRow

Introduit dans : v1.1.0 Met en pause l’exécution d’une requête pendant un nombre donné de secondes pour chaque ligne du jeu de résultats. La fonction sleepEachRow() est principalement utilisée à des fins de test et de débogage, à l’instar de la fonction sleep(). Elle permet de simuler des délais ou d’introduire des pauses dans le traitement de chaque ligne, ce qui peut être utile dans des scénarios tels que :

Test : lors de tests ou de benchmarks de performance de ClickHouse dans des conditions spécifiques, vous pouvez utiliser sleepEachRow() pour simuler des délais ou introduire des pauses pour chaque ligne traitée.
Débogage : si vous devez examiner l’état du système ou l’exécution d’une requête pour chaque ligne traitée, vous pouvez utiliser sleepEachRow() pour introduire des pauses et ainsi inspecter le système ou recueillir les informations pertinentes.
Simulation : dans certains cas, vous pouvez vouloir reproduire des scénarios réels dans lesquels des délais ou des pauses surviennent pour chaque ligne traitée, par exemple lors d’interactions avec des systèmes externes ou en présence de latences réseau.

Comme pour la fonction sleep(), il est important d’utiliser sleepEachRow() avec discernement et uniquement lorsque nécessaire, car elle peut affecter de manière significative les performances globales et la réactivité de votre système ClickHouse, en particulier avec des jeux de résultats volumineux.

Syntaxe

sleepEachRow(seconds)

Arguments

seconds — Le nombre de secondes pendant lequel l’exécution de la requête est mise en pause pour chaque ligne du jeu de résultats, avec un maximum de 3 secondes. Il peut s’agir d’une valeur à virgule flottante pour spécifier des fractions de seconde. const UInt* ou const Float*

Valeur renvoyée Renvoie 0 pour chaque ligne. UInt8 Exemples Exemple d’utilisation

Query

-- The output will be delayed, with a 0.5-second pause between each row.
SELECT number, sleepEachRow(0.5) FROM system.numbers LIMIT 5;

Response

┌─number─┬─sleepEachRow(0.5)─┐
│      0 │                 0 │
│      1 │                 0 │
│      2 │                 0 │
│      3 │                 0 │
│      4 │                 0 │
└────────┴───────────────────┘

structureToCapnProtoSchema

Introduit dans : v23.8.0 Fonction qui convertit la structure d’une table ClickHouse en schéma au format CapnProto Syntaxe

structureToCapnProtoSchema(table_structure, message)

Arguments

Aucun.

Valeur de retour Exemples random

Query

SELECT structureToCapnProtoSchema('s String, x UInt32', 'MessageName') format TSVRaw

Response

struct MessageName
{
    s @0 : Data;
    x @1 : UInt32;
}

structureToProtobufSchema

Introduit dans : v23.8.0 Convertit la structure d’une table ClickHouse en schéma au format Protobuf. Cette fonction prend une définition de structure de table ClickHouse et la convertit en définition de schéma Protocol Buffers (Protobuf) en syntaxe proto3. Elle est utile pour générer des schémas Protobuf correspondant à la structure de vos tables ClickHouse pour l’échange de données. Syntaxe

structureToProtobufSchema(structure, message_name)

Arguments

structure — Définition de la structure d’une table ClickHouse sous forme de chaîne de caractères (par ex. ‘column1 Type1, column2 Type2’). String
message_name — Nom du type de message Protobuf dans le schéma généré. String

Valeur renvoyée Renvoie une définition de schéma Protobuf en syntaxe proto3 correspondant à la structure ClickHouse en entrée. String Exemples Conversion d’une structure ClickHouse en schéma Protobuf

Query

SELECT structureToProtobufSchema('s String, x UInt32', 'MessageName') FORMAT TSVRaw;

Response

syntax = "proto3";

message MessageName
{
    bytes s = 1;
    uint32 x = 2;
}

tcpPort

Introduit dans : v20.12.0 Renvoie le numéro du port TCP de l’interface native sur lequel le serveur écoute. Si elle est exécutée dans le contexte d’une table distribuée, cette fonction génère une colonne ordinaire avec des valeurs propres à chaque shard. Sinon, elle produit une valeur constante. Syntaxe

tcpPort()

Arguments

Aucun.

Valeur renvoyée Renvoie le numéro du port TCP. UInt16 Exemples Exemple d’utilisation

Query

SELECT tcpPort()

Response

┌─tcpPort()─┐
│      9000 │
└───────────┘

throwIf

Introduit dans : v1.1.0 Lève une exception si l’argument x est vrai. Pour utiliser l’argument error_code, le paramètre de configuration allow_custom_error_code_in_throw doit être activé. Syntaxe

throwIf(x[, message[, error_code]])

Arguments

x — La condition à vérifier. Any
message — Facultatif. Message d’erreur personnalisé. const String
error_code — Facultatif. Code d’erreur personnalisé. const Int8/16/32

Valeur renvoyée Renvoie 0 si la condition est false, et lève une exception si la condition est true. UInt8 Exemples Exemple d’utilisation

Query

SELECT throwIf(number = 3, 'Too many') FROM numbers(10);

Response

↙ Progress: 0.00 rows, 0.00 B (0.00 rows/s., 0.00 B/s.) Received exception from server (version 19.14.1):
Code: 395. DB::Exception: Received from localhost:9000. DB::Exception: Too many.

toColumnTypeName

Introduit dans : v1.1.0 Renvoie le nom interne du type de données de la valeur donnée. Contrairement à la fonction toTypeName, le type de données renvoyé peut inclure des colonnes d’encapsulation internes telles que Const et LowCardinality. Syntaxe

toColumnTypeName(value)

Arguments

value — Valeur pour laquelle renvoyer le type de données interne. Any

Valeur renvoyée Renvoie le type de données interne utilisé pour représenter la valeur. String Exemples Exemple d’utilisation

Query

SELECT toColumnTypeName(CAST('2025-01-01 01:02:03' AS DateTime));

Response

┌─toColumnTypeName(CAST('2025-01-01 01:02:03', 'DateTime'))─┐
│ Const(UInt32)                                             │
└───────────────────────────────────────────────────────────┘

toTypeName

Introduit dans : v1.1.0 Renvoie le nom du type de l’argument passé. Si NULL est passé, la fonction renvoie le type Nullable(Nothing), qui correspond à la représentation interne de NULL dans ClickHouse. Syntaxe

toTypeName(x)

Arguments

x — Une valeur de type arbitraire. Any

Valeur renvoyée Renvoie le nom du type de données de la valeur en entrée. String Exemples Exemple d’utilisation

Query

SELECT toTypeName(123)

Response

┌─toTypeName(123)─┐
│ UInt8           │
└─────────────────┘

tokenizeQuery

Introduit dans : v26.5.0 Tokenise une chaîne de requête ClickHouse SQL et renvoie un tableau de tokens. Chaque token est un tuple nommé comprenant la position de début (en octets), la position de fin et le type de token. Syntaxe

tokenizeQuery(query)

Arguments

query — Une chaîne de requête en ClickHouse SQL. String.

Valeur renvoyée Un tableau de tuples nommés (begin UInt64, end UInt64, type Enum8(...)) représentant les jetons de la requête. Array(Tuple(begin UInt64, end UInt64, type Enum8(...))) Exemples simple

Query

SELECT tokenizeQuery('SELECT 1')

Response

[(0,6,'BareWord'),(6,7,'Whitespace'),(7,8,'Number')]

transactionID

Introduit dans : v22.6.0 Renvoie l’ID d’une transaction.

Cette fonction fait partie d’un ensemble de fonctionnalités expérimentales. Activez la prise en charge expérimentale des transactions en ajoutant ce paramètre à votre configuration :

<clickhouse>
    <allow_experimental_transactions>1</allow_experimental_transactions>
</clickhouse>

Pour plus d’informations, consultez la page Prise en charge des transactions (ACID).

Syntaxe

transactionID()

Arguments

Aucun.

Valeur renvoyée Renvoie un tuple composé de start_csn, local_tid et host_id.

start_csn : Numéro séquentiel global, correspondant au timestamp de commit le plus récent observé au moment où cette transaction a commencé.
local_tid : Numéro séquentiel local, unique pour chaque transaction lancée par cet hôte pour un start_csn donné.
host_id : UUID de l’hôte qui a lancé cette transaction. Tuple(UInt64, UInt64, UUID)

Exemples Exemple d’utilisation

Query

BEGIN TRANSACTION;
SELECT transactionID();
ROLLBACK;

Response

┌─transactionID()────────────────────────────────┐
│ (32,34,'0ee8b069-f2bb-4748-9eae-069c85b5252b') │
└────────────────────────────────────────────────┘

transactionLatestSnapshot

Introduit dans : v22.6.0 Renvoie l’instantané le plus récent (Commit Sequence Number) d’une transaction disponible à la lecture.

Cette fonction fait partie d’un ensemble de fonctionnalités expérimentales. Activez la prise en charge expérimentale des transactions en ajoutant ce paramètre à votre configuration :

<clickhouse>
    <allow_experimental_transactions>1</allow_experimental_transactions>
</clickhouse>

Pour plus d’informations, consultez la page Prise en charge des transactions (ACID).

Syntaxe

transactionLatestSnapshot()

Arguments

Aucun.

Valeur renvoyée Renvoie l’instantané (CSN) le plus récent d’une transaction. UInt64 Exemples Exemple d’utilisation

Query

BEGIN TRANSACTION;
SELECT transactionLatestSnapshot();
ROLLBACK;

Response

┌─transactionLatestSnapshot()─┐
│                          32 │
└─────────────────────────────┘

transactionOldestSnapshot

Introduit dans : v22.6.0 Renvoie l’instantané le plus ancien (Commit Sequence Number) visible par une transaction en cours.

Cette fonction fait partie d’un ensemble de fonctionnalités expérimentales. Activez la prise en charge expérimentale des transactions en ajoutant ce paramètre à votre configuration :

<clickhouse>
    <allow_experimental_transactions>1</allow_experimental_transactions>
</clickhouse>

Pour plus d’informations, consultez la page Prise en charge des transactions (ACID).

Syntaxe

transactionOldestSnapshot()

Arguments

Aucun.

Valeur renvoyée Renvoie le plus ancien instantané (CSN) d’une transaction. UInt64 Exemples Exemple d’utilisation

Query

BEGIN TRANSACTION;
SELECT transactionOldestSnapshot();
ROLLBACK;

Response

┌─transactionOldestSnapshot()─┐
│                          32 │
└─────────────────────────────┘

transform

Introduite dans : v1.1.0 Transforme une valeur selon une correspondance explicitement définie entre certains éléments et d’autres. Il existe deux variantes de cette fonction :

transform(x, array_from, array_to, default) - transforme x à l’aide de tableaux de correspondance, avec une valeur par défaut pour les éléments sans correspondance
transform(x, array_from, array_to) - même transformation, mais renvoie la valeur d’origine de x si aucune correspondance n’est trouvée

La fonction recherche x dans array_from et renvoie l’élément correspondant de array_to au même indice. Si x n’est pas trouvé dans array_from, elle renvoie soit la valeur default (version à 4 paramètres), soit la valeur d’origine de x (version à 3 paramètres). Si plusieurs éléments correspondants existent dans array_from, elle renvoie l’élément associé à la première correspondance. Exigences :

array_from et array_to doivent contenir le même nombre d’éléments
Pour la version à 4 paramètres : transform(T, Array(T), Array(U), U) -> U où T et U peuvent être des types compatibles différents
Pour la version à 3 paramètres : transform(T, Array(T), Array(T)) -> T où tous les types doivent être identiques

Syntaxe

transform(x, array_from, array_to[, default])

Arguments

x — Valeur à transformer. (U)Int* ou Decimal ou Float* ou String ou Date ou DateTime
array_from — Tableau constant de valeurs dans lequel rechercher des correspondances. Array((U)Int*) ou Array(Decimal) ou Array(Float*) ou Array(String) ou Array(Date) ou Array(DateTime)
array_to — Tableau constant de valeurs à renvoyer pour les correspondances dans array_from. Array((U)Int*) ou Array(Decimal) ou Array(Float*) ou Array(String) ou Array(Date) ou Array(DateTime)
default — Facultatif. Valeur à renvoyer si x n’est pas trouvé dans array_from. S’il est omis, renvoie x inchangé. (U)Int* ou Decimal ou Float* ou String ou Date ou DateTime

Valeur renvoyée Renvoie la valeur correspondante de array_to si x correspond à un élément de array_from, sinon renvoie default (s’il est fourni) ou x (si default n’est pas fourni). Any Exemples transform(T, Array(T), Array(U), U) -> U

Query

SELECT
transform(SearchEngineID, [2, 3], ['Yandex', 'Google'], 'Other') AS title,
count() AS c
FROM test.hits
WHERE SearchEngineID != 0
GROUP BY title
ORDER BY c DESC

Response

┌─title─────┬──────c─┐
│ Yandex    │ 498635 │
│ Google    │ 229872 │
│ Other     │ 104472 │
└───────────┴────────┘

transform(T, Array(T), Array(T)) -> T

Query

SELECT
transform(domain(Referer), ['yandex.ru', 'google.ru', 'vkontakte.ru'], ['www.yandex', 'example.com', 'vk.com']) AS s, count() AS c
FROM test.hits
GROUP BY domain(Referer)
ORDER BY count() DESC
LIMIT 10

Response

┌─s──────────────┬───────c─┐
│                │ 2906259 │
│ www.yandex     │  867767 │
│ ███████.ru     │  313599 │
│ mail.yandex.ru │  107147 │
│ ██████.ru      │  100355 │
│ █████████.ru   │   65040 │
│ news.yandex.ru │   64515 │
│ ██████.net     │   59141 │
│ example.com    │   57316 │
└────────────────┴─────────┘

uniqThetaIntersect

Introduit dans : v22.9.0 Deux objets uniqThetaSketch permettent d’effectuer un calcul d’intersection (opération ensembliste ∩) ; le résultat est un nouvel objet uniqThetaSketch. Syntaxe

uniqThetaIntersect(uniqThetaSketch,uniqThetaSketch)

Arguments

uniqThetaSketch — objet uniqThetaSketch. Tuple ou Array ou Date ou DateTime ou String ou (U)Int* ou Float* ou Decimal

Valeur de retour Un nouvel objet uniqThetaSketch contenant le résultat de l’intersection. UInt64 Exemples Exemple d’utilisation

Query

SELECT finalizeAggregation(uniqThetaIntersect(a, b)) AS a_intersect_b, finalizeAggregation(a) AS a_cardinality, finalizeAggregation(b) AS b_cardinality
FROM
(SELECT arrayReduce('uniqThetaState', [1, 2]) AS a, arrayReduce('uniqThetaState', [2, 3, 4]) AS b);

Response

┌─a_intersect_b─┬─a_cardinality─┬─b_cardinality─┐
│             1 │             2 │             3 │
└───────────────┴───────────────┴───────────────┘

uniqThetaNot

Introduit dans : v22.9.0 Deux objets uniqThetaSketch permettant d’effectuer un calcul a_not_b (opération ensembliste ×) ; le résultat est un nouvel objet uniqThetaSketch. Syntaxe

uniqThetaNot(uniqThetaSketch,uniqThetaSketch)

Arguments

uniqThetaSketch — objet uniqThetaSketch. Tuple ou Array ou Date ou DateTime ou String ou (U)Int* ou Float* ou Decimal

Valeur renvoyée Renvoie un nouvel objet uniqThetaSketch contenant le résultat de a_not_b. UInt64 Exemples Exemple d’utilisation

Query

SELECT finalizeAggregation(uniqThetaNot(a, b)) AS a_not_b, finalizeAggregation(a) AS a_cardinality, finalizeAggregation(b) AS b_cardinality
FROM
(SELECT arrayReduce('uniqThetaState', [2, 3, 4]) AS a, arrayReduce('uniqThetaState', [1, 2]) AS b);

Response

┌─a_not_b─┬─a_cardinality─┬─b_cardinality─┐
│       2 │             3 │             2 │
└─────────┴───────────────┴───────────────┘

uniqThetaUnion

Introduit dans : v22.9.0 Prend deux objets uniqThetaSketch pour effectuer une union (opération ensembliste ∪) ; le résultat est un nouvel objet uniqThetaSketch. Syntaxe

uniqThetaUnion(uniqThetaSketch,uniqThetaSketch)

Arguments

uniqThetaSketch — objet uniqThetaSketch. Tuple ou Array ou Date ou DateTime ou String ou (U)Int* ou Float* ou Decimal

Valeur renvoyée Renvoie un nouvel objet uniqThetaSketch contenant le résultat de l’union. UInt64 Exemples Exemple d’utilisation

Query

SELECT finalizeAggregation(uniqThetaUnion(a, b)) AS a_union_b, finalizeAggregation(a) AS a_cardinality, finalizeAggregation(b) AS b_cardinality
FROM
(SELECT arrayReduce('uniqThetaState', [1, 2]) AS a, arrayReduce('uniqThetaState', [2, 3, 4]) AS b);

Response

┌─a_union_b─┬─a_cardinality─┬─b_cardinality─┐
│         4 │             2 │             3 │
└───────────┴───────────────┴───────────────┘

durée de fonctionnement

Introduit dans : v1.1.0 Renvoie la durée de fonctionnement du serveur en secondes. Si elle est exécutée dans le contexte d’une table distribuée, cette fonction génère une colonne normale avec des valeurs propres à chaque shard. Sinon, elle renvoie une valeur constante. Syntaxe

uptime()

Arguments

Aucun.

Valeur renvoyée Renvoie la durée de fonctionnement du serveur, en secondes. UInt32 Exemples Exemple d’utilisation

Query

SELECT uptime() AS Uptime

Response

┌─Uptime─┐
│  55867 │
└────────┘

variantElement

Introduit dans : v25.2.0 Extrait d’une colonne Variant une colonne du type spécifié. Syntaxe

variantElement(variant, type_name[, default_value])

Arguments

variant — Colonne Variant. Variant
type_name — Le nom du type de variante à extraire. String
default_value — La valeur par défaut utilisée si le variant ne contient pas de variante du type spécifié. Peut être de n’importe quel type. Facultatif. Any

Valeur renvoyée Renvoie une colonne contenant le type de variante spécifié extrait de la colonne Variant. Any Exemples Exemple d’utilisation

Query

CREATE TABLE test (v Variant(UInt64, String, Array(UInt64))) ENGINE = Memory;
INSERT INTO test VALUES (NULL), (42), ('Hello, World!'), ([1, 2, 3]);
SELECT v, variantElement(v, 'String'), variantElement(v, 'UInt64'), variantElement(v, 'Array(UInt64)') FROM test;

Response

┌─v─────────────┬─variantElement(v, 'String')─┬─variantElement(v, 'UInt64')─┬─variantElement(v, 'Array(UInt64)')─┐
│ ᴺᵁᴸᴸ          │ ᴺᵁᴸᴸ                        │                        ᴺᵁᴸᴸ │ []                                 │
│ 42            │ ᴺᵁᴸᴸ                        │                          42 │ []                                 │
│ Hello, World! │ Hello, World!               │                        ᴺᵁᴸᴸ │ []                                 │
│ [1,2,3]       │ ᴺᵁᴸᴸ                        │                        ᴺᵁᴸᴸ │ [1,2,3]                            │
└───────────────┴─────────────────────────────┴─────────────────────────────┴────────────────────────────────────┘

variantType

Introduit dans : v24.2.0 Renvoie le nom du type de variante pour chaque ligne d’une colonne Variant. Si une ligne contient NULL, la fonction renvoie ‘None’. Syntaxe

variantType(variant)

Arguments

variant — colonne Variant. Variant

Valeur renvoyée Renvoie une colonne Enum contenant, pour chaque ligne, le nom du type de variante. Enum Exemples Exemple d’utilisation

Query

CREATE TABLE test (v Variant(UInt64, String, Array(UInt64))) ENGINE = Memory;
INSERT INTO test VALUES (NULL), (42), ('Hello, World!'), ([1, 2, 3]);
SELECT variantType(v) FROM test;

Response

┌─variantType(v)─┐
│ None           │
│ UInt64         │
│ String         │
│ Array(UInt64)  │
└────────────────┘

version

Introduite dans : v1.1.0 Renvoie la version actuelle de ClickHouse sous la forme d’une chaîne au format : major_version.minor_version.patch_version.number_of_commits_since_the_previous_stable_release. Si elle est exécutée dans le contexte d’une table distribuée, cette fonction génère une colonne normale avec des valeurs propres à chaque shard. Sinon, elle renvoie une valeur constante. Syntaxe

version()

Arguments

Aucun.

Valeur renvoyée Renvoie la version actuelle de ClickHouse. String Exemples Exemple d’utilisation

Query

SELECT version()

Response

┌─version()─┐
│ 24.2.1.1  │
└───────────┘

visibleWidth

Introduit dans : v1.1.0 Calcule la largeur approximative lors de la sortie des valeurs dans la console au format texte (séparé par des tabulations). Cette fonction est utilisée par le système pour implémenter les formats Pretty. NULL est représenté sous la forme d’une chaîne correspondant à NULL dans les formats Pretty. Syntaxe

visibleWidth(x)

Arguments

x — Une valeur de n’importe quel type de données. Any

Valeur renvoyée Renvoie la largeur approximative de la valeur lorsqu’elle est affichée au format texte. UInt64 Exemples Calcul de la largeur visible de NULL

Query

SELECT visibleWidth(NULL)

Response

┌─visibleWidth(NULL)─┐
│                  4 │
└────────────────────┘

zookeeperSessionUptime

Introduite dans : v21.11.0 Renvoie la durée de fonctionnement de la session ZooKeeper actuelle, en secondes. Syntaxe

zookeeperSessionUptime()

Arguments

Aucun.

Valeur renvoyée Renvoie la durée de fonctionnement de la session ZooKeeper actuelle, en secondes. UInt32 Exemples Exemple d’utilisation

Query

SELECT zookeeperSessionUptime();

Response

┌─zookeeperSessionUptime()─┐
│                      286 │
└──────────────────────────┘

Dernière modification le 25 juin 2026

Nombre aléatoireDocumentation des fonctions utilisées pour générer des nombres aléatoires

​FQDN

​MACNumToString

​MACStringToNum

​MACStringToOUI

​authenticatedUser

​bar

​blockNumber

​blockSerializedSize

​blockSize

​buildId

​byteSize

​catboostEvaluate

​colorOKLABToSRGB

​colorOKLCHToSRGB

​colorSRGBToOKLAB

​colorSRGBToOKLCH

​connectionId

​countDigits

​currentDatabase

​currentProfiles

​currentQueryID

​currentRoles

​currentSchemas

​currentUser

​defaultProfiles

​defaultRoles

​defaultValueOfArgumentType

​defaultValueOfTypeName

​displayName

​dumpColumnStructure

​enabledProfiles

​enabledRoles

​errorCodeToName

​file

​filesystemAvailable

​filesystemCapacity

​filesystemUnreserved

​finalizeAggregation

​flipCoordinates

​formatQuery

​formatQueryOrNull

​formatQuerySingleLine

​formatQuerySingleLineOrNull

​formatReadableDecimalSize

​formatReadableQuantity

​formatReadableSize

​formatReadableTimeDelta

​fuzzQuery

​generateRandomStructure

​generateSerialID

​getClientHTTPHeader

​getMacro

​getMaxTableNameLengthForDatabase

​getMergeTreeSetting

​getOSKernelVersion

​getServerPort

​getServerSetting

​getSetting

​getSettingOrDefault

​getSizeOfEnumType

​getSubcolumn

​getTypeSerializationStreams

​globalVariable

​hasColumnInTable

​hasThreadFuzzer

​highlightQuery

​hostName

​icebergBucket

​icebergTruncate

​identity

​ignore

​indexHint

​initialQueryID

​initialQueryStartTime

​initializeAggregation

​isConstant

​isDecimalOverflow

​joinGet

​joinGetOrNull

​lowCardinalityIndices

FQDN

MACNumToString

MACStringToNum

MACStringToOUI

authenticatedUser

bar

blockNumber

blockSerializedSize

blockSize

buildId

byteSize

catboostEvaluate

colorOKLABToSRGB

colorOKLCHToSRGB

colorSRGBToOKLAB

colorSRGBToOKLCH

connectionId

countDigits

currentDatabase

currentProfiles

currentQueryID

currentRoles

currentSchemas

currentUser

defaultProfiles

defaultRoles

defaultValueOfArgumentType

defaultValueOfTypeName

displayName

dumpColumnStructure

enabledProfiles

enabledRoles

errorCodeToName

file

filesystemAvailable

filesystemCapacity

filesystemUnreserved

finalizeAggregation

flipCoordinates

formatQuery

formatQueryOrNull

formatQuerySingleLine

formatQuerySingleLineOrNull

formatReadableDecimalSize

formatReadableQuantity

formatReadableSize

formatReadableTimeDelta

fuzzQuery

generateRandomStructure

generateSerialID

getClientHTTPHeader

getMacro

getMaxTableNameLengthForDatabase

getMergeTreeSetting

getOSKernelVersion

getServerPort

getServerSetting

getSetting

getSettingOrDefault

getSizeOfEnumType

getSubcolumn

getTypeSerializationStreams

globalVariable

hasColumnInTable

hasThreadFuzzer

highlightQuery

hostName

icebergBucket

icebergTruncate

identity

ignore

indexHint

initialQueryID

initialQueryStartTime

initializeAggregation

isConstant

isDecimalOverflow

joinGet

joinGetOrNull

lowCardinalityIndices