Autres paramètres du serveur

Paramètres du serveur ClickHouse du groupe généré « Other ».

Ces paramètres configurent le serveur ClickHouse et sont générés automatiquement à partir du code source de ClickHouse.

​

abort_on_logical_error

Fait planter le serveur en cas d’exception LOGICAL_ERROR. Réservé aux experts.

​

allowed_disks_for_table_engines

Liste des disques pouvant être utilisés avec Iceberg

​

auth_use_forwarded_address

Utiliser l’adresse d’origine pour l’authentification des clients connectés via un proxy.

Ce paramètre doit être utilisé avec une extrême prudence, car les adresses transmises peuvent être facilement usurpées : les serveurs qui acceptent ce type d’authentification ne doivent pas être accessibles directement, mais uniquement via un proxy de confiance.

​

bcrypt_workfactor

Facteur de travail pour le type d’authentification bcrypt_password, qui utilise l’algorithme Bcrypt. Le facteur de travail détermine la quantité de calculs et le temps nécessaires pour calculer le hachage et vérifier le mot de passe.

<bcrypt_workfactor>12</bcrypt_workfactor>

Pour les applications qui nécessitent des authentifications fréquentes, envisagez d’autres méthodes d’authentification en raison du coût de calcul de bcrypt avec des facteurs de coût élevés.

​

blob_storage_log

Paramètres de la table système blob_storage_log.

Les paramètres suivants peuvent être configurés via des sous-balises :

Paramètre	Description	Valeur par défaut	Remarque
database	Nom de la base de données.
table	Nom de la table système.
engine	Définition du moteur MergeTree pour une table système.		Ne peut pas être utilisé si partition_by ou order_by est défini. S’il n’est pas spécifié, MergeTree est sélectionné par défaut
partition_by	Clé de partitionnement personnalisée pour une table système.		Si engine est spécifié pour la table système, le paramètre partition_by doit être indiqué directement dans ‘engine’
ttl	Spécifie le TTL de la table.		Si engine est spécifié pour la table système, le paramètre ttl doit être indiqué directement dans ‘engine’
order_by	Clé de tri personnalisée pour une table système. Ne peut pas être utilisée si engine est défini.		Si engine est spécifié pour la table système, le paramètre order_by doit être indiqué directement dans ‘engine’
storage_policy	Nom de la politique de stockage à utiliser pour la table (facultatif).		Si engine est spécifié pour la table système, le paramètre storage_policy doit être indiqué directement dans ‘engine’
settings	Paramètres supplémentaires qui contrôlent le comportement de MergeTree (facultatif).		Si engine est spécifié pour la table système, le paramètre settings doit être indiqué directement dans ‘engine’
flush_interval_milliseconds	Intervalle de vidage des données du tampon en mémoire vers la table.	7500
max_size_rows	Taille maximale en lignes pour les logs. Lorsque la quantité de logs non vidés atteint max_size_rows, les logs sont écrits sur le disque.	1048576
reserved_size_rows	Taille de mémoire préallouée en lignes pour les logs.	8192
buffer_size_rows_flush_threshold	Seuil du nombre de lignes. Si ce seuil est atteint, le vidage des logs sur le disque est lancé en arrière-plan.	max_size_rows / 2
flush_on_crash	Définit si les logs doivent être écrits sur le disque en cas de crash.	false

De plus, le paramètre suivant au niveau du serveur contrôle la politique de vidage par défaut pour toutes les tables de journal système :

<default_system_log_flush_policy>
    <skip_alias_columns>true</skip_alias_columns>
</default_system_log_flush_policy>

Paramètre	Description	Par défaut
skip_alias_columns	Lorsque true, les colonnes ALIAS sont omises des schémas des tables de logs système. Requis pour les logs système basés sur S3.	false

Exemple :

<blob_storage_log>
    <database>system</database
    <table>blob_storage_log</table
    <partition_by>toYYYYMM(event_date)</partition_by>
    <flush_interval_milliseconds>7500</flush_interval_milliseconds
    <ttl>event_date + INTERVAL 30 DAY</ttl>
</blob_storage_log>

​

builtin_dictionaries_reload_interval

Intervalle, en secondes, avant le rechargement des dictionnaires intégrés.

ClickHouse recharge les dictionnaires intégrés toutes les x secondes. Cela permet de modifier les dictionnaires “à la volée” sans redémarrer le serveur.

Exemple

<builtin_dictionaries_reload_interval>3600</builtin_dictionaries_reload_interval>

​

cache_size_to_ram_max_ratio

Définit le ratio maximal de la taille du cache par rapport à la RAM. Permet de réduire la taille du cache sur les systèmes disposant de peu de RAM.

​

cannot_allocate_thread_fault_injection_probability

À des fins de test.

​

cgroups_memory_usage_observer_wait_time

Intervalle, en secondes, pendant lequel la consommation mémoire maximale autorisée du serveur est ajustée en fonction du seuil correspondant dans les cgroups.

Pour désactiver l’observateur de cgroups, définissez cette valeur sur 0.

​

compression

Paramètres de compression des données pour les tables du moteur MergeTree.

Nous vous recommandons de ne pas modifier ce paramètre si vous venez de commencer à utiliser ClickHouse.

Modèle de configuration:

<compression>
    <case>
      <min_part_size>...</min_part_size>
      <min_part_size_ratio>...</min_part_size_ratio>
      <method>...</method>
      <level>...</level>
    </case>
    ...
</compression>

Champs de <case> :

• min_part_size – Taille minimale d’une partie de données.
• min_part_size_ratio – Ratio entre la taille de la partie de données et la taille de la table.
• method – Méthode de compression. Valeurs acceptables : lz4, lz4hc, zstd,deflate_qpl.
• level – Niveau de compression. Voir Codecs.

Vous pouvez configurer plusieurs sections <case>.

Actions lorsque les conditions sont remplies :

• Si une partie de données correspond à un ensemble de conditions, ClickHouse utilise la méthode de compression indiquée.
• Si une partie de données correspond à plusieurs ensembles de conditions, ClickHouse utilise le premier ensemble correspondant.

Si aucune condition n’est remplie pour une partie de données, ClickHouse utilise la compression lz4.

Exemple

<compression incl="clickhouse_compression">
    <case>
        <min_part_size>10000000000</min_part_size>
        <min_part_size_ratio>0.01</min_part_size_ratio>
        <method>zstd</method>
        <level>1</level>
    </case>
</compression>

​

config_reload_interval_ms

Fréquence à laquelle ClickHouse recharge la configuration et vérifie la présence de nouvelles modifications

​

config-file

Indique le fichier de configuration du serveur.

​

core_dump

Configure la limite souple de la taille du fichier core dump.

La limite stricte se configure via les outils système

Exemple

<core_dump>
     <size_limit>1073741824</size_limit>
</core_dump>

​

crash_log

Paramètres de fonctionnement de la table système crash_log.

Les paramètres suivants peuvent être configurés à l’aide de sous-balises :

Paramètre	Description	Valeur par défaut	Remarque
buffer_size_rows_flush_threshold	Seuil du nombre de lignes. Si ce seuil est atteint, l’écriture des logs sur disque est déclenchée en arrière-plan.	max_size_rows / 2
database	Nom de la base de données.
engine	Définition du moteur MergeTree pour une table système.		Ne peut pas être utilisé si partition_by ou order_by est défini. Si rien n’est spécifié, MergeTree est sélectionné par défaut
flush_interval_milliseconds	Intervalle d’écriture des données du buffer en mémoire vers la table.	7500
flush_on_crash	Définit si les logs doivent être écrits sur disque en cas de plantage.	false
max_size_rows	Taille maximale des logs, en lignes. Lorsque le nombre de logs non écrits atteint max_size, les logs sont écrits sur disque.	1024
order_by	Clé de tri personnalisée pour une table système. Ne peut pas être utilisé si engine est défini.		Si engine est spécifié pour la table système, le paramètre order_by doit être indiqué directement dans ‘engine’
partition_by	Clé de partitionnement personnalisée pour une table système.		Si engine est spécifié pour la table système, le paramètre partition_by doit être indiqué directement dans ‘engine’
reserved_size_rows	Taille de mémoire préallouée pour les logs, en lignes.	1024
settings	Paramètres supplémentaires qui contrôlent le comportement de MergeTree (facultatif).		Si engine est spécifié pour la table système, le paramètre settings doit être indiqué directement dans ‘engine’
storage_policy	Nom de la politique de stockage à utiliser pour la table (facultatif).		Si engine est spécifié pour la table système, le paramètre storage_policy doit être indiqué directement dans ‘engine’
table	Nom de la table système.
ttl	Spécifie le TTL de la table.		Si engine est spécifié pour la table système, le paramètre ttl doit être indiqué directement dans ‘engine’

Le fichier de configuration du serveur config.xml contient la section de paramètres suivante :

<crash_log>
    <database>system</database>
    <table>crash_log</table>
    <partition_by>toYYYYMM(event_date)</partition_by>
    <flush_interval_milliseconds>7500</flush_interval_milliseconds>
    <max_size_rows>1024</max_size_rows>
    <reserved_size_rows>1024</reserved_size_rows>
    <buffer_size_rows_flush_threshold>512</buffer_size_rows_flush_threshold>
    <flush_on_crash>false</flush_on_crash>
</crash_log>

​

database_atomic_delay_before_drop_table_sec

Le délai pendant lequel une table supprimée peut être restaurée à l’aide de l’instruction UNDROP. Si DROP TABLE a été exécuté avec le modificateur SYNC, ce paramètre est ignoré. La valeur par défaut de ce paramètre est de 480 (8 minutes).

​

dead_letter_queue

Paramètres de la table système ‘dead_letter_queue’.

Les paramètres suivants peuvent être configurés via des sous-balises :

Paramètre	Description	Valeur par défaut	Remarque
database	Nom de la base de données.
table	Nom de la table système.
engine	Définition du moteur MergeTree pour une table système.		Ne peut pas être utilisé si partition_by ou order_by est défini. S’il n’est pas spécifié, MergeTree est sélectionné par défaut
partition_by	Clé de partitionnement personnalisée pour une table système.		Si engine est spécifié pour la table système, le paramètre partition_by doit être indiqué directement dans ‘engine’
ttl	Spécifie le TTL de la table.		Si engine est spécifié pour la table système, le paramètre ttl doit être indiqué directement dans ‘engine’
order_by	Clé de tri personnalisée pour une table système. Ne peut pas être utilisée si engine est défini.		Si engine est spécifié pour la table système, le paramètre order_by doit être indiqué directement dans ‘engine’
storage_policy	Nom de la politique de stockage à utiliser pour la table (facultatif).		Si engine est spécifié pour la table système, le paramètre storage_policy doit être indiqué directement dans ‘engine’
settings	Paramètres supplémentaires qui contrôlent le comportement de MergeTree (facultatif).		Si engine est spécifié pour la table système, le paramètre settings doit être indiqué directement dans ‘engine’
flush_interval_milliseconds	Intervalle de vidage des données du tampon en mémoire vers la table.	7500
max_size_rows	Taille maximale en lignes pour les logs. Lorsque la quantité de logs non vidés atteint max_size_rows, les logs sont écrits sur le disque.	1048576
reserved_size_rows	Taille de mémoire préallouée en lignes pour les logs.	8192
buffer_size_rows_flush_threshold	Seuil du nombre de lignes. Si ce seuil est atteint, le vidage des logs sur le disque est lancé en arrière-plan.	max_size_rows / 2
flush_on_crash	Définit si les logs doivent être écrits sur le disque en cas de crash.	false

De plus, le paramètre suivant au niveau du serveur contrôle la politique de vidage par défaut pour toutes les tables de journal système :

<default_system_log_flush_policy>
    <skip_alias_columns>true</skip_alias_columns>
</default_system_log_flush_policy>

Paramètre	Description	Par défaut
skip_alias_columns	Lorsque true, les colonnes ALIAS sont omises des schémas des tables de logs système. Requis pour les logs système basés sur S3.	false

Les paramètres par défaut sont :

<dead_letter_queue>
    <database>system</database>
    <table>dead_letter</table>
    <partition_by>toYYYYMM(event_date)</partition_by>
    <flush_interval_milliseconds>7500</flush_interval_milliseconds>
</dead_letter_queue>

​

dictionary_background_reconnect_interval

Intervalle, en millisecondes, entre les tentatives de reconnexion des dictionnaires MySQL et Postgres en échec pour lesquels background_reconnect est activé.

​

disk_transaction_wait_for_blob_removal

Valeur par défaut du paramètre wait_for_blob_removal pour chaque disque. Lorsqu’il est activé, le serveur attend que la suppression du blob en arrière-plan soit terminée avant de confirmer l’opération.

​

display_secrets_in_show_and_select

Active ou désactive l’affichage des secrets dans les requêtes SHOW et SELECT pour les tables, les bases de données, les fonctions de table et les dictionnaires.

Pour voir les secrets, l’utilisateur doit également avoir activé le paramètre de format format_display_secrets_in_show_and_select et disposer du privilège displaySecretsInShowAndSelect.

Valeurs possibles :

• 0 — Désactivé.
• 1 — Activé.

​

dns_max_consecutive_failures

Interrompt les tentatives ultérieures de mise à jour du cache DNS d’un nom d’hôte après ce nombre d’échecs consécutifs. Les informations restent toutefois dans le cache DNS. Zéro signifie sans limite.

Voir aussi

• SYSTEM DROP DNS CACHE

​

dynamic_user_defined_executable_functions_path

Le répertoire utilisé pour stocker les fichiers de configuration des UDF exécutables créées dynamiquement par des drivers (voir CREATE FUNCTION ... ENGINE = DriverName(...)). Au redémarrage du serveur, le répertoire est parcouru pour rechercher les fichiers de configuration, et les UDF correspondantes sont chargées sans réinvocation du driver.

Exemple

<dynamic_user_defined_executable_functions_path>/var/lib/clickhouse/dynamic_user_defined_executable_functions/</dynamic_user_defined_executable_functions_path>

​

chiffrement

Configure une commande permettant d’obtenir une clé à utiliser avec les codecs de chiffrement. La ou les clés doivent être stockées dans des variables d’environnement ou définies dans le fichier de configuration.

Les clés peuvent être hexadécimales ou être des chaînes de 16 octets de long.

Exemple

Chargement depuis le fichier de configuration :

<encryption_codecs>
    <aes_128_gcm_siv>
        <key>1234567812345678</key>
    </aes_128_gcm_siv>
</encryption_codecs>

Il n’est pas recommandé de stocker des clés dans le fichier de configuration. Ce n’est pas sûr. Vous pouvez placer les clés dans un fichier de configuration distinct sur un disque sécurisé, puis créer un lien symbolique vers ce fichier de configuration dans le dossier config.d/.

Chargement depuis la configuration, lorsque la clé est au format hexadécimal :

<encryption_codecs>
    <aes_128_gcm_siv>
        <key_hex>00112233445566778899aabbccddeeff</key_hex>
    </aes_128_gcm_siv>
</encryption_codecs>

Chargement de la clé depuis la variable d’environnement :

<encryption_codecs>
    <aes_128_gcm_siv>
        <key_hex from_env="ENVVAR"></key_hex>
    </aes_128_gcm_siv>
</encryption_codecs>

Ici, current_key_id définit la clé courante pour le chiffrement, et toutes les clés spécifiées peuvent être utilisées pour le déchiffrement.

Chacune de ces méthodes peut être utilisée avec plusieurs clés :

<encryption_codecs>
    <aes_128_gcm_siv>
        <key_hex id="0">00112233445566778899aabbccddeeff</key_hex>
        <key_hex id="1" from_env="ENVVAR"></key_hex>
        <current_key_id>1</current_key_id>
    </aes_128_gcm_siv>
</encryption_codecs>

Ici, current_key_id indique la clé actuellement utilisée pour le chiffrement.

Les utilisateurs peuvent également ajouter un nonce, qui doit comporter 12 octets (par défaut, les processus de chiffrement et de déchiffrement utilisent un nonce composé d’octets nuls) :

<encryption_codecs>
    <aes_128_gcm_siv>
        <nonce>012345678910</nonce>
    </aes_128_gcm_siv>
</encryption_codecs>

Ou il peut être défini en hexadécimal :

<encryption_codecs>
    <aes_128_gcm_siv>
        <nonce_hex>abcdefabcdef</nonce_hex>
    </aes_128_gcm_siv>
</encryption_codecs>

Tout ce qui précède peut s’appliquer à aes_256_gcm_siv (mais la clé doit faire 32 octets).

​

enforce_keeper_component_tracking

Si cette option est activée, chaque requête ZooKeeper doit avoir un nom de composant défini via Coordination::setCurrentComponent. Déclenche une exception LOGICAL_ERROR si le nom du composant est manquant.

​

error_log

Il est désactivé par défaut.

Activation

Pour activer manuellement la collecte de l’historique des erreurs dans system.error_log, créez /etc/clickhouse-server/config.d/error_log.xml avec le contenu suivant :

<clickhouse>
    <error_log>
        <database>system</database>
        <table>error_log</table>
        <flush_interval_milliseconds>7500</flush_interval_milliseconds>
        <collect_interval_milliseconds>1000</collect_interval_milliseconds>
        <max_size_rows>1048576</max_size_rows>
        <reserved_size_rows>8192</reserved_size_rows>
        <buffer_size_rows_flush_threshold>524288</buffer_size_rows_flush_threshold>
        <flush_on_crash>false</flush_on_crash>
    </error_log>
</clickhouse>

Désactivation

Pour désactiver le paramètre error_log, créez le fichier suivant /etc/clickhouse-server/config.d/disable_error_log.xml avec le contenu ci-dessous :

<clickhouse>
    <error_log remove="1" />
</clickhouse>

Les paramètres suivants peuvent être configurés via des sous-balises :

Paramètre	Description	Valeur par défaut	Remarque
database	Nom de la base de données.
table	Nom de la table système.
engine	Définition du moteur MergeTree pour une table système.		Ne peut pas être utilisé si partition_by ou order_by est défini. S’il n’est pas spécifié, MergeTree est sélectionné par défaut
partition_by	Clé de partitionnement personnalisée pour une table système.		Si engine est spécifié pour la table système, le paramètre partition_by doit être indiqué directement dans ‘engine’
ttl	Spécifie le TTL de la table.		Si engine est spécifié pour la table système, le paramètre ttl doit être indiqué directement dans ‘engine’
order_by	Clé de tri personnalisée pour une table système. Ne peut pas être utilisée si engine est défini.		Si engine est spécifié pour la table système, le paramètre order_by doit être indiqué directement dans ‘engine’
storage_policy	Nom de la politique de stockage à utiliser pour la table (facultatif).		Si engine est spécifié pour la table système, le paramètre storage_policy doit être indiqué directement dans ‘engine’
settings	Paramètres supplémentaires qui contrôlent le comportement de MergeTree (facultatif).		Si engine est spécifié pour la table système, le paramètre settings doit être indiqué directement dans ‘engine’
flush_interval_milliseconds	Intervalle de vidage des données du tampon en mémoire vers la table.	7500
max_size_rows	Taille maximale en lignes pour les logs. Lorsque la quantité de logs non vidés atteint max_size_rows, les logs sont écrits sur le disque.	1048576
reserved_size_rows	Taille de mémoire préallouée en lignes pour les logs.	8192
buffer_size_rows_flush_threshold	Seuil du nombre de lignes. Si ce seuil est atteint, le vidage des logs sur le disque est lancé en arrière-plan.	max_size_rows / 2
flush_on_crash	Définit si les logs doivent être écrits sur le disque en cas de crash.	false

De plus, le paramètre suivant au niveau du serveur contrôle la politique de vidage par défaut pour toutes les tables de journal système :

<default_system_log_flush_policy>
    <skip_alias_columns>true</skip_alias_columns>
</default_system_log_flush_policy>

Paramètre	Description	Par défaut
skip_alias_columns	Lorsque true, les colonnes ALIAS sont omises des schémas des tables de logs système. Requis pour les logs système basés sur S3.	false

​

filesystem_caches_path

Ce paramètre définit le chemin du cache.

Exemple

<filesystem_caches_path>/var/lib/clickhouse/filesystem_caches/</filesystem_caches_path>

​

google_protos_path

Définit un répertoire contenant des fichiers .proto pour les types Protobuf.

Exemple

<google_protos_path>/usr/share/clickhouse/protos/</google_protos_path>

​

handshake_timeout_milliseconds

Délai d’expiration en millisecondes, mesuré en temps réel, pour l’ensemble de la phase de handshake TCP (Hello + Addendum). Limite la durée pendant laquelle une connexion non authentifiée peut occuper un thread. Définissez-la sur 0 pour la désactiver.

​

hdfs.libhdfs3_conf

Dirige libhdfs3 vers l’emplacement correct de sa configuration.

​

hsts_max_age

Durée d’expiration de HSTS, en secondes.

Une valeur de 0 signifie que ClickHouse désactive HSTS. Si vous définissez une valeur positive, HSTS sera activé et max-age prendra cette valeur.

Exemple

<hsts_max_age>600000</hsts_max_age>

​

iceberg_background_schedule_pool_size

Taille du pool de threads utilisé pour récupérer de manière asynchrone les métadonnées les plus récentes depuis un catalogue Iceberg distant ; le pool est partagé par toutes les tables actives.

​

ignore_empty_sql_security_in_create_view_query

Si la valeur est true, ClickHouse n’écrit pas les valeurs par défaut lorsqu’une instruction SQL security est vide dans les requêtes CREATE VIEW.

Ce paramètre n’est nécessaire que durant la période de migration et deviendra obsolète à partir de la version 24.4

​

include_from

Chemin vers le fichier contenant les substitutions. Les formats XML et YAML sont pris en charge.

Pour plus d’informations, consultez la section Fichiers de configuration.

Exemple

<include_from>/etc/metrica.xml</include_from>

​

insert_deduplication_version

Garde-fou de migration obsolète. Cette version ne prend en charge que le hash unifié de déduplication des insertions (new_unified_hash) ; le serveur refuse de démarrer si ce paramètre est présent avec une autre valeur (comme old_separate_hashes ou compatible_double_hashes). Terminez la migration de déduplication sur la version précédente avant la mise à niveau en exécutant compatible_double_hashes (qui écrit à la fois les hash legacy et unifiés). Pour les tables répliquées, exécutez-le pendant au moins replicated_deduplication_window_seconds (une heure par défaut) ; les fenêtres par défaut conservent les hash unifiés de toutes les insertions pendant cette période, ce qui est considéré comme suffisant pour couvrir une boucle de nouvelle tentative d’insert. Pour les tables non répliquées avec non_replicated_deduplication_window > 0, la fenêtre est basée sur le nombre d’insertions plutôt que sur le temps ; exécutez donc compatible_double_hashes pendant au moins ce nombre d’insertions avant la mise à niveau.

​

io_thread_pool_queue_size

Le nombre maximal de jobs pouvant être planifiés dans l’IO Thread pool.

Une valeur de 0 signifie qu’il n’y a pas de limite.

​

keep_alive_timeout

Le nombre de secondes pendant lesquelles ClickHouse attend des requêtes entrantes via le protocole HTTP avant de fermer la connexion.

Exemple

<keep_alive_timeout>30</keep_alive_timeout>

​

ldap_servers

Listez ici les serveurs LDAP avec leurs paramètres de connexion afin de :

• les utiliser comme authentificateurs pour des utilisateurs locaux dédiés, pour lesquels un mécanisme d’authentication ldap est spécifié à la place de password
• les utiliser comme répertoires d’utilisateurs distants.

Les paramètres suivants peuvent être configurés à l’aide de sous-balises :

Setting	Description
bind_dn	Modèle utilisé pour construire le DN à utiliser pour l’opération de bind. Le DN résultant sera construit en remplaçant toutes les sous-chaînes \{user_name\} du modèle par le nom d’utilisateur réel lors de chaque tentative d’authentication.
enable_tls	Indicateur déclenchant l’utilisation d’une connexion sécurisée au serveur LDAP. Spécifiez no pour le protocole en texte brut (ldap://) (non recommandé). Spécifiez yes pour le protocole LDAP sur SSL/TLS (ldaps://) (recommandé, valeur par défaut). Spécifiez starttls pour l’ancien protocole StartTLS (protocole en texte brut (ldap://), mis à niveau vers TLS).
host	Nom d’hôte ou IP du serveur LDAP ; ce paramètre est obligatoire et ne peut pas être vide.
port	Port du serveur LDAP ; la valeur par défaut est 636 si enable_tls est défini sur true, 389 sinon.
tls_ca_cert_dir	chemin vers le répertoire contenant les certificats d’autorité de certification.
tls_ca_cert_file	chemin vers le fichier de certificat d’autorité de certification.
tls_cert_file	chemin vers le fichier de certificat.
tls_cipher_suite	suite de chiffrement autorisée (en notation OpenSSL).
tls_key_file	chemin vers le fichier de clé du certificat.
tls_minimum_protocol_version	Version minimale du protocole SSL/TLS. Les valeurs acceptées sont : ssl2, ssl3, tls1.0, tls1.1, tls1.2 (valeur par défaut).
tls_require_cert	Comportement de vérification du certificat pair SSL/TLS. Les valeurs acceptées sont : never, allow, try, demand (valeur par défaut).
user_dn_detection	Section contenant les paramètres de recherche LDAP pour détecter le DN utilisateur réel de l’utilisateur lié. Cela est principalement utilisé dans les filtres de recherche pour un mappage de rôles ultérieur lorsque le serveur est Active Directory. Le DN utilisateur résultant sera utilisé lors du remplacement des sous-chaînes \{user_dn\} partout où elles sont autorisées. Par défaut, le DN utilisateur est défini comme étant égal au bind DN, mais une fois la recherche effectuée, il sera mis à jour avec la valeur réelle du DN utilisateur détecté.
verification_cooldown	Période, en secondes, après une tentative de bind réussie, pendant laquelle un utilisateur sera considéré comme authenticated avec succès pour toutes les requêtes consécutives sans contacter le serveur LDAP. Spécifiez 0 (valeur par défaut) pour désactiver la mise en cache et forcer le contact avec le serveur LDAP pour chaque requête d’authentication.

Le paramètre user_dn_detection peut être configuré avec des sous-balises :

Setting	Description
base_dn	modèle utilisé pour construire le base DN pour la recherche LDAP. Le DN résultant sera construit en remplaçant toutes les sous-chaînes \{user_name\} et \{bind_dn\} du modèle par le nom d’utilisateur réel et le bind DN pendant la recherche LDAP.
scope	portée de la recherche LDAP. Les valeurs acceptées sont : base, one_level, children, subtree (valeur par défaut).
search_filter	modèle utilisé pour construire le filtre de recherche pour la recherche LDAP. Le filtre résultant sera construit en remplaçant toutes les sous-chaînes \{user_name\}, \{bind_dn\} et \{base_dn\} du modèle par le nom d’utilisateur réel, le bind DN et le base DN pendant la recherche LDAP. Notez que les caractères spéciaux doivent être correctement échappés en XML.

Exemple :

<my_ldap_server>
    <host>localhost</host>
    <port>636</port>
    <bind_dn>uid={user_name},ou=users,dc=example,dc=com</bind_dn>
    <verification_cooldown>300</verification_cooldown>
    <enable_tls>yes</enable_tls>
    <tls_minimum_protocol_version>tls1.2</tls_minimum_protocol_version>
    <tls_require_cert>demand</tls_require_cert>
    <tls_cert_file>/path/to/tls_cert_file</tls_cert_file>
    <tls_key_file>/path/to/tls_key_file</tls_key_file>
    <tls_ca_cert_file>/path/to/tls_ca_cert_file</tls_ca_cert_file>
    <tls_ca_cert_dir>/path/to/tls_ca_cert_dir</tls_ca_cert_dir>
    <tls_cipher_suite>ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:AES256-GCM-SHA384</tls_cipher_suite>
</my_ldap_server>

Exemple (cas typique d’Active Directory avec détection du DN utilisateur configurée en vue d’un mappage de rôles ultérieur) :

<my_ad_server>
    <host>localhost</host>
    <port>389</port>
    <bind_dn>EXAMPLE\{user_name}</bind_dn>
    <user_dn_detection>
        <base_dn>CN=Users,DC=example,DC=com</base_dn>
        <search_filter>(&amp;(objectClass=user)(sAMAccountName={user_name}))</search_filter>
    </user_dn_detection>
    <enable_tls>no</enable_tls>
</my_ad_server>

​

logger

L’emplacement et le format des messages de log.

Clés :

Clé	Description
async	Lorsque true (par défaut), la journalisation s’effectue de manière asynchrone (un thread d’arrière-plan par canal de sortie). Sinon, elle s’effectue dans le thread qui appelle LOG
async_queue_max_size	En cas d’utilisation de la journalisation asynchrone, nombre maximal de messages conservés dans la file d’attente avant le flush. Les messages supplémentaires seront ignorés
console	Active la journalisation vers la console. Définissez la valeur sur 1 ou true pour l’activer. La valeur par défaut est 1 si ClickHouse ne s’exécute pas en mode démon, 0 sinon.
console_log_level	Niveau de journalisation pour la sortie console. La valeur par défaut est level.
console_shutdown_log_level	Le niveau d’arrêt est utilisé pour définir le niveau de journalisation de la console lors de l’arrêt du serveur.
console_startup_log_level	Le niveau de démarrage est utilisé pour définir le niveau de journalisation de la console au démarrage du serveur. Après le démarrage, le niveau de journalisation revient au paramètre console_log_level
count	Politique de rotation : nombre maximal de fichiers de log historiques conservés par ClickHouse.
errorlog	Le chemin du fichier de log des erreurs.
formatting.type	Format de log pour la sortie console. Actuellement, seul json est pris en charge
level	Niveau de journalisation. Valeurs acceptées : none (désactive la journalisation), fatal, critical, error, warning, notice, information,debug, trace, test
log	Le chemin du fichier de log.
rotation	Politique de rotation : détermine quand les fichiers de log sont rotatés. La rotation peut être basée sur la taille, le temps ou une combinaison des deux. Exemples : 100M, daily, 100M,daily. Une fois que le fichier de log dépasse la taille spécifiée ou que l’intervalle de temps spécifié est atteint, il est renommé et archivé, puis un nouveau fichier de log est créé.
shutdown_level	Le niveau d’arrêt est utilisé pour définir le niveau du root logger lors de l’arrêt du serveur.
size	Politique de rotation : taille maximale des fichiers de log en octets. Une fois que la taille du fichier de log dépasse ce seuil, il est renommé et archivé, puis un nouveau fichier de log est créé.
startup_level	Le niveau de démarrage est utilisé pour définir le niveau du root logger au démarrage du serveur. Après le démarrage, le niveau de journalisation revient au paramètre level
stream_compress	Compresse les messages de log avec LZ4. Définissez la valeur sur 1 ou true pour l’activer.
syslog_level	Niveau de journalisation pour la journalisation vers syslog.
use_syslog	Transmet également la sortie de log à syslog.

Spécificateurs de format de log

Les noms de fichiers dans les chemins log et errorLog prennent en charge les spécificateurs de format ci-dessous pour le nom de fichier résultant (la partie répertoire ne les prend pas en charge).

La colonne « Exemple » montre la sortie à 2023-07-06 18:32:07.

Spécificateur	Description	Exemple
%%	% littéral	%
%n	Caractère de nouvelle ligne
%t	Caractère de tabulation horizontale
%Y	Année sous forme de nombre décimal, par ex. 2017	2023
%y	2 derniers chiffres de l’année sous forme de nombre décimal (plage [00,99])	23
%C	2 premiers chiffres de l’année sous forme de nombre décimal (plage [00,99])	20
%G	Année ISO 8601 basée sur les semaines sur quatre chiffres, c.-à-d. l’année qui contient la semaine spécifiée. Généralement utile uniquement avec %V	2023
%g	2 derniers chiffres de l’année ISO 8601 basée sur les semaines, c.-à-d. l’année qui contient la semaine spécifiée.	23
%b	Nom du mois abrégé, par ex. Oct (dépend des paramètres régionaux)	Jul
%h	Synonyme de %b	Jul
%B	Nom complet du mois, par ex. October (dépend des paramètres régionaux)	July
%m	Mois sous forme de nombre décimal (plage [01,12])	07
%U	Numéro de semaine de l’année sous forme de nombre décimal (le dimanche est le premier jour de la semaine) (plage [00,53])	27
%W	Numéro de semaine de l’année sous forme de nombre décimal (le lundi est le premier jour de la semaine) (plage [00,53])	27
%V	Numéro de semaine ISO 8601 (plage [01,53])	27
%j	Jour de l’année sous forme de nombre décimal (plage [001,366])	187
%d	Jour du mois sous forme de nombre décimal complété par des zéros (plage [01,31]). Un seul chiffre est précédé d’un zéro.	06
%e	Jour du mois sous forme de nombre décimal complété par des espaces (plage [1,31]). Un seul chiffre est précédé d’un espace.	  6
%a	Nom abrégé du jour de la semaine, par ex. Fri (dépend des paramètres régionaux)	Thu
%A	Nom complet du jour de la semaine, par ex. Friday (dépend des paramètres régionaux)	Thursday
%w	Jour de la semaine sous forme de nombre entier, avec dimanche = 0 (plage [0-6])	4
%u	Jour de la semaine sous forme de nombre décimal, où lundi = 1 (format ISO 8601) (plage [1-7])	4
%H	Heure sous forme de nombre décimal, horloge sur 24 heures (plage [00-23])	18
%I	Heure sous forme de nombre décimal, horloge sur 12 heures (plage [01,12])	06
%M	Minutes sous forme de nombre décimal (plage [00,59])	32
%S	Secondes sous forme de nombre décimal (plage [00,60])	07
%c	Chaîne standard de date et d’heure, par ex. Sun Oct 17 04:41:13 2010 (dépend des paramètres régionaux)	Thu Jul 6 18:32:07 2023
%x	Représentation localisée de la date (dépend des paramètres régionaux)	07/06/23
%X	Représentation localisée de l’heure, par ex. 18:40:20 ou 6:40:20 PM (dépend des paramètres régionaux)	18:32:07
%D	Date courte MM/DD/YY, équivalente à %m/%d/%y	07/06/23
%F	Date courte AAAA-MM-JJ, équivalente à %Y-%m-%d	2023-07-06
%r	Heure localisée au format 12 heures (selon les paramètres régionaux)	06:32:07 PM
%R	Équivalent à “%H:%M”	18:32
%T	Équivalent à “%H:%M:%S” (format d’heure ISO 8601)	18:32:07
%p	Indication localisée a.m. ou p.m. (selon les paramètres régionaux)	PM
%z	Décalage par rapport à l’UTC au format ISO 8601 (par ex. -0430), ou aucun caractère si les informations de fuseau horaire ne sont pas disponibles	+0800
%Z	Nom ou abréviation du fuseau horaire selon les paramètres régionaux, ou aucun caractère si les informations de fuseau horaire ne sont pas disponibles	Z AWST

Exemple

<logger>
    <level>trace</level>
    <log>/var/log/clickhouse-server/clickhouse-server-%F-%T.log</log>
    <errorlog>/var/log/clickhouse-server/clickhouse-server-%F-%T.err.log</errorlog>
    <size>1000M</size>
    <count>10</count>
    <stream_compress>true</stream_compress>
</logger>

Pour n’afficher les messages de log que dans la console :

<logger>
    <level>information</level>
    <console>true</console>
</logger>

Surcharges par niveau

Le niveau de journalisation de chaque logger peut être redéfini. Par exemple, pour désactiver tous les messages des loggers « Backup » et « RBAC ».

<logger>
    <levels>
        <logger>
            <name>Backup</name>
            <level>none</level>
        </logger>
        <logger>
            <name>RBAC</name>
            <level>none</level>
        </logger>
    </levels>
</logger>

syslog

Pour envoyer également les messages de log à syslog :

<logger>
    <use_syslog>1</use_syslog>
    <syslog>
        <address>syslog.remote:10514</address>
        <hostname>myhost.local</hostname>
        <facility>LOG_LOCAL6</facility>
        <format>syslog</format>
    </syslog>
</logger>

Clés pour <syslog> :

Clé	Description
address	L’adresse de syslog au format host\[:port\]. Si elle est omise, le démon local est utilisé.
hostname	Le nom d’hôte depuis lequel les logs sont envoyés (facultatif).
facility	Le mot-clé facility de syslog. Il doit être indiqué en majuscules avec le préfixe “LOG_”, par ex. LOG_USER, LOG_DAEMON, LOG_LOCAL3, etc. Par défaut : LOG_USER si address est spécifié, sinon LOG_DAEMON.
format	Format du message de log. Valeurs possibles : bsd et syslog.

Formats de log

Vous pouvez spécifier le format de log à afficher dans les logs de la console. Actuellement, seul JSON est pris en charge.

Exemple

Voici un exemple de log JSON produit en sortie :

{
  "date_time_utc": "2024-11-06T09:06:09Z",
  "date_time": "1650918987.180175",
  "thread_name": "#1",
  "thread_id": "254545",
  "level": "Trace",
  "query_id": "",
  "logger_name": "BaseDaemon",
  "message": "Received signal 2",
  "source_file": "../base/daemon/BaseDaemon.cpp; virtual void SignalListener::run()",
  "source_line": "192"
}

Pour activer la prise en charge de la journalisation au format JSON, utilisez l’extrait suivant :

<logger>
    <formatting>
        <type>json</type>
        <!-- Can be configured on a per-channel basis (log, errorlog, console, syslog), or globally for all channels (then just omit it). -->
        <!-- <channel></channel> -->
        <names>
            <date_time>date_time</date_time>
            <thread_name>thread_name</thread_name>
            <thread_id>thread_id</thread_id>
            <level>level</level>
            <query_id>query_id</query_id>
            <logger_name>logger_name</logger_name>
            <message>message</message>
            <source_file>source_file</source_file>
            <source_line>source_line</source_line>
        </names>
    </formatting>
</logger>

Renommer les clés des logs JSON

Les noms des clés peuvent être modifiés en changeant les valeurs des balises à l’intérieur de la balise <names>. Par exemple, pour remplacer DATE_TIME par MY_DATE_TIME, vous pouvez utiliser <date_time>MY_DATE_TIME</date_time>.

Omettre des clés des logs JSON

Les propriétés des logs peuvent être omises en commentant la propriété correspondante. Par exemple, si vous ne souhaitez pas que votre log affiche query_id, vous pouvez commenter la balise <query_id>.

​

logger.count

Politique de rotation : nombre maximal de fichiers de log ClickHouse historiques conservés.

​

logger.errorlog

Le chemin du fichier de log d’erreurs.

​

logger.formatting.type

Format des logs pour la sortie de la console. Actuellement, seul <json> est pris en charge.

​

logger.level

Niveau de journalisation. Valeurs acceptées : <none> (désactive la journalisation), <fatal>, <critical>, <error>, <warning>, <notice>, <information>, <debug>, <trace>, <test>.

​

logger.log

Chemin d’accès au fichier de log.

​

logger.rotation

Politique de rotation : contrôle quand les fichiers de log sont soumis à une rotation. La rotation peut être basée sur la taille, le temps ou une combinaison des deux. Exemples : 100M, daily, 100M,daily. Une fois que le fichier de log dépasse la taille spécifiée ou que l’intervalle de temps indiqué est atteint, il est renommé puis archivé, et un nouveau fichier de log est créé.

​

logger.shutdown_level

Le niveau d’arrêt sert à définir le niveau du logger racine lors de l’arrêt du serveur.

​

logger.size

Politique de rotation : taille maximale des fichiers de log, en octets. Dès que la taille d’un fichier de log dépasse ce seuil, il est renommé et archivé, puis un nouveau fichier de log est créé.

​

logger.startup_level

Le niveau de démarrage permet de définir le niveau du logger racine lors du démarrage du serveur. Une fois le serveur démarré, le niveau de journalisation revient au paramètre <level>.

​

logger.stream_compress

Compresse les messages de log avec LZ4. Définissez cette valeur sur <1> ou <true> pour l’activer.

​

logger.syslog_level

Niveau de journalisation pour la consignation dans syslog.

​

logger.use_syslog

Transmet également les logs vers syslog.

​

macros

Substitutions de paramètres pour les tables répliquées.

Peut être omis si vous n’utilisez pas de tables répliquées.

Pour plus d’informations, voir la section Création de tables répliquées.

Exemple

<macros incl="macros" optional="true" />

​

message_queue_disable_insertion

Désactive l’insertion depuis les moteurs de file d’attente de messages (Kafka, RabbitMQ, NATS) dans les vues matérialisées attachées

​

metric_log

Il est désactivé par défaut.

Activation

Pour activer manuellement la collecte de l’historique des metrics system.metric_log, créez /etc/clickhouse-server/config.d/metric_log.xml avec le contenu suivant :

<clickhouse>
    <metric_log>
        <database>system</database>
        <table>metric_log</table>
        <flush_interval_milliseconds>7500</flush_interval_milliseconds>
        <collect_interval_milliseconds>1000</collect_interval_milliseconds>
        <max_size_rows>1048576</max_size_rows>
        <reserved_size_rows>8192</reserved_size_rows>
        <buffer_size_rows_flush_threshold>524288</buffer_size_rows_flush_threshold>
        <flush_on_crash>false</flush_on_crash>
    </metric_log>
</clickhouse>

Désactivation

Pour désactiver le paramètre metric_log, créez le fichier suivant /etc/clickhouse-server/config.d/disable_metric_log.xml avec le contenu ci-dessous :

<clickhouse>
    <metric_log remove="1" />
</clickhouse>

Les paramètres suivants peuvent être configurés via des sous-balises :

Paramètre	Description	Valeur par défaut	Remarque
database	Nom de la base de données.
table	Nom de la table système.
engine	Définition du moteur MergeTree pour une table système.		Ne peut pas être utilisé si partition_by ou order_by est défini. S’il n’est pas spécifié, MergeTree est sélectionné par défaut
partition_by	Clé de partitionnement personnalisée pour une table système.		Si engine est spécifié pour la table système, le paramètre partition_by doit être indiqué directement dans ‘engine’
ttl	Spécifie le TTL de la table.		Si engine est spécifié pour la table système, le paramètre ttl doit être indiqué directement dans ‘engine’
order_by	Clé de tri personnalisée pour une table système. Ne peut pas être utilisée si engine est défini.		Si engine est spécifié pour la table système, le paramètre order_by doit être indiqué directement dans ‘engine’
storage_policy	Nom de la politique de stockage à utiliser pour la table (facultatif).		Si engine est spécifié pour la table système, le paramètre storage_policy doit être indiqué directement dans ‘engine’
settings	Paramètres supplémentaires qui contrôlent le comportement de MergeTree (facultatif).		Si engine est spécifié pour la table système, le paramètre settings doit être indiqué directement dans ‘engine’
flush_interval_milliseconds	Intervalle de vidage des données du tampon en mémoire vers la table.	7500
max_size_rows	Taille maximale en lignes pour les logs. Lorsque la quantité de logs non vidés atteint max_size_rows, les logs sont écrits sur le disque.	1048576
reserved_size_rows	Taille de mémoire préallouée en lignes pour les logs.	8192
buffer_size_rows_flush_threshold	Seuil du nombre de lignes. Si ce seuil est atteint, le vidage des logs sur le disque est lancé en arrière-plan.	max_size_rows / 2
flush_on_crash	Définit si les logs doivent être écrits sur le disque en cas de crash.	false

De plus, le paramètre suivant au niveau du serveur contrôle la politique de vidage par défaut pour toutes les tables de journal système :

<default_system_log_flush_policy>
    <skip_alias_columns>true</skip_alias_columns>
</default_system_log_flush_policy>

Paramètre	Description	Par défaut
skip_alias_columns	Lorsque true, les colonnes ALIAS sont omises des schémas des tables de logs système. Requis pour les logs système basés sur S3.	false

​

mmap_cache_size

Ce paramètre permet d’éviter des appels open/close fréquents (très coûteux en raison des défauts de page qu’ils entraînent) et de réutiliser les mappages entre plusieurs threads et requêtes. La valeur du paramètre correspond au nombre de régions mappées (généralement égal au nombre de fichiers mappés).

La quantité de données dans les fichiers mappés peut être surveillée dans les tables système suivantes à l’aide des métriques suivantes :

• MMappedFiles/MMappedFileBytes/MMapCacheCells dans system.metrics, system.metric_log
• CreatedReadBufferMMap/CreatedReadBufferMMapFailed/MMappedFileCacheHits/MMappedFileCacheMisses dans system.events, system.processes, system.query_log, system.query_thread_log, system.query_views_log

La quantité de données dans les fichiers mappés ne consomme pas directement de mémoire et n’est pas prise en compte dans l’utilisation mémoire des requêtes ou du serveur, car cette mémoire peut être libérée de façon similaire au cache de pages du système d’exploitation. Le cache est supprimé (les fichiers sont fermés) automatiquement lors de la suppression des anciennes parties dans les tables de la famille MergeTree, et il peut également être supprimé manuellement avec la requête SYSTEM DROP MMAP CACHE.

Ce paramètre peut être modifié à l’exécution et prendra effet immédiatement.

​

mutation_workload

Permet de réguler la manière dont les ressources sont utilisées et partagées entre les mutations et les autres workloads. La valeur spécifiée est utilisée comme valeur du paramètre workload pour toutes les mutations en arrière-plan. Elle peut être surchargée par un paramètre MergeTree.

Voir aussi

• Planification des workloads

​

oom_score

Sur les systèmes Linux, ce paramètre permet de contrôler le comportement de l’OOM killer.

​

openSSL

Configuration SSL client/serveur.

La prise en charge de SSL est assurée par la bibliothèque libpoco. Les options de configuration disponibles sont décrites dans SSLManager.h. Les valeurs par défaut se trouvent dans SSLManager.cpp.

Clés des paramètres client/serveur :

Option	Description	Valeur par défaut
cacheSessions	Active ou désactive le cache des sessions. Doit être utilisé conjointement avec sessionIdContext. Valeurs acceptées : true, false.	false
caConfig	Chemin vers le fichier ou le répertoire contenant les certificats d’AC de confiance. Si le chemin pointe vers un fichier, celui-ci doit être au format PEM et peut contenir plusieurs certificats d’AC. S’il pointe vers un répertoire, celui-ci doit contenir un fichier .pem par certificat d’AC. Les noms de fichier sont recherchés à l’aide de la valeur de hachage du nom du sujet de l’AC. Pour plus de détails, consultez la page de manuel de SSL_CTX_load_verify_locations.
certificateFile	Chemin d’accès au fichier de certificat client/serveur au format PEM. Vous pouvez l’omettre si privateKeyFile contient le certificat.
cipherList	Chiffrements OpenSSL pris en charge.	ALL:!ADH:!LOW:!EXP:!MD5:!3DES:@STRENGTH
disableProtocols	Protocoles dont l’utilisation n’est pas autorisée.
extendedVerification	Si cette option est activée, vérifie que le CN ou le SAN du certificat correspond au nom d’hôte du pair.	false
fips	Active le mode FIPS d’OpenSSL. Pris en charge si la version d’OpenSSL de la bibliothèque prend en charge FIPS.	false
invalidCertificateHandler	Classe (une sous-classe de CertificateHandler) permettant de vérifier les certificats invalides. Par exemple : <invalidCertificateHandler> <name>RejectCertificateHandler</name> </invalidCertificateHandler> .	RejectCertificateHandler
loadDefaultCAFile	Indique si les certificats CA intégrés d’OpenSSL seront utilisés. ClickHouse part du principe que les certificats CA intégrés se trouvent dans le fichier /etc/ssl/cert.pem (ou, respectivement, dans le répertoire /etc/ssl/certs) ou dans le fichier (ou, respectivement, le répertoire) indiqué par la variable d’environnement SSL_CERT_FILE (ou, respectivement, SSL_CERT_DIR).	true
preferServerCiphers	Suites de chiffrement du serveur privilégiées par le client.	false
privateKeyFile	Chemin d’accès vers le fichier contenant la clé privée du certificat PEM. Le fichier peut contenir à la fois la clé et le certificat.
privateKeyPassphraseHandler	Classe (sous-classe de PrivateKeyPassphraseHandler) qui demande la phrase de passe pour accéder à la clé privée. Par exemple : <privateKeyPassphraseHandler>, <name>KeyFileHandler</name>, <options><password>test</password></options>, </privateKeyPassphraseHandler>.	KeyConsoleHandler
requireTLSv1	Nécessite une connexion TLSv1. Valeurs acceptées : true, false.	false
requireTLSv1_1	Nécessite une connexion TLSv1.1. Valeurs acceptées : true, false.	false
requireTLSv1_2	Exige une connexion TLSv1.2. Valeurs acceptées : true, false.	false
sessionCacheSize	Le nombre maximal de sessions mises en cache par le serveur. Une valeur de 0 signifie un nombre illimité de sessions.	1024*20
sessionIdContext	Un ensemble unique de caractères aléatoires que le serveur ajoute à chaque identifiant généré. La longueur de la chaîne ne doit pas dépasser SSL_MAX_SSL_SESSION_ID_LENGTH. Ce paramètre est toujours recommandé, car il permet d’éviter les problèmes, que le serveur mette la session en cache ou que le client ait demandé la mise en cache.	$\{application.name\}
sessionTimeout	Durée de mise en cache de la session sur le serveur, en heures.	2
verificationDepth	Longueur maximale de la chaîne de vérification. La vérification échoue si la longueur de la chaîne de certificats dépasse la valeur définie.	9
verificationMode	La méthode utilisée pour vérifier les certificats du nœud. Les détails figurent dans la description de la classe Context. Valeurs possibles : none, relaxed, strict, once.	relaxed

Exemple de paramètres :

<openSSL>
    <server>
        <!-- openssl req -subj "/CN=localhost" -new -newkey rsa:2048 -days 365 -nodes -x509 -keyout /etc/clickhouse-server/server.key -out /etc/clickhouse-server/server.crt -->
        <certificateFile>/etc/clickhouse-server/server.crt</certificateFile>
        <privateKeyFile>/etc/clickhouse-server/server.key</privateKeyFile>
        <!-- openssl dhparam -out /etc/clickhouse-server/dhparam.pem 4096 -->
        <dhParamsFile>/etc/clickhouse-server/dhparam.pem</dhParamsFile>
        <verificationMode>none</verificationMode>
        <loadDefaultCAFile>true</loadDefaultCAFile>
        <cacheSessions>true</cacheSessions>
        <disableProtocols>sslv2,sslv3</disableProtocols>
        <preferServerCiphers>true</preferServerCiphers>
    </server>
    <client>
        <loadDefaultCAFile>true</loadDefaultCAFile>
        <cacheSessions>true</cacheSessions>
        <disableProtocols>sslv2,sslv3</disableProtocols>
        <preferServerCiphers>true</preferServerCiphers>
        <!-- Use for self-signed: <verificationMode>none</verificationMode> -->
        <invalidCertificateHandler>
            <!-- Use for self-signed: <name>AcceptCertificateHandler</name> -->
            <name>RejectCertificateHandler</name>
        </invalidCertificateHandler>
    </client>
</openSSL>

​

openSSL.client.caConfig

Chemin vers le fichier ou le répertoire contenant les certificats d’AC de confiance. S’il pointe vers un fichier, celui-ci doit être au format PEM et peut contenir plusieurs certificats d’AC. S’il pointe vers un répertoire, celui-ci doit contenir un fichier .pem par certificat d’AC. Les noms de fichier sont recherchés à l’aide de la valeur de hachage du nom du sujet de l’AC. Pour plus de détails, consultez la page de manuel de SSL_CTX_load_verify_locations.

​

openSSL.client.cacheSessions

Active ou désactive la mise en cache des sessions. Doit être utilisé conjointement avec <sessionIdContext>. Valeurs acceptées : <true>, <false>.

​

openSSL.client.certificateFile

Chemin du fichier de certificat client/serveur au format PEM. Vous pouvez l’omettre si <privateKeyFile> contient le certificat.

​

openSSL.client.cipherList

Suites de chiffrement OpenSSL prises en charge.

​

openSSL.client.disableProtocols

Protocoles dont l’utilisation est interdite.

​

openSSL.client.extendedVerification

Si cette option est activée, vérifie que le CN ou le SAN du certificat correspond au nom d’hôte du pair distant.

​

openSSL.client.fips

Active le mode FIPS d’OpenSSL. Pris en charge si la version d’OpenSSL de la bibliothèque prend en charge FIPS.

​

openSSL.client.invalidCertificateHandler.name

Classe (sous-classe de CertificateHandler) utilisée pour vérifier les certificats invalides. Par exemple : <<invalidCertificateHandler> <name>RejectCertificateHandler</name> </invalidCertificateHandler>>.

​

openSSL.client.loadDefaultCAFile

Indique si les certificats de CA intégrés d’OpenSSL seront utilisés. ClickHouse suppose que ces certificats de CA intégrés se trouvent dans le fichier </etc/ssl/cert.pem> (ou, selon le cas, dans le répertoire </etc/ssl/certs>) ou dans le fichier (ou le répertoire) spécifié par la variable d’environnement <SSL_CERT_FILE> (ou <SSL_CERT_DIR>).

​

openSSL.client.preferServerCiphers

Suites de chiffrement du serveur préférées par le client.

​

openSSL.client.privateKeyFile

Chemin d’accès au fichier contenant la clé privée du certificat PEM. Le fichier peut contenir à la fois une clé et un certificat.

​

openSSL.client.privateKeyPassphraseHandler.name

Classe (sous-classe de PrivateKeyPassphraseHandler) qui demande la phrase de passe pour accéder à la clé privée. Par exemple : <<privateKeyPassphraseHandler>>, <<name>KeyFileHandler</name>>, <<options><password>test</password></options>>, <</privateKeyPassphraseHandler>>

​

openSSL.client.verificationDepth

La longueur maximale de la chaîne de vérification. La vérification échoue si la longueur de la chaîne de certificats dépasse la valeur spécifiée.

​

openSSL.client.verificationMode

Méthode de vérification des certificats du nœud. Les détails figurent dans la description de la classe Context. Valeurs possibles : <none>, <relaxed>, <strict>, <once>.

​

openSSL.server.caConfig

Chemin vers le fichier ou le répertoire contenant les certificats CA de confiance. S’il s’agit d’un fichier, il doit être au format PEM et peut contenir plusieurs certificats CA. S’il s’agit d’un répertoire, il doit contenir un fichier .pem par certificat CA. Les noms de fichiers sont recherchés à partir de la valeur de hachage du nom du sujet de la CA. Pour plus de détails, consultez la page de manuel de SSL_CTX_load_verify_locations.

​

openSSL.server.cacheSessions

Active ou désactive la mise en cache des sessions. Doit être utilisé conjointement avec <sessionIdContext>. Valeurs acceptées : <true>, <false>.

​

openSSL.server.certificateFile

Chemin du fichier de certificat client/serveur au format PEM. Vous pouvez l’omettre si <privateKeyFile> contient le certificat.

​

openSSL.server.cipherList

Suites de chiffrement OpenSSL prises en charge.

​

openSSL.server.disableProtocols

Protocoles dont l’utilisation est interdite.

​

openSSL.server.extendedVerification

Si cette option est activée, vérifie que le CN ou le SAN du certificat correspond au nom d’hôte du pair distant.

​

openSSL.server.fips

Active le mode FIPS d’OpenSSL. Pris en charge si la version d’OpenSSL de la bibliothèque peut prendre en charge FIPS.

​

openSSL.server.invalidCertificateHandler.name

Classe (sous-classe de CertificateHandler) utilisée pour vérifier les certificats invalides. Exemple : <<invalidCertificateHandler> <name>RejectCertificateHandler</name> </invalidCertificateHandler>>.

​

openSSL.server.loadDefaultCAFile

Indique si les certificats CA intégrés d’OpenSSL seront utilisés. ClickHouse suppose que les certificats CA intégrés se trouvent dans le fichier </etc/ssl/cert.pem> (respectivement le répertoire </etc/ssl/certs>) ou dans le fichier (respectivement le répertoire) spécifié par la variable d’environnement <SSL_CERT_FILE> (respectivement <SSL_CERT_DIR>).

​

openSSL.server.preferServerCiphers

Suites de chiffrement du serveur préférées par le client.

​

openSSL.server.privateKeyFile

Chemin vers le fichier contenant la clé privée du certificat PEM. Le fichier peut contenir à la fois une clé et un certificat.

​

openSSL.server.privateKeyPassphraseHandler.name

Classe (sous-classe de PrivateKeyPassphraseHandler) qui demande la phrase de passe permettant d’accéder à la clé privée. Par exemple : <<privateKeyPassphraseHandler>>, <<name>KeyFileHandler</name>>, <<options><password>test</password></options>>, <</privateKeyPassphraseHandler>>

​

openSSL.server.sessionCacheSize

Nombre maximal de sessions mises en cache par le serveur. Une valeur de 0 signifie un nombre illimité de sessions.

​

openSSL.server.sessionIdContext

Une suite unique de caractères aléatoires que le serveur ajoute à chaque identifiant généré. La longueur de la chaîne ne doit pas dépasser <SSL_MAX_SSL_SESSION_ID_LENGTH>. Ce paramètre est toujours recommandé, car il permet d’éviter les problèmes, que le serveur mette la session en cache ou que le client ait demandé la mise en cache.

​

openSSL.server.sessionTimeout

Durée de mise en cache de la session sur le serveur, en heures.

​

openSSL.server.verificationDepth

Longueur maximale de la chaîne de vérification. La vérification échoue si la longueur de la chaîne de certificats dépasse la valeur définie.

​

openSSL.server.verificationMode

Méthode utilisée pour vérifier les certificats du nœud. Pour plus de détails, consultez la description de la classe Context. Valeurs possibles : <none>, <relaxed>, <strict>, <once>.

​

opentelemetry_span_log

Paramètres de la table système opentelemetry_span_log.

Les paramètres suivants peuvent être configurés via des sous-balises :

Paramètre	Description	Valeur par défaut	Remarque
database	Nom de la base de données.
table	Nom de la table système.
engine	Définition du moteur MergeTree pour une table système.		Ne peut pas être utilisé si partition_by ou order_by est défini. S’il n’est pas spécifié, MergeTree est sélectionné par défaut
partition_by	Clé de partitionnement personnalisée pour une table système.		Si engine est spécifié pour la table système, le paramètre partition_by doit être indiqué directement dans ‘engine’
ttl	Spécifie le TTL de la table.		Si engine est spécifié pour la table système, le paramètre ttl doit être indiqué directement dans ‘engine’
order_by	Clé de tri personnalisée pour une table système. Ne peut pas être utilisée si engine est défini.		Si engine est spécifié pour la table système, le paramètre order_by doit être indiqué directement dans ‘engine’
storage_policy	Nom de la politique de stockage à utiliser pour la table (facultatif).		Si engine est spécifié pour la table système, le paramètre storage_policy doit être indiqué directement dans ‘engine’
settings	Paramètres supplémentaires qui contrôlent le comportement de MergeTree (facultatif).		Si engine est spécifié pour la table système, le paramètre settings doit être indiqué directement dans ‘engine’
flush_interval_milliseconds	Intervalle de vidage des données du tampon en mémoire vers la table.	7500
max_size_rows	Taille maximale en lignes pour les logs. Lorsque la quantité de logs non vidés atteint max_size_rows, les logs sont écrits sur le disque.	1048576
reserved_size_rows	Taille de mémoire préallouée en lignes pour les logs.	8192
buffer_size_rows_flush_threshold	Seuil du nombre de lignes. Si ce seuil est atteint, le vidage des logs sur le disque est lancé en arrière-plan.	max_size_rows / 2
flush_on_crash	Définit si les logs doivent être écrits sur le disque en cas de crash.	false

De plus, le paramètre suivant au niveau du serveur contrôle la politique de vidage par défaut pour toutes les tables de journal système :

<default_system_log_flush_policy>
    <skip_alias_columns>true</skip_alias_columns>
</default_system_log_flush_policy>

Paramètre	Description	Par défaut
skip_alias_columns	Lorsque true, les colonnes ALIAS sont omises des schémas des tables de logs système. Requis pour les logs système basés sur S3.	false

Exemple :

<opentelemetry_span_log>
    <engine>
        engine MergeTree
        partition by toYYYYMM(finish_date)
        order by (finish_date, finish_time_us, trace_id)
    </engine>
    <database>system</database>
    <table>opentelemetry_span_log</table>
    <flush_interval_milliseconds>7500</flush_interval_milliseconds>
    <max_size_rows>1048576</max_size_rows>
    <reserved_size_rows>8192</reserved_size_rows>
    <buffer_size_rows_flush_threshold>524288</buffer_size_rows_flush_threshold>
    <flush_on_crash>false</flush_on_crash>
</opentelemetry_span_log>

​

part_log

Journalisation des événements associés à MergeTree, par exemple l’ajout ou la fusion de données. Vous pouvez utiliser ce journal pour simuler des algorithmes de fusion et comparer leurs caractéristiques. Vous pouvez visualiser le processus de fusion.

Les requêtes sont enregistrées dans la table system.part_log, et non dans un fichier distinct. Vous pouvez configurer le nom de cette table dans le paramètre table (voir ci-dessous).

Les paramètres suivants peuvent être configurés via des sous-balises :

Paramètre	Description	Valeur par défaut	Remarque
database	Nom de la base de données.
table	Nom de la table système.
engine	Définition du moteur MergeTree pour une table système.		Ne peut pas être utilisé si partition_by ou order_by est défini. S’il n’est pas spécifié, MergeTree est sélectionné par défaut
partition_by	Clé de partitionnement personnalisée pour une table système.		Si engine est spécifié pour la table système, le paramètre partition_by doit être indiqué directement dans ‘engine’
ttl	Spécifie le TTL de la table.		Si engine est spécifié pour la table système, le paramètre ttl doit être indiqué directement dans ‘engine’
order_by	Clé de tri personnalisée pour une table système. Ne peut pas être utilisée si engine est défini.		Si engine est spécifié pour la table système, le paramètre order_by doit être indiqué directement dans ‘engine’
storage_policy	Nom de la politique de stockage à utiliser pour la table (facultatif).		Si engine est spécifié pour la table système, le paramètre storage_policy doit être indiqué directement dans ‘engine’
settings	Paramètres supplémentaires qui contrôlent le comportement de MergeTree (facultatif).		Si engine est spécifié pour la table système, le paramètre settings doit être indiqué directement dans ‘engine’
flush_interval_milliseconds	Intervalle de vidage des données du tampon en mémoire vers la table.	7500
max_size_rows	Taille maximale en lignes pour les logs. Lorsque la quantité de logs non vidés atteint max_size_rows, les logs sont écrits sur le disque.	1048576
reserved_size_rows	Taille de mémoire préallouée en lignes pour les logs.	8192
buffer_size_rows_flush_threshold	Seuil du nombre de lignes. Si ce seuil est atteint, le vidage des logs sur le disque est lancé en arrière-plan.	max_size_rows / 2
flush_on_crash	Définit si les logs doivent être écrits sur le disque en cas de crash.	false

De plus, le paramètre suivant au niveau du serveur contrôle la politique de vidage par défaut pour toutes les tables de journal système :

<default_system_log_flush_policy>
    <skip_alias_columns>true</skip_alias_columns>
</default_system_log_flush_policy>

Paramètre	Description	Par défaut
skip_alias_columns	Lorsque true, les colonnes ALIAS sont omises des schémas des tables de logs système. Requis pour les logs système basés sur S3.	false

Exemple

<part_log>
    <database>system</database>
    <table>part_log</table>
    <partition_by>toMonday(event_date)</partition_by>
    <flush_interval_milliseconds>7500</flush_interval_milliseconds>
    <max_size_rows>1048576</max_size_rows>
    <reserved_size_rows>8192</reserved_size_rows>
    <buffer_size_rows_flush_threshold>524288</buffer_size_rows_flush_threshold>
    <flush_on_crash>false</flush_on_crash>
</part_log>

​

path

Chemin vers le répertoire contenant les données.

Le slash final est obligatoire.

Exemple

<path>/var/lib/clickhouse/</path>

​

per_cpu_untracked_memory_thread_buffer

Quantité de mémoire non suivie, en octets, que chaque thread peut conserver sans utiliser le budget partagé par CPU. Cela amortit le coût de la comptabilisation par CPU pour les petites allocations et correspond à la marge ajoutée au-dessus de max_per_cpu_untracked_memory * number_of_cpus dans le pire des cas. Une valeur de 0 supprime cette marge : chaque allocation met à jour le compteur partagé par CPU (plus précis, mais avec davantage de contention). Linux uniquement.

​

point_in_polygon_cache_size

Taille maximale, en octets, du cache des polygones prétraités utilisés par la fonction pointInPolygon avec un argument de polygone constant. Les entrées qui dépassent cette limite sont évincées selon l’ordre du moins récemment utilisé. La définir sur 0 désactive le cache : tous les polygones mis en cache sont évincés, et chaque requête suivante prétraite à nouveau son polygone constant. Le cache peut également être vidé manuellement, sans modifier cette limite, à l’aide de la requête SYSTEM DROP POINT IN POLYGON CACHE.

Ce paramètre peut être modifié en cours d’exécution et prendra effet immédiatement.

​

prefixes_deserialization_thread_pool_thread_pool_queue_size

Le nombre maximal de jobs pouvant être planifiés dans le pool de threads de désérialisation des préfixes.

Une valeur de 0 signifie sans limite.

​

prepare_system_log_tables_on_startup

Si cette option est définie sur true, ClickHouse crée toutes les tables system.*_log configurées avant le démarrage. Cela peut être utile si certains scripts de démarrage dépendent de ces tables.

​

process_query_plan_packet

Ce paramètre permet la lecture du paquet QueryPlan. Ce paquet est envoyé pour les requêtes distribuées lorsque serialize_query_plan est activé. Il est désactivé par défaut afin d’éviter d’éventuels problèmes de sécurité pouvant être causés par des bogues dans la désérialisation binaire du plan de requête.

Exemple

<process_query_plan_packet>true</process_query_plan_packet>

​

processors_profile_log

Paramètres de la table système processors_profile_log.

Les paramètres suivants peuvent être configurés via des sous-balises :

Paramètre	Description	Valeur par défaut	Remarque
database	Nom de la base de données.
table	Nom de la table système.
engine	Définition du moteur MergeTree pour une table système.		Ne peut pas être utilisé si partition_by ou order_by est défini. S’il n’est pas spécifié, MergeTree est sélectionné par défaut
partition_by	Clé de partitionnement personnalisée pour une table système.		Si engine est spécifié pour la table système, le paramètre partition_by doit être indiqué directement dans ‘engine’
ttl	Spécifie le TTL de la table.		Si engine est spécifié pour la table système, le paramètre ttl doit être indiqué directement dans ‘engine’
order_by	Clé de tri personnalisée pour une table système. Ne peut pas être utilisée si engine est défini.		Si engine est spécifié pour la table système, le paramètre order_by doit être indiqué directement dans ‘engine’
storage_policy	Nom de la politique de stockage à utiliser pour la table (facultatif).		Si engine est spécifié pour la table système, le paramètre storage_policy doit être indiqué directement dans ‘engine’
settings	Paramètres supplémentaires qui contrôlent le comportement de MergeTree (facultatif).		Si engine est spécifié pour la table système, le paramètre settings doit être indiqué directement dans ‘engine’
flush_interval_milliseconds	Intervalle de vidage des données du tampon en mémoire vers la table.	7500
max_size_rows	Taille maximale en lignes pour les logs. Lorsque la quantité de logs non vidés atteint max_size_rows, les logs sont écrits sur le disque.	1048576
reserved_size_rows	Taille de mémoire préallouée en lignes pour les logs.	8192
buffer_size_rows_flush_threshold	Seuil du nombre de lignes. Si ce seuil est atteint, le vidage des logs sur le disque est lancé en arrière-plan.	max_size_rows / 2
flush_on_crash	Définit si les logs doivent être écrits sur le disque en cas de crash.	false

De plus, le paramètre suivant au niveau du serveur contrôle la politique de vidage par défaut pour toutes les tables de journal système :

<default_system_log_flush_policy>
    <skip_alias_columns>true</skip_alias_columns>
</default_system_log_flush_policy>

Paramètre	Description	Par défaut
skip_alias_columns	Lorsque true, les colonnes ALIAS sont omises des schémas des tables de logs système. Requis pour les logs système basés sur S3.	false

Les paramètres par défaut sont :

<processors_profile_log>
    <database>system</database>
    <table>processors_profile_log</table>
    <partition_by>toYYYYMM(event_date)</partition_by>
    <flush_interval_milliseconds>7500</flush_interval_milliseconds>
    <max_size_rows>1048576</max_size_rows>
    <reserved_size_rows>8192</reserved_size_rows>
    <buffer_size_rows_flush_threshold>524288</buffer_size_rows_flush_threshold>
    <flush_on_crash>false</flush_on_crash>
</processors_profile_log>

​

prometheus

Expose les données de métriques afin qu’elles puissent être collectées par Prometheus.

Paramètres :

• endpoint – Point de terminaison HTTP pour la collecte des métriques par le serveur Prometheus. Doit commencer par ’/’.
• port – Port de endpoint.
• metrics – Expose les métriques de la table system.metrics.
• events – Expose les métriques de la table system.events.
• asynchronous_metrics – Expose les valeurs actuelles des métriques de la table system.asynchronous_metrics.
• errors - Expose le nombre d’erreurs par code d’erreur depuis le dernier redémarrage du serveur. Ces informations peuvent également être obtenues via system.errors.

Exemple

<clickhouse>
    <listen_host>0.0.0.0</listen_host>
    <http_port>8123</http_port>
    <tcp_port>9000</tcp_port>
    <prometheus>
        <endpoint>/metrics</endpoint>
        <port>9363</port>
        <metrics>true</metrics>
        <events>true</events>
        <asynchronous_metrics>true</asynchronous_metrics>
        <errors>true</errors>
    </prometheus>
</clickhouse>

Vérifiez (remplacez 127.0.0.1 par l’adresse IP ou le nom d’hôte de votre serveur ClickHouse) :

curl 127.0.0.1:9363/metrics

​

prometheus.keeper_metrics_only

Expose les métriques associées à Keeper

​

proxy

Définissez des serveurs proxy pour les requêtes HTTP et HTTPS, actuellement pris en charge par le stockage S3, les fonctions de table S3 et les fonctions URL.

Il existe trois façons de définir des serveurs proxy :

• variables d’environnement
• listes de proxy
• résolveurs de proxy distants.

La possibilité de contourner les serveurs proxy pour des hôtes spécifiques est également prise en charge à l’aide de no_proxy.

Variables d’environnement

Les variables d’environnement http_proxy et https_proxy vous permettent de spécifier un serveur proxy pour un protocole donné. Si elles sont définies sur votre système, cela devrait fonctionner sans problème.

C’est l’approche la plus simple si un protocole donné ne dispose que d’un seul serveur proxy et que ce serveur proxy ne change pas.

Listes de proxy

Cette approche vous permet de spécifier un ou plusieurs serveurs proxy pour un protocole. Si plusieurs serveurs proxy sont définis, ClickHouse utilise les différents proxy selon une méthode round-robin, en répartissant la charge entre les serveurs. C’est l’approche la plus simple s’il existe plusieurs serveurs proxy pour un protocole et que la liste de ces serveurs proxy ne change pas.

Modèle de configuration

<proxy>
    <http>
        <uri>http://proxy1</uri>
        <uri>http://proxy2:3128</uri>
    </http>
    <https>
        <uri>http://proxy1:3128</uri>
    </https>
</proxy>

Sélectionnez un champ parent dans les onglets ci-dessous pour afficher ses champs enfants :

<proxy>

Champ	Description
<http>	Une liste d’un ou de plusieurs proxys HTTP
<https>	Une liste d’un ou de plusieurs proxys HTTPS

<http> et <https>

Champ	Description
<uri>	L’URI du proxy

Résolveurs de proxy distants

Il est possible que les serveurs proxy changent dynamiquement. Dans ce cas, vous pouvez définir le point de terminaison d’un résolveur. ClickHouse envoie une requête GET vide à ce point de terminaison ; le résolveur distant doit renvoyer l’hôte du proxy. ClickHouse l’utilisera pour construire l’URI du proxy à l’aide du modèle suivant : \{proxy_scheme\}://\{proxy_host\}:{proxy_port}

Modèle de configuration

<proxy>
    <http>
        <resolver>
            <endpoint>http://resolver:8080/hostname</endpoint>
            <proxy_scheme>http</proxy_scheme>
            <proxy_port>80</proxy_port>
            <proxy_cache_time>10</proxy_cache_time>
        </resolver>
    </http>

    <https>
        <resolver>
            <endpoint>http://resolver:8080/hostname</endpoint>
            <proxy_scheme>http</proxy_scheme>
            <proxy_port>3128</proxy_port>
            <proxy_cache_time>10</proxy_cache_time>
        </resolver>
    </https>

</proxy>

Sélectionnez un champ parent dans les onglets ci-dessous pour afficher ses champs enfants :

<proxy>

Champ	Description
<http>	Une liste d’un ou plusieurs résolveurs*
<https>	Une liste d’un ou plusieurs résolveurs*

<http> et <https>

Champ	Description
<resolver>	Le point de terminaison et d’autres détails d’un résolveur

Vous pouvez avoir plusieurs éléments <resolver>, mais seul le premier <resolver> pour un protocole donné est utilisé. Tous les autres éléments <resolver> pour ce protocole sont ignorés. Cela signifie que le load balancing (si nécessaire) doit être implémenté par le résolveur distant.

<resolver>

Champ	Description
<endpoint>	L’URI du résolveur de proxy
<proxy_scheme>	Le protocole de l’URI du proxy final. Il peut s’agir de http ou de https.
<proxy_port>	Le numéro de port du résolveur de proxy
<proxy_cache_time>	La durée, en secondes, pendant laquelle les valeurs du résolveur doivent être mises en cache par ClickHouse. Définir cette valeur sur 0 oblige ClickHouse à contacter le résolveur pour chaque requête HTTP ou HTTPS.

Préséance

Les paramètres du proxy sont déterminés dans l’ordre suivant :

Ordre	Paramètre
1.	Résolveurs de proxy distants
2.	Listes de proxys
3.	Variables d’environnement

ClickHouse vérifiera le type de résolveur ayant la priorité la plus élevée pour le protocole de la requête. S’il n’est pas défini, il vérifiera alors le type de résolveur ayant la priorité immédiatement inférieure, jusqu’à atteindre le résolveur d’environnement. Cela permet également d’utiliser une combinaison de types de résolveur.

​

remap_executable

Paramètre permettant de réallouer de la mémoire pour le code machine (“text”) à l’aide de pages mémoire de grande taille.

Cette fonctionnalité est encore très expérimentale.

Exemple

<remap_executable>false</remap_executable>

​

replica_group_name

Nom du groupe de répliques pour la base de données Replicated.

Le cluster créé par la base de données Replicated sera constitué de répliques appartenant au même groupe. Les requêtes DDL n’attendront que les répliques appartenant au même groupe.

Vide par défaut.

Exemple

<replica_group_name>backups</replica_group_name>

​

replicated_merge_tree

Réglages avancés pour les tables ReplicatedMergeTree. Ce paramètre a une priorité plus élevée.

Pour plus d’informations, consultez le fichier d’en-tête MergeTreeSettings.h.

Exemple

<replicated_merge_tree>
    <max_suspicious_broken_parts>5</max_suspicious_broken_parts>
</replicated_merge_tree>

​

restore_threads

Le nombre maximal de threads pour exécuter les requêtes RESTORE.

​

send_crash_reports

Paramètres d’envoi des rapports de plantage à l’équipe principale de développement de ClickHouse.

L’activer, en particulier dans les environnements de préproduction, est vivement apprécié.

Clés :

Key	Description
enabled	Indicateur booléen permettant d’activer cette fonctionnalité, true par défaut. Définissez-le sur false pour éviter d’envoyer des rapports de plantage.
endpoint	Vous pouvez remplacer l’URL du point de terminaison utilisée pour envoyer les rapports de plantage.
send_logical_errors	LOGICAL_ERROR est comparable à un assert ; il s’agit d’un bogue dans ClickHouse. Cet indicateur booléen active l’envoi de ces exceptions (par défaut : true).

Utilisation recommandée

<send_crash_reports>
    <enabled>true</enabled>
</send_crash_reports>

​

series_keeper_path

Chemin dans Keeper avec des numéros auto-incrémentés, générés par la fonction generateSerialID. Chaque série correspondra à un nœud sous ce chemin.

​

ssh_server

La partie publique de la clé d’hôte sera inscrite dans le fichier known_hosts côté client SSH lors de la première connexion.

Les configurations de clé d’hôte sont désactivées par défaut. Décommentez-les et indiquez le chemin vers la clé SSH correspondante pour les activer :

Exemple :

<ssh_server>
    <host_rsa_key>path_to_the_ssh_key</host_rsa_key>
    <host_ecdsa_key>path_to_the_ssh_key</host_ecdsa_key>
    <host_ed25519_key>path_to_the_ssh_key</host_ed25519_key>
</ssh_server>

​

table_engines_require_grant

Si la valeur est définie sur true, les utilisateurs doivent disposer d’un privilège pour créer une table avec un engine spécifique, par ex. GRANT TABLE ENGINE ON TinyLog to user.

Par défaut, pour assurer la rétrocompatibilité, la création d’une table avec un table engine spécifique ne tient pas compte des privilèges ; vous pouvez toutefois modifier ce comportement en définissant cette valeur sur true.

​

tcp_ssh_port

Port du serveur SSH permettant à l’utilisateur de se connecter et d’exécuter des requêtes de façon interactive à l’aide du client intégré via le PTY.

Exemple :

<tcp_ssh_port>9022</tcp_ssh_port>

​

text_log

Paramètres de la table système text_log pour la journalisation des messages textuels.

Les paramètres suivants peuvent être configurés via des sous-balises :

Paramètre	Description	Valeur par défaut	Remarque
database	Nom de la base de données.
table	Nom de la table système.
engine	Définition du moteur MergeTree pour une table système.		Ne peut pas être utilisé si partition_by ou order_by est défini. S’il n’est pas spécifié, MergeTree est sélectionné par défaut
partition_by	Clé de partitionnement personnalisée pour une table système.		Si engine est spécifié pour la table système, le paramètre partition_by doit être indiqué directement dans ‘engine’
ttl	Spécifie le TTL de la table.		Si engine est spécifié pour la table système, le paramètre ttl doit être indiqué directement dans ‘engine’
order_by	Clé de tri personnalisée pour une table système. Ne peut pas être utilisée si engine est défini.		Si engine est spécifié pour la table système, le paramètre order_by doit être indiqué directement dans ‘engine’
storage_policy	Nom de la politique de stockage à utiliser pour la table (facultatif).		Si engine est spécifié pour la table système, le paramètre storage_policy doit être indiqué directement dans ‘engine’
settings	Paramètres supplémentaires qui contrôlent le comportement de MergeTree (facultatif).		Si engine est spécifié pour la table système, le paramètre settings doit être indiqué directement dans ‘engine’
flush_interval_milliseconds	Intervalle de vidage des données du tampon en mémoire vers la table.	7500
max_size_rows	Taille maximale en lignes pour les logs. Lorsque la quantité de logs non vidés atteint max_size_rows, les logs sont écrits sur le disque.	1048576
reserved_size_rows	Taille de mémoire préallouée en lignes pour les logs.	8192
buffer_size_rows_flush_threshold	Seuil du nombre de lignes. Si ce seuil est atteint, le vidage des logs sur le disque est lancé en arrière-plan.	max_size_rows / 2
flush_on_crash	Définit si les logs doivent être écrits sur le disque en cas de crash.	false

De plus, le paramètre suivant au niveau du serveur contrôle la politique de vidage par défaut pour toutes les tables de journal système :

<default_system_log_flush_policy>
    <skip_alias_columns>true</skip_alias_columns>
</default_system_log_flush_policy>

Paramètre	Description	Par défaut
skip_alias_columns	Lorsque true, les colonnes ALIAS sont omises des schémas des tables de logs système. Requis pour les logs système basés sur S3.	false

De plus :

Paramètre	Description	Valeur par défaut
level	Niveau de message maximal (par défaut Trace) qui sera stocké dans la table.	Trace

Exemple

<clickhouse>
    <text_log>
        <level>notice</level>
        <database>system</database>
        <table>text_log</table>
        <flush_interval_milliseconds>7500</flush_interval_milliseconds>
        <max_size_rows>1048576</max_size_rows>
        <reserved_size_rows>8192</reserved_size_rows>
        <buffer_size_rows_flush_threshold>524288</buffer_size_rows_flush_threshold>
        <flush_on_crash>false</flush_on_crash>
        <!-- <partition_by>event_date</partition_by> -->
        <engine>Engine = MergeTree PARTITION BY event_date ORDER BY event_time TTL event_date + INTERVAL 30 day</engine>
    </text_log>
</clickhouse>

​

thread_pool_queue_size

Nombre maximal de jobs pouvant être planifiés dans le Global pool de threads. Augmenter la taille de la queue entraîne une utilisation mémoire plus élevée. Il est recommandé de conserver cette valeur égale à max_thread_pool_size.

Une valeur de 0 signifie qu’il n’y a pas de limite.

Exemple

<thread_pool_queue_size>12000</thread_pool_queue_size>

​

throw_on_unknown_workload

Définit le comportement lors de l’accès à un WORKLOAD inconnu avec le paramètre de requête ‘workload’.

• Si true, l’exception RESOURCE_ACCESS_DENIED est levée pour une requête qui tente d’accéder à un workload inconnu. Utile pour imposer l’ordonnancement des ressources à toutes les requêtes une fois la hiérarchie de WORKLOAD établie et contenant WORKLOAD default.
• Si false (par défaut), une requête dont le paramètre ‘workload’ pointe vers un WORKLOAD inconnu bénéficie d’un accès illimité, sans ordonnancement des ressources. Cela est important lors de la configuration de la hiérarchie de WORKLOAD, avant l’ajout de WORKLOAD default.

Exemple

<throw_on_unknown_workload>true</throw_on_unknown_workload>

Voir aussi

• Ordonnancement des charges de travail

​

timezone

Le fuseau horaire du serveur.

Il est spécifié sous la forme d’un identifiant IANA correspondant au fuseau horaire UTC ou à un lieu géographique (par exemple, Africa/Abidjan).

Le fuseau horaire est nécessaire pour les conversions entre les formats String et DateTime lorsque des champs DateTime sont restitués au format texte (affichés à l’écran ou dans un fichier), ainsi que lors de la conversion d’une chaîne en DateTime. En outre, il est utilisé dans les fonctions qui manipulent la date et l’heure si aucun fuseau horaire ne leur a été fourni dans les paramètres d’entrée.

Exemple

<timezone>Asia/Istanbul</timezone>

Voir aussi

• session_timezone

​

trace_log

Paramètres de fonctionnement de la table système trace_log.

Les paramètres suivants peuvent être configurés via des sous-balises :

Paramètre	Description	Valeur par défaut	Remarque
database	Nom de la base de données.
table	Nom de la table système.
engine	Définition du moteur MergeTree pour une table système.		Ne peut pas être utilisé si partition_by ou order_by est défini. S’il n’est pas spécifié, MergeTree est sélectionné par défaut
partition_by	Clé de partitionnement personnalisée pour une table système.		Si engine est spécifié pour la table système, le paramètre partition_by doit être indiqué directement dans ‘engine’
ttl	Spécifie le TTL de la table.		Si engine est spécifié pour la table système, le paramètre ttl doit être indiqué directement dans ‘engine’
order_by	Clé de tri personnalisée pour une table système. Ne peut pas être utilisée si engine est défini.		Si engine est spécifié pour la table système, le paramètre order_by doit être indiqué directement dans ‘engine’
storage_policy	Nom de la politique de stockage à utiliser pour la table (facultatif).		Si engine est spécifié pour la table système, le paramètre storage_policy doit être indiqué directement dans ‘engine’
settings	Paramètres supplémentaires qui contrôlent le comportement de MergeTree (facultatif).		Si engine est spécifié pour la table système, le paramètre settings doit être indiqué directement dans ‘engine’
flush_interval_milliseconds	Intervalle de vidage des données du tampon en mémoire vers la table.	7500
max_size_rows	Taille maximale en lignes pour les logs. Lorsque la quantité de logs non vidés atteint max_size_rows, les logs sont écrits sur le disque.	1048576
reserved_size_rows	Taille de mémoire préallouée en lignes pour les logs.	8192
buffer_size_rows_flush_threshold	Seuil du nombre de lignes. Si ce seuil est atteint, le vidage des logs sur le disque est lancé en arrière-plan.	max_size_rows / 2
flush_on_crash	Définit si les logs doivent être écrits sur le disque en cas de crash.	false

De plus, le paramètre suivant au niveau du serveur contrôle la politique de vidage par défaut pour toutes les tables de journal système :

<default_system_log_flush_policy>
    <skip_alias_columns>true</skip_alias_columns>
</default_system_log_flush_policy>

Paramètre	Description	Par défaut
skip_alias_columns	Lorsque true, les colonnes ALIAS sont omises des schémas des tables de logs système. Requis pour les logs système basés sur S3.	false

Le fichier de configuration du serveur par défaut config.xml contient la section de paramètres suivante :

<trace_log>
    <database>system</database>
    <table>trace_log</table>
    <partition_by>toYYYYMM(event_date)</partition_by>
    <flush_interval_milliseconds>7500</flush_interval_milliseconds>
    <max_size_rows>1048576</max_size_rows>
    <reserved_size_rows>8192</reserved_size_rows>
    <buffer_size_rows_flush_threshold>524288</buffer_size_rows_flush_threshold>
    <flush_on_crash>false</flush_on_crash>
    <symbolize>false</symbolize>
</trace_log>

​

url_scheme_mappers

Configuration permettant de convertir des préfixes d’URL abrégés ou symboliques en URL complètes.

Exemple :

<url_scheme_mappers>
    <s3>
        <to>https://{bucket}.s3.amazonaws.com</to>
    </s3>
    <gs>
        <to>https://storage.googleapis.com/{bucket}</to>
    </gs>
    <oss>
        <to>https://{bucket}.oss.aliyuncs.com</to>
    </oss>
</url_scheme_mappers>

​

validate_tcp_client_information

Détermine si la validation des informations client est activée à la réception d’un paquet de requête.

Par défaut, la valeur est false :

<validate_tcp_client_information>false</validate_tcp_client_information>

​

wait_dictionaries_load_at_startup

Ce paramètre permet de définir le comportement lorsque dictionaries_lazy_load vaut false. (Si dictionaries_lazy_load vaut true, ce paramètre n’a aucun effet.)

Si wait_dictionaries_load_at_startup vaut false, le serveur commencera à charger tous les dictionnaires au démarrage et acceptera des connexions en parallèle de ce chargement. Lorsqu’un dictionnaire est utilisé pour la première fois dans une requête, celle-ci attendra que le dictionnaire soit chargé si ce n’est pas encore le cas. Définir wait_dictionaries_load_at_startup sur false peut permettre à ClickHouse de démarrer plus rapidement ; toutefois, certaines requêtes peuvent s’exécuter plus lentement (car elles devront attendre le chargement de certains dictionnaires).

Si wait_dictionaries_load_at_startup vaut true, le serveur attendra au démarrage que tous les dictionnaires aient terminé leur chargement (avec succès ou non) avant d’accepter la moindre connexion.

Exemple

<wait_dictionaries_load_at_startup>true</wait_dictionaries_load_at_startup>

​

webassembly_udf_engine

Le moteur utilisé pour exécuter les UDF WebAssembly. Les valeurs prises en charge sont « wasmtime » et « wasmedge ».

​

webterminal_allowed_origins

Liste d’origines complètes séparées par des virgules (scheme + host + port facultatif) autorisées à ouvrir des sessions WebSocket /webterminal. Lorsqu’elle est vide, la politique de même origine est appliquée strictement (Origin doit correspondre au scheme, au host et au port de la request). Définissez ce paramètre pour les déploiements derrière un proxy inverse avec terminaison TLS, où request.isSecure() vaut false même si le navigateur utilise https. Exemple : https://example.com,https://app.example.com:8443.