Scripts de démarrage

Guide de configuration et d’utilisation des scripts SQL de démarrage dans ClickHouse pour la création automatique du schéma et les migrations

ClickHouse peut exécuter au démarrage des requêtes SQL arbitraires à partir de la configuration du serveur. Cela peut être utile pour les migrations ou la création automatique du schéma.

<clickhouse>
    <startup_scripts>
        <throw_on_error>false</throw_on_error>
        <scripts>
            <query>CREATE ROLE OR REPLACE test_role</query>
        </scripts>
        <scripts>
            <query>CREATE TABLE TestTable (id UInt64) ENGINE=TinyLog</query>
            <condition>SELECT 1;</condition>
        </scripts>
        <scripts>
            <query>CREATE DICTIONARY test_dict (...) SOURCE(CLICKHOUSE(...))</query>
            <user>default</user>
        </scripts>
    </startup_scripts>
</clickhouse>

ClickHouse exécute toutes les requêtes de startup_scripts de manière séquentielle dans l’ordre spécifié. Si l’une des requêtes échoue, l’exécution des requêtes suivantes ne sera pas interrompue. Cependant, si throw_on_error est défini sur true, le serveur ne démarrera pas si une erreur se produit pendant l’exécution du script.

Vous pouvez spécifier une requête conditionnelle dans la config. Dans ce cas, la requête correspondante ne s’exécute que lorsque la requête de condition renvoie la valeur 1 ou true.

Si la requête de condition renvoie une valeur autre que 1 ou true, le résultat sera interprété comme false, et la requête correspondante ne sera pas exécutée.