メインコンテンツへスキップ
メインコンテンツへスキップ

サーバー設定

このセクションでは、サーバー設定について説明します。これらは、セッションレベルやクエリレベルでは変更できない設定です。

ClickHouse の設定ファイルの詳細については、「Configuration Files」 を参照してください。

その他の設定については「Settings」セクションで説明しています。 設定を理解する前に、Configuration files セクションを読み、置換（incl および optional 属性）の使い方に留意してください。

abort_on_logical_error​

LOGICAL_ERROR 例外発生時にサーバーを異常終了させます。専門家向けの設定です。

access_control_improvements​

アクセス制御システムにおけるオプションの改善に関する設定。

SettingDescriptionDefault
users_without_row_policies_can_read_rows許可する ROW POLICY を持たないユーザーが、SELECT クエリを使用して行を読み取れるかどうかを設定します。たとえば、ユーザー A と B がいて、ROW POLICY が A に対してのみ定義されている場合、この設定が true であれば、ユーザー B はすべての行を参照できます。この設定が false の場合、ユーザー B は行を一切参照できません。true
on_cluster_queries_require_cluster_grantON CLUSTER クエリに CLUSTER 権限が必須かどうかを設定します。true
select_from_system_db_requires_grantSELECT * FROM system.<table> に何らかの権限が必要かどうか（false の場合は権限なしで任意のユーザーが実行可能かどうか）を設定します。true に設定した場合、このクエリには、非 system テーブルと同様に GRANT SELECT ON system.<table> が必要になります。例外: 一部の system テーブル（tables、columns、databases および one、contributors のような定数テーブル）は依然としてすべてのユーザーがアクセス可能です。また、もし SHOW 権限（例: SHOW USERS）が付与されている場合は、対応する system テーブル（すなわち system.users）にアクセスできます。true
select_from_information_schema_requires_grantSELECT * FROM information_schema.<table> に何らかの権限が必要かどうか（false の場合は権限なしで任意のユーザーが実行可能かどうか）を設定します。true に設定した場合、このクエリには通常のテーブルと同様に GRANT SELECT ON information_schema.<table> が必要になります。true
settings_constraints_replace_previousある SETTINGS PROFILE 内で特定の設定に対して定義された CONSTRAINT が、その設定に対して以前に定義された CONSTRAINT（他のプロファイルで定義されたもの）による動作を、新しい CONSTRAINT で値が設定されていないフィールドも含めて打ち消すかどうかを設定します。また、changeable_in_readonly CONSTRAINT タイプを有効にします。true
table_engines_require_grant特定のテーブルエンジンを使用してテーブルを作成する際に、権限が必要かどうかを設定します。false
role_cache_expiration_time_seconds最終アクセスから、ロールが Role Cache に保持される秒数を設定します。600

Example:

<access_control_improvements>
    <users_without_row_policies_can_read_rows>true</users_without_row_policies_can_read_rows>
    <on_cluster_queries_require_cluster_grant>true</on_cluster_queries_require_cluster_grant>
    <select_from_system_db_requires_grant>true</select_from_system_db_requires_grant>
    <select_from_information_schema_requires_grant>true</select_from_information_schema_requires_grant>
    <settings_constraints_replace_previous>true</settings_constraints_replace_previous>
    <table_engines_require_grant>false</table_engines_require_grant>
    <role_cache_expiration_time_seconds>600</role_cache_expiration_time_seconds>
</access_control_improvements>

access_control_path​

ClickHouse サーバーが、SQL コマンドで作成されたユーザーおよびロールの設定を保存するフォルダーへのパスです。

関連項目

aggregate_function_group_array_action_when_limit_is_reached​

groupArray で配列要素の最大サイズを超えた場合に実行するアクション：throw で例外を送出するか、discard で余分な値を破棄する

aggregate_function_group_array_max_element_size​

groupArray 関数における配列要素の最大サイズ（バイト単位）。この制限はシリアル化時にチェックされ、状態サイズが過度に大きくなるのを防ぐのに役立ちます。

allow_feature_tier​

ユーザーが異なる機能ティアに関連する設定を変更できるかどうかを制御します。

  • 0 - すべての設定（experimental、beta、production）の変更が許可されます。
  • 1 - beta および production 機能に関する設定のみ変更が許可されます。experimental に関する設定の変更は拒否されます。
  • 2 - production 機能に関する設定のみ変更が許可されます。experimental または beta に関する設定の変更は拒否されます。

これは、すべての EXPERIMENTAL / BETA 機能に対して読み取り専用の CONSTRAINT を設定することと同等です。

注記

値が 0 の場合、すべての設定を変更できます。

allow_impersonate_user​

IMPERSONATE 機能（EXECUTE AS target_user）を有効または無効にします。

allow_implicit_no_password​

'IDENTIFIED WITH no_password' が明示的に指定されていない限り、パスワードなしでユーザーを作成することを禁止します。

<allow_implicit_no_password>1</allow_implicit_no_password>

allow_no_password​

安全ではないパスワード方式である no_password を許可するかどうかを設定します。

<allow_no_password>1</allow_no_password>

allow_plaintext_password​

平文パスワード型（安全ではない）の使用を許可するかどうかを設定します。

<allow_plaintext_password>1</allow_plaintext_password>

allow_use_jemalloc_memory​

jemalloc メモリの使用を許可します。

allowed_disks_for_table_engines​

Iceberg での使用が許可されているディスクの一覧

async_insert_queue_flush_on_shutdown​

true の場合、グレースフルシャットダウン時に非同期 insert キューがフラッシュされます

async_insert_threads​

バックグラウンドでデータをパースして挿入するスレッドの最大数。0 を指定すると非同期モードは無効になります

async_load_databases​

データベースおよびテーブルを非同期でロードします。

  • true の場合、Ordinary、Atomic、Replicated エンジンを持つすべての非システムデータベースは、ClickHouse サーバーの起動後に非同期でロードされます。system.asynchronous_loader テーブル、およびサーバー設定 tables_loader_background_pool_size と tables_loader_foreground_pool_size を参照してください。まだロードされていないテーブルにアクセスしようとするクエリは、そのテーブルが利用可能になるまで待機します。ロード処理が失敗した場合、クエリは（async_load_databases = false の場合のようにサーバー全体をシャットダウンする代わりに）エラーを再スローします。少なくとも 1 つのクエリによって待機されているテーブルは、より高い優先度でロードされます。データベースに対する DDL クエリは、そのデータベースが利用可能になるまで待機します。また、待機中のクエリの総数に対する上限として max_waiting_queries を設定することも検討してください。
  • false の場合、すべてのデータベースはサーバー起動時にロードされます。

例

<async_load_databases>true</async_load_databases>

async_load_system_database​

system テーブルを非同期で読み込みます。system データベース内に大量のログテーブルやパーツがある場合に有用です。async_load_databases 設定とは独立しています。

  • true に設定すると、ClickHouse サーバーの起動後に、Ordinary、Atomic、Replicated エンジンを持つすべての system データベースが非同期で読み込まれます。system.asynchronous_loader テーブル、および tables_loader_background_pool_size と tables_loader_foreground_pool_size のサーバー設定を参照してください。まだ読み込まれていない system テーブルへアクセスしようとするクエリは、そのテーブルの起動が完了するまで待機します。少なくとも 1 つのクエリによって待機されているテーブルは、より高い優先度で読み込まれます。また、待機中のクエリの総数を制限するために max_waiting_queries 設定の利用も検討してください。
  • false に設定すると、system データベースはサーバーの起動前に読み込まれます。

例

<async_load_system_database>true</async_load_system_database>

asynchronous_heavy_metrics_update_period_s​

重い非同期メトリクスの更新間隔（秒）。

asynchronous_insert_log​

非同期インサートをログに記録するための asynchronous_insert_log システムテーブルの設定。

The following settings can be configured by sub-tags:

SettingDescriptionDefaultNote
databaseデータベース名。
tableシステムテーブル名。
engineシステムテーブルに対する MergeTree エンジン定義。partition_by または order_by が定義されている場合は使用できません。指定しない場合はデフォルトで MergeTree が選択されます
partition_byシステムテーブルに対するカスタムパーティショニングキー。システムテーブルに engine を指定する場合、partition_by パラメータは engine の設定内で直接指定する必要があります
ttlテーブルの TTL を指定します。システムテーブルに engine を指定する場合、ttl パラメータは engine の設定内で直接指定する必要があります
order_byシステムテーブルに対するカスタムソートキー。engine が定義されている場合は使用できません。システムテーブルに engine を指定する場合、order_by パラメータは engine の設定内で直接指定する必要があります
storage_policyテーブルに使用するストレージポリシー名（任意）。システムテーブルに engine を指定する場合、storage_policy パラメータは engine の設定内で直接指定する必要があります
settingsMergeTree の動作を制御する追加パラメータ（任意）。システムテーブルに engine を指定する場合、settings パラメータは engine の設定内で直接指定する必要があります
flush_interval_millisecondsメモリ上のバッファからテーブルへデータをフラッシュする間隔。7500
max_size_rowsログの最大行数。未フラッシュのログ数が max_size_rows に達すると、ログがディスクにダンプされます。1048576
reserved_size_rowsログ用に事前確保されるメモリ容量（行数）。8192
buffer_size_rows_flush_threshold行数のしきい値。このしきい値に達すると、バックグラウンドでログをディスクへフラッシュする処理が起動します。max_size_rows / 2
flush_on_crashクラッシュ発生時にログをディスクへダンプするかどうかを設定します。false

例

<clickhouse>
    <asynchronous_insert_log>
        <database>system</database>
        <table>asynchronous_insert_log</table>
        <flush_interval_milliseconds>7500</flush_interval_milliseconds>
        <partition_by>toYYYYMM(event_date)</partition_by>
        <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>
        <!-- <engine>Engine = MergeTree PARTITION BY event_date ORDER BY event_time TTL event_date + INTERVAL 30 day</engine> -->
    </asynchronous_insert_log>
</clickhouse>

asynchronous_metric_log​

ClickHouse Cloud のデプロイメントでは、デフォルトで有効になっています。

お使いの環境でこの設定がデフォルトで有効になっていない場合は、ClickHouse のインストール方法に応じて、以下の手順に従って設定を有効または無効にできます。

有効化

非同期メトリクスログの履歴収集 system.asynchronous_metric_log を手動で有効にするには、次の内容で /etc/clickhouse-server/config.d/asynchronous_metric_log.xml を作成します。

<clickhouse>
     <asynchronous_metric_log>
        <database>system</database>
        <table>asynchronous_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>
    </asynchronous_metric_log>
</clickhouse>

無効化

asynchronous_metric_log SETTING を無効化するには、次の内容で /etc/clickhouse-server/config.d/disable_asynchronous_metric_log.xml ファイルを作成する必要があります。

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

The following settings can be configured by sub-tags:

SettingDescriptionDefaultNote
databaseデータベース名。
tableシステムテーブル名。
engineシステムテーブルに対する MergeTree エンジン定義。partition_by または order_by が定義されている場合は使用できません。指定しない場合はデフォルトで MergeTree が選択されます
partition_byシステムテーブルに対するカスタムパーティショニングキー。システムテーブルに engine を指定する場合、partition_by パラメータは engine の設定内で直接指定する必要があります
ttlテーブルの TTL を指定します。システムテーブルに engine を指定する場合、ttl パラメータは engine の設定内で直接指定する必要があります
order_byシステムテーブルに対するカスタムソートキー。engine が定義されている場合は使用できません。システムテーブルに engine を指定する場合、order_by パラメータは engine の設定内で直接指定する必要があります
storage_policyテーブルに使用するストレージポリシー名（任意）。システムテーブルに engine を指定する場合、storage_policy パラメータは engine の設定内で直接指定する必要があります
settingsMergeTree の動作を制御する追加パラメータ（任意）。システムテーブルに engine を指定する場合、settings パラメータは engine の設定内で直接指定する必要があります
flush_interval_millisecondsメモリ上のバッファからテーブルへデータをフラッシュする間隔。7500
max_size_rowsログの最大行数。未フラッシュのログ数が max_size_rows に達すると、ログがディスクにダンプされます。1048576
reserved_size_rowsログ用に事前確保されるメモリ容量（行数）。8192
buffer_size_rows_flush_threshold行数のしきい値。このしきい値に達すると、バックグラウンドでログをディスクへフラッシュする処理が起動します。max_size_rows / 2
flush_on_crashクラッシュ発生時にログをディスクへダンプするかどうかを設定します。false

asynchronous_metrics_enable_heavy_metrics​

重い非同期メトリクスの計算を有効にします。

asynchronous_metrics_keeper_metrics_only​

非同期メトリクスで keeper 関連のメトリクスのみを計算します。

asynchronous_metrics_update_period_s​

非同期メトリクスを更新する間隔（秒単位）。

auth_use_forwarded_address​

プロキシ経由で接続しているクライアントに対して、認証に元の送信元アドレスを使用します。

注記

転送されたアドレスは容易に偽装されうるため、この設定を使用する際は特に注意が必要です。このような認証を受け入れるサーバーには直接アクセスせず、必ず信頼できるプロキシ経由でのみアクセスするようにしてください。

background_buffer_flush_schedule_pool_size​

バックグラウンドで Buffer エンジンテーブル のフラッシュ処理を行うために使用されるスレッド数の上限。

background_common_pool_size​

バックグラウンドで *MergeTree-engine テーブルに対して、主にガーベジコレクションを含むさまざまな処理を実行するために使用されるスレッド数の最大値です。

background_distributed_schedule_pool_size​

分散送信の実行に使用されるスレッド数の上限。

background_fetches_pool_size​

バックグラウンドで *MergeTree-engine テーブルの他のレプリカからデータパーツを取得するために使用されるスレッドの最大数。

background_merges_mutations_concurrency_ratio​

スレッド数に対する、同時に実行可能なバックグラウンドのマージおよびミューテーション数の比率を設定します。

たとえば、この比率が 2 で background_pool_size が 16 に設定されている場合、ClickHouse は 32 個のバックグラウンドマージを同時に実行できます。これは、バックグラウンド処理を一時停止したり、後回しにしたりできるためです。小さなマージにより高い実行優先度を与えるために必要となります。

注記

この比率は実行時に増やすことのみが可能です。小さくするにはサーバーを再起動する必要があります。

background_pool_size SETTING と同様に、background_merges_mutations_concurrency_ratio も後方互換性のために default プロファイルから適用できます。

background_merges_mutations_scheduling_policy​

背景マージおよびミューテーションのスケジューリング方法を決定するポリシーです。指定可能な値は round_robin と shortest_task_first です。

バックグラウンドスレッドプールで次に実行するマージまたはミューテーションを選択する際に使用されるアルゴリズムです。ポリシーはサーバーを再起動せずに、実行時に変更できます。 後方互換性のために、default プロファイルからも適用できます。

指定可能な値:

  • round_robin — すべての同時実行中のマージおよびミューテーションをラウンドロビン順に実行し、スタベーション（飢餓状態）を防ぎます。小さいマージはマージ対象のブロック数が少ないため、大きなマージよりも速く完了します。
  • shortest_task_first — 常により小さいマージまたはミューテーションを実行します。マージおよびミューテーションには、結果のサイズに基づいて優先度が割り当てられます。サイズの小さいマージは大きいマージよりも厳密に優先されます。このポリシーは小さいパーツをできるだけ速くマージすることを保証しますが、INSERT が非常に多いパーティションでは、大きなマージが無期限にスタベーションに陥る可能性があります。

background_message_broker_schedule_pool_size​

メッセージストリーミングのバックグラウンド処理に使用されるスレッドの最大数。

background_move_pool_size​

バックグラウンドで *MergeTree-engine テーブルのデータパーツを別のディスクまたはボリュームへ移動する際に使用される最大スレッド数。

background_pool_size​

MergeTree エンジンを使用するテーブルで、バックグラウンドのマージおよびミューテーションを実行するスレッド数を設定します。

注記
  • この設定は、後方互換性のため、ClickHouse サーバーの起動時に default プロファイルの設定からも適用できます。
  • 実行中にスレッド数を増やすことだけが可能です。
  • スレッド数を減らすにはサーバーを再起動する必要があります。
  • この設定を調整することで、CPU とディスクの負荷を管理できます。
危険

プールサイズを小さくすると CPU とディスクリソースの消費は減りますが、バックグラウンド処理の進行が遅くなり、最終的にクエリ性能に影響する可能性があります。

この値を変更する前に、次のような関連する MergeTree 設定も確認してください。

例

<background_pool_size>16</background_pool_size>

background_schedule_pool_max_parallel_tasks_per_type_ratio​

同じ種類のタスクを同時に実行できるスレッド数が、プール内の全スレッド数に対して占める最大比率。

background_schedule_pool_size​

レプリケートテーブル、Kafka ストリーミング、および DNS キャッシュ更新のための軽量な定期処理を継続的に実行する際に使用されるスレッドの最大数。

backup_log​

BACKUP および RESTORE 操作を記録するための backup_log システムテーブルの設定。

The following settings can be configured by sub-tags:

SettingDescriptionDefaultNote
databaseデータベース名。
tableシステムテーブル名。
engineシステムテーブルに対する MergeTree エンジン定義。partition_by または order_by が定義されている場合は使用できません。指定しない場合はデフォルトで MergeTree が選択されます
partition_byシステムテーブルに対するカスタムパーティショニングキー。システムテーブルに engine を指定する場合、partition_by パラメータは engine の設定内で直接指定する必要があります
ttlテーブルの TTL を指定します。システムテーブルに engine を指定する場合、ttl パラメータは engine の設定内で直接指定する必要があります
order_byシステムテーブルに対するカスタムソートキー。engine が定義されている場合は使用できません。システムテーブルに engine を指定する場合、order_by パラメータは engine の設定内で直接指定する必要があります
storage_policyテーブルに使用するストレージポリシー名（任意）。システムテーブルに engine を指定する場合、storage_policy パラメータは engine の設定内で直接指定する必要があります
settingsMergeTree の動作を制御する追加パラメータ（任意）。システムテーブルに engine を指定する場合、settings パラメータは engine の設定内で直接指定する必要があります
flush_interval_millisecondsメモリ上のバッファからテーブルへデータをフラッシュする間隔。7500
max_size_rowsログの最大行数。未フラッシュのログ数が max_size_rows に達すると、ログがディスクにダンプされます。1048576
reserved_size_rowsログ用に事前確保されるメモリ容量（行数）。8192
buffer_size_rows_flush_threshold行数のしきい値。このしきい値に達すると、バックグラウンドでログをディスクへフラッシュする処理が起動します。max_size_rows / 2
flush_on_crashクラッシュ発生時にログをディスクへダンプするかどうかを設定します。false

例

<clickhouse>
    <backup_log>
        <database>system</database>
        <table>backup_log</table>
        <flush_interval_milliseconds>1000</flush_interval_milliseconds>
        <partition_by>toYYYYMM(event_date)</partition_by>
        <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>
        <!-- <engine>Engine = MergeTree PARTITION BY event_date ORDER BY event_time TTL event_date + INTERVAL 30 day</engine> -->
    </backup_log>
</clickhouse>

backup_threads​

BACKUP リクエストの実行に使用されるスレッドの最大数。

backups​

BACKUP および RESTORE 文を実行する際に使用される、バックアップに関する設定です。

以下の設定はサブタグで構成できます。

SettingTypeDescriptionDefault
allow_concurrent_backupsBool同一ホストで複数のバックアップ処理を同時に実行できるかどうかを制御します。true
allow_concurrent_restoresBool同一ホストで複数のリストア処理を同時に実行できるかどうかを制御します。true
allowed_diskStringFile() を使用する場合にバックアップを書き出すディスク。この設定を指定しないと File は使用できません。``
allowed_pathStringFile() を使用する場合にバックアップを書き出すパス。この設定を指定しないと File は使用できません。``
attempts_to_collect_metadata_before_sleepUInt収集したメタデータを比較した結果、不整合があった場合にスリープへ移行する前、メタデータ収集を試行する回数。2
collect_metadata_timeoutUInt64バックアップ中にメタデータを収集する際のタイムアウト（ミリ秒）。600000
compare_collected_metadataBooltrue の場合、バックアップ中にメタデータが変更されていないことを確認するために、収集したメタデータを既存のメタデータと比較します。true
create_table_timeoutUInt64リストア時にテーブルを作成する際のタイムアウト（ミリ秒）。300000
max_attempts_after_bad_versionUInt64協調バックアップ／リストア中にバージョン不整合エラーが発生した後に、リトライを行う最大試行回数。3
max_sleep_before_next_attempt_to_collect_metadataUInt64次のメタデータ収集を試行する前にスリープする最大時間（ミリ秒）。100
min_sleep_before_next_attempt_to_collect_metadataUInt64次のメタデータ収集を試行する前にスリープする最小時間（ミリ秒）。5000
remove_backup_files_after_failureBoolBACKUP コマンドが失敗した場合、ClickHouse は失敗前にバックアップ先へコピー済みのファイルを削除しようとします。false の場合、コピー済みファイルはそのまま残されます。true
sync_period_msUInt64協調バックアップ／リストアの同期周期（ミリ秒）。5000
test_inject_sleepBoolテスト用途でスリープを挿入するための設定。false
test_randomize_orderBooltrue の場合、テスト目的で特定の処理順序をランダム化します。false
zookeeper_pathStringON CLUSTER 句を使用する場合に、バックアップおよびリストアのメタデータを保存する ZooKeeper 上のパス。/clickhouse/backups

これらの設定のデフォルト値は次のとおりです。

<backups>
    ....
</backups>

backups_io_thread_pool_queue_size​

Backups IO スレッドプールにスケジュールできるジョブの最大数です。現在の S3 バックアップのロジックのため、このキューは無制限のままにしておくことを推奨します。

注記

0（デフォルト）の値は、無制限を意味します。

bcrypt_workfactor​

bcrypt_password 認証タイプで使用される Bcrypt アルゴリズム のワークファクターです。 ワークファクターによって、ハッシュの計算およびパスワードの検証に必要な計算量と時間が決まります。

<bcrypt_workfactor>12</bcrypt_workfactor>
注記

高頻度で認証を行うアプリケーションでは、 ワークファクターを高く設定した場合の bcrypt の計算コストを考慮し、 別の認証方式の利用を検討してください。

blob_storage_log​

blob_storage_log システムテーブルの設定。

The following settings can be configured by sub-tags:

SettingDescriptionDefaultNote
databaseデータベース名。
tableシステムテーブル名。
engineシステムテーブルに対する MergeTree エンジン定義。partition_by または order_by が定義されている場合は使用できません。指定しない場合はデフォルトで MergeTree が選択されます
partition_byシステムテーブルに対するカスタムパーティショニングキー。システムテーブルに engine を指定する場合、partition_by パラメータは engine の設定内で直接指定する必要があります
ttlテーブルの TTL を指定します。システムテーブルに engine を指定する場合、ttl パラメータは engine の設定内で直接指定する必要があります
order_byシステムテーブルに対するカスタムソートキー。engine が定義されている場合は使用できません。システムテーブルに engine を指定する場合、order_by パラメータは engine の設定内で直接指定する必要があります
storage_policyテーブルに使用するストレージポリシー名（任意）。システムテーブルに engine を指定する場合、storage_policy パラメータは engine の設定内で直接指定する必要があります
settingsMergeTree の動作を制御する追加パラメータ（任意）。システムテーブルに engine を指定する場合、settings パラメータは engine の設定内で直接指定する必要があります
flush_interval_millisecondsメモリ上のバッファからテーブルへデータをフラッシュする間隔。7500
max_size_rowsログの最大行数。未フラッシュのログ数が max_size_rows に達すると、ログがディスクにダンプされます。1048576
reserved_size_rowsログ用に事前確保されるメモリ容量（行数）。8192
buffer_size_rows_flush_threshold行数のしきい値。このしきい値に達すると、バックグラウンドでログをディスクへフラッシュする処理が起動します。max_size_rows / 2
flush_on_crashクラッシュ発生時にログをディスクへダンプするかどうかを設定します。false

例：

<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​

組み込み辞書を再読み込みするまでの間隔（秒）。

ClickHouse は組み込み辞書を x 秒ごとに再読み込みします。これにより、サーバーを再起動することなく、稼働中に辞書を編集できます。

例

<builtin_dictionaries_reload_interval>3600</builtin_dictionaries_reload_interval>

cache_size_to_ram_max_ratio​

キャッシュサイズのRAMに対する最大比率を設定します。メモリの少ないシステムでキャッシュサイズを小さく抑えることができます。

cannot_allocate_thread_fault_injection_probability​

テスト目的で使用する設定です。

cgroups_memory_usage_observer_wait_time​

サーバーで許可される最大メモリ使用量が、cgroups 内の対応するしきい値に基づいて調整される秒単位の間隔です。

cgroup オブザーバーを無効にするには、この値を 0 に設定します。

compiled_expression_cache_elements_size​

コンパイル済み式のキャッシュサイズ（要素数）を設定します。

compiled_expression_cache_size​

compiled expressions 用のキャッシュのサイズ（バイト単位）を設定します。

圧縮​

MergeTree エンジンを使用するテーブルのデータ圧縮設定。

注記

ClickHouse の利用を開始したばかりの場合は、この設定は変更しないことを推奨します。

構成テンプレート:

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

<case> フィールド:

  • min_part_size – データパートの最小サイズ。
  • min_part_size_ratio – データパートサイズとテーブルサイズの比率。
  • method – 圧縮方式。指定可能な値: lz4, lz4hc, zstd, deflate_qpl。
  • level – 圧縮レベル。Codecs を参照してください。
注記

複数の <case> セクションを設定できます。

条件を満たしたときの動作:

  • データパートが条件セットに一致した場合、ClickHouse は指定された圧縮方式を使用します。
  • データパートが複数の条件セットに一致した場合、ClickHouse は最初に一致した条件セットを使用します。
注記

データパートがいずれの条件セットにも一致しない場合、ClickHouse は lz4 圧縮を使用します。

例

<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>

concurrent_threads_scheduler​

concurrent_threads_soft_limit_num および concurrent_threads_soft_limit_ratio_to_cores で指定される CPU スロットのスケジューリング方法を決定するポリシーです。制限された数の CPU スロットを同時実行クエリ間でどのように分配するかを制御するアルゴリズムです。スケジューラはサーバーの再起動なしに実行時に変更できます。

指定可能な値:

  • round_robin — use_concurrency_control = 1 に設定されているすべてのクエリは、最大で max_threads 個の CPU スロットを確保します。スレッドにつき 1 スロットです。競合が発生した場合、CPU スロットはクエリに対してラウンドロビン方式で付与されます。最初のスロットは無条件に付与される点に注意してください。これにより、多数の max_threads = 1 のクエリが存在する状況では、max_threads が大きいクエリの不公平さやレイテンシ増大を招く可能性があります。
  • fair_round_robin — use_concurrency_control = 1 に設定されているすべてのクエリは、最大で max_threads - 1 個の CPU スロットを確保します。各クエリの最初のスレッドに CPU スロットを要求しない、round_robin のバリエーションです。これにより、max_threads = 1 のクエリはスロットを一切必要とせず、スロットを不公平に占有することがなくなります。無条件に付与されるスロットは存在しません。

concurrent_threads_soft_limit_num​

リモートサーバーからのデータ取得用スレッドを除き、すべてのクエリの処理に使用できるクエリ処理スレッドの最大数です。これはハードリミットではありません。上限に達した場合でも、クエリには少なくとも 1 つのスレッドが割り当てられて実行されます。より多くのスレッドが利用可能になれば、実行中のクエリは必要なスレッド数までスケールアップできます。

注記

0（デフォルト）の値は無制限を意味します。

concurrent_threads_soft_limit_ratio_to_cores​

concurrent_threads_soft_limit_num と同様ですが、コア数に対する比率として指定します。

config_reload_interval_ms​

ClickHouse が設定を再読み込みし、変更の有無を確認する間隔

core_dump​

コアダンプファイルのサイズに対するソフトリミットを設定します。

注記

ハードリミットはシステムツールで設定します

例

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

cpu_slot_preemption​

CPU リソース（MASTER THREAD と WORKER THREAD）に対するワークロードのスケジューリング方法を定義します。

  • true（推奨）の場合、実際に消費された CPU 時間に基づいて計測を行います。競合するワークロードには、CPU 時間が公平に割り当てられます。スロットは一定時間だけ割り当てられ、有効期限後に再度リクエストされます。CPU リソースが過負荷の場合、スロットのリクエストがスレッド実行をブロックする可能性があり、その結果プリエンプションが発生する場合があります。これにより、CPU 時間の公平性が保証されます。
  • false（デフォルト）の場合、計測は割り当てられた CPU スロット数に基づいて行われます。競合するワークロードには、CPU スロットが公平に割り当てられます。スロットはスレッド開始時に割り当てられ、終了するまで継続的に保持され、スレッドの実行が終了すると解放されます。クエリ実行に割り当てられるスレッド数は 1 から max_threads まで増加するだけで、減少することはありません。これは長時間実行されるクエリに有利ですが、短いクエリが CPU 飢餓状態に陥る可能性があります。

Example

<cpu_slot_preemption>true</cpu_slot_preemption>

関連項目

cpu_slot_preemption_timeout_ms​

この設定は、プリエンプション中、つまり別の CPU スロットが付与されるのを待っている間に、ワーカースレッドが待機できる最大ミリ秒数を定義します。このタイムアウト後もスレッドが新しい CPU スロットを取得できなかった場合、そのスレッドは終了し、クエリは同時実行スレッド数がより少ない構成へと動的にスケールダウンされます。なお、マスタースレッド自体がスケールダウンされることはありませんが、無期限にプリエンプトされる可能性があります。この設定は、cpu_slot_preemption が有効であり、かつ WORKER THREAD に対して CPU リソースが定義されている場合にのみ意味を持ちます。

例

<cpu_slot_preemption_timeout_ms>1000</cpu_slot_preemption_timeout_ms>

関連項目

cpu_slot_quantum_ns​

スレッドが CPU スロットを取得した後、別の CPU スロットを再度要求するまでに消費できる CPU ナノ秒数を定義します。cpu_slot_preemption が有効であり、MASTER THREAD または WORKER THREAD に対して CPU リソースが定義されている場合にのみ意味を持ちます。

例

<cpu_slot_quantum_ns>10000000</cpu_slot_quantum_ns>

関連項目

crash_log​

crash_log システムテーブルの動作に関する設定。

次の設定はサブタグで指定できます。

SettingDescriptionDefaultNote
databaseデータベース名。
tableシステムテーブル名。
engineシステムテーブル用の MergeTree Engine Definition。partition_by または order_by が定義されている場合は使用できません。指定しない場合、デフォルトで MergeTree が選択されます
partition_byシステムテーブル用の Custom partitioning key。システムテーブルに engine を指定する場合、partition_by パラメータは直接 'engine' 内で指定する必要があります
ttlテーブルの TTL を指定します。システムテーブルに engine を指定する場合、ttl パラメータは直接 'engine' 内で指定する必要があります
order_byシステムテーブル用の Custom sorting key。engine が定義されている場合は使用できません。システムテーブルに engine を指定する場合、order_by パラメータは直接 'engine' 内で指定する必要があります
storage_policyテーブルに使用するストレージポリシー名（任意）。システムテーブルに engine を指定する場合、storage_policy パラメータは直接 'engine' 内で指定する必要があります
settingsMergeTree の動作を制御する Additional parameters（任意）。システムテーブルに engine を指定する場合、settings パラメータは直接 'engine' 内で指定する必要があります
flush_interval_millisecondsメモリ上のバッファからテーブルへデータをフラッシュする間隔。7500
max_size_rowsログの最大サイズ（行数）。フラッシュされていないログの量が max_size に達すると、ログはディスクに書き出されます。1024
reserved_size_rowsログ用にあらかじめ確保されるメモリサイズ（行数）。1024
buffer_size_rows_flush_threshold行数のしきい値。このしきい値に達すると、バックグラウンドでディスクへのログフラッシュが開始されます。max_size_rows / 2
flush_on_crashクラッシュ時にログをディスクへ書き出すかどうかを設定します。false

デフォルトのサーバー設定ファイル config.xml には、次の設定セクションが含まれています。

<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>

custom_cached_disks_base_directory​

この設定は、カスタム（SQL から作成された）キャッシュディスク用のキャッシュパスを指定します。 custom_cached_disks_base_directory はカスタムディスクに対して filesystem_caches_path（filesystem_caches_path.xml 内に記載）よりも優先され、 前者が設定されていない場合には後者が使用されます。 ファイルシステムキャッシュのパスは、このディレクトリ配下でなければなりません。 そうでない場合、ディスクの作成を防ぐために例外がスローされます。

注記

これは、サーバーをアップグレードする前の古いバージョンで作成されたディスクには影響しません。 この場合、サーバーが正常に起動できるように、例外はスローされません。

例:

<custom_cached_disks_base_directory>/var/lib/clickhouse/caches/</custom_cached_disks_base_directory>

custom_settings_prefixes​

カスタム設定 用の接頭辞の一覧です。複数指定する場合は、カンマ区切りで指定します。

例

<custom_settings_prefixes>custom_</custom_settings_prefixes>

関連項目

database_atomic_delay_before_drop_table_sec​

削除されたテーブルを UNDROP 文を使用して復元できる時間です。DROP TABLE が SYNC 修飾子付きで実行された場合、この設定は無視されます。 この設定のデフォルト値は 480（8 分）です。

database_catalog_drop_error_cooldown_sec​

テーブルの削除に失敗した場合、ClickHouse はこのタイムアウト時間が経過するまで待ってから操作を再試行します。

database_catalog_drop_table_concurrency​

テーブルを削除するために使用されるスレッドプールのサイズ。

database_catalog_unused_dir_cleanup_period_sec​

store/ ディレクトリから不要なデータをクリーンアップするタスクのパラメーターです。 タスクの実行間隔（スケジューリング周期）を設定します。

注記

値 0 は「実行しない」を意味します。デフォルト値は 1 日に相当します。

database_catalog_unused_dir_hide_timeout_sec​

store/ ディレクトリから不要なディレクトリをクリーンアップするタスクのパラメータです。 あるサブディレクトリが clickhouse-server によって使用されておらず、かつ直近 database_catalog_unused_dir_hide_timeout_sec 秒の間に更新されていない場合、このタスクは そのディレクトリのすべてのアクセス権を削除することでディレクトリを「非表示」にします。これは、clickhouse-server が store/ 内に存在することを想定していないディレクトリに対しても動作します。

注記

0 の値は「即時」を意味します。

database_catalog_unused_dir_rm_timeout_sec​

store/ ディレクトリ内の不要なディレクトリをクリーンアップするタスクのパラメータです。 あるサブディレクトリが clickhouse-server によって使用されておらず、以前に「非表示」にされていて （database_catalog_unused_dir_hide_timeout_sec を参照）、 かつ、そのディレクトリが直近 database_catalog_unused_dir_rm_timeout_sec 秒の間に更新されていない場合、このタスクはそのディレクトリを削除します。 また、clickhouse-server が store/ 内に存在することを想定していないディレクトリにも適用されます。

注記

値が 0 の場合は「削除しない（無期限）」を意味します。デフォルト値は 30 日に相当します。

database_replicated_allow_detach_permanently​

Replicated データベースでテーブルを永続的にデタッチできるようにする

database_replicated_drop_broken_tables​

予期しないテーブルを、別のローカルデータベースに移動するのではなく Replicated データベースから削除します

dead_letter_queue​

「dead_letter_queue」システムテーブルの設定です。

The following settings can be configured by sub-tags:

SettingDescriptionDefaultNote
databaseデータベース名。
tableシステムテーブル名。
engineシステムテーブルに対する MergeTree エンジン定義。partition_by または order_by が定義されている場合は使用できません。指定しない場合はデフォルトで MergeTree が選択されます
partition_byシステムテーブルに対するカスタムパーティショニングキー。システムテーブルに engine を指定する場合、partition_by パラメータは engine の設定内で直接指定する必要があります
ttlテーブルの TTL を指定します。システムテーブルに engine を指定する場合、ttl パラメータは engine の設定内で直接指定する必要があります
order_byシステムテーブルに対するカスタムソートキー。engine が定義されている場合は使用できません。システムテーブルに engine を指定する場合、order_by パラメータは engine の設定内で直接指定する必要があります
storage_policyテーブルに使用するストレージポリシー名（任意）。システムテーブルに engine を指定する場合、storage_policy パラメータは engine の設定内で直接指定する必要があります
settingsMergeTree の動作を制御する追加パラメータ（任意）。システムテーブルに engine を指定する場合、settings パラメータは engine の設定内で直接指定する必要があります
flush_interval_millisecondsメモリ上のバッファからテーブルへデータをフラッシュする間隔。7500
max_size_rowsログの最大行数。未フラッシュのログ数が max_size_rows に達すると、ログがディスクにダンプされます。1048576
reserved_size_rowsログ用に事前確保されるメモリ容量（行数）。8192
buffer_size_rows_flush_threshold行数のしきい値。このしきい値に達すると、バックグラウンドでログをディスクへフラッシュする処理が起動します。max_size_rows / 2
flush_on_crashクラッシュ発生時にログをディスクへダンプするかどうかを設定します。false

デフォルトの設定は次のとおりです。

<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>

default_database​

既定のデータベース名です。

default_password_type​

CREATE USER u IDENTIFIED BY 'p' のようなクエリで自動的に設定されるパスワードの種類を指定します。

指定可能な値は次のとおりです:

  • plaintext_password
  • sha256_password
  • double_sha1_password
  • bcrypt_password
<default_password_type>sha256_password</default_password_type>

default_profile​

デフォルトのSETTINGS PROFILE。SETTINGS PROFILEは、user_config SETTINGで指定されたファイルに定義されています。

例

<default_profile>default</default_profile>

default_replica_name​

ZooKeeper 上のレプリカ名。

例

<default_replica_name>{replica}</default_replica_name>

default_replica_path​

ZooKeeper内のテーブルへのパス。

例

<default_replica_path>/clickhouse/tables/{uuid}/{shard}</default_replica_path>

default_session_timeout​

セッションのデフォルトタイムアウト時間（秒）。

<default_session_timeout>60</default_session_timeout>

dictionaries_config​

dictionaries の設定ファイルへのパスです。

パス:

  • 絶対パス、またはサーバー設定ファイルからの相対パスを指定します。
  • パスにはワイルドカードの * および ? を含めることができます。

関連項目:

例

<dictionaries_config>*_dictionary.xml</dictionaries_config>

dictionaries_lazy_load​

Dictionary の遅延読み込みを行います。

  • true の場合、各 Dictionary は最初に使用されたときに読み込まれます。読み込みに失敗した場合、その Dictionary を使用していた関数は例外をスローします。
  • false の場合、サーバーは起動時にすべての Dictionary を読み込みます。
注記

サーバーは、すべての Dictionary の読み込みが完了するまで起動時に待機し、その後にのみ接続を受け付けます （ただし、wait_dictionaries_load_at_startup が false に設定されている場合を除きます）。

例

<dictionaries_lazy_load>true</dictionaries_lazy_load>

dictionary_background_reconnect_interval​

background_reconnect が有効になっている MySQL および Postgres の Dictionary について、接続に失敗した場合に再接続を試行する間隔（ミリ秒単位）。

disable_insertion_and_mutation​

INSERT/ALTER/DELETE クエリを無効にします。読み取り専用ノードが必要な場合に、この設定を有効にすると、挿入やミューテーションが読み取りパフォーマンスに影響を与えるのを防げます。S3、DataLake、MySQL、PostrgeSQL、Kafka などの外部エンジンへの INSERT は、この設定にかかわらず許可されます。

disable_internal_dns_cache​

内部 DNS キャッシュを無効にします。Kubernetes のようにインフラストラクチャが頻繁に変化するシステムで ClickHouse を運用する場合に、この設定を推奨します。

disable_tunneling_for_https_requests_over_http_proxy​

デフォルトでは、トンネリング（HTTP CONNECT）を使用して HTTP プロキシ経由で HTTPS リクエストを行います。この設定を使用すると、トンネリングを無効化できます。

no_proxy

デフォルトでは、すべてのリクエストがプロキシを経由します。特定のホストに対してプロキシを無効にするには、no_proxy 変数を設定する必要があります。 これは、list および remote resolver では <proxy> 句の中で、environment resolver では環境変数として設定できます。 IP アドレス、ドメイン、サブドメイン、および完全にバイパスするためのワイルドカード '*' をサポートします。curl と同様に、先頭のドットは削除されます。

Example

次の設定では、clickhouse.cloud およびそのすべてのサブドメイン（例: auth.clickhouse.cloud）へのリクエストはプロキシをバイパスします。 GitLab についても同様で、先頭にドットを付けて指定した場合でも同じように扱われます。gitlab.com と about.gitlab.com の両方がプロキシをバイパスします。

<proxy>
    <no_proxy>clickhouse.cloud,.gitlab.com</no_proxy>
    <http>
        <uri>http://proxy1</uri>
        <uri>http://proxy2:3128</uri>
    </http>
    <https>
        <uri>http://proxy1:3128</uri>
    </https>
</proxy>

disk_connections_hard_limit​

この制限に達すると、作成時に例外がスローされます。0 に設定するとハード制限を無効にできます。この制限はディスク接続数に適用されます。

disk_connections_soft_limit​

この上限を超えた接続は、有効期間 (time to live, TTL) が大幅に短くなります。この上限はディスク接続に適用されます。

disk_connections_store_limit​

この上限を超える接続は、使用後にリセットされます。接続キャッシュを無効にするには 0 に設定します。この上限はディスクへの接続に適用されます。

disk_connections_warn_limit​

使用中の接続数がこの制限を超えた場合、警告メッセージがログに書き込まれます。この制限はディスクの接続に適用されます。

display_secrets_in_show_and_select​

テーブル、データベース、テーブル関数、およびディクショナリに対して実行される SHOW および SELECT クエリで、シークレットを表示するかどうかを有効または無効にします。

シークレットを表示したいユーザーは、 format_display_secrets_in_show_and_select フォーマット設定 を有効にし、かつ displaySecretsInShowAndSelect 権限を持っている必要があります。

取り得る値:

  • 0 — 無効。
  • 1 — 有効。

distributed_cache_apply_throttling_settings_from_client​

キャッシュサーバーがクライアントから受信したスロットリング設定を適用するかどうかを制御します。

distributed_cache_keep_up_free_connections_ratio​

distributed cache が維持しようとする空き接続数に対するソフトリミットです。空き接続数が distributed_cache_keep_up_free_connections_ratio * max_connections を下回ると、この制限を上回るまで、最後のアクティビティが最も古い接続から順に閉じられます。

distributed_ddl​

クラスタ上で 分散 DDL クエリ（CREATE、DROP、ALTER、RENAME）の実行を管理します。 ZooKeeper が有効になっている場合にのみ動作します。

<distributed_ddl> 内で設定可能な項目は次のとおりです。

SettingDescriptionDefault Value
pathDDL クエリ用の task_queue がある Keeper 内のパス
profileDDL クエリの実行に使用されるプロファイル
pool_size同時に実行できる ON CLUSTER クエリの数
max_tasks_in_queueキュー内に保持できるタスクの最大数1,000
task_max_lifetimeノードの存続時間がこの値を超えた場合、そのノードを削除します。7 * 24 * 60 * 60（秒単位で 1 週間）
cleanup_delay_period新しいノードイベントを受信したとき、前回のクリーンアップから cleanup_delay_period 秒以上経過していればクリーンアップを開始します。60 秒

例

<distributed_ddl>
    <!-- ZooKeeper内のDDLクエリキューへのパス -->
    <path>/clickhouse/task_queue/ddl</path>

    <!-- このプロファイルの設定を使用してDDLクエリを実行します -->
    <profile>default</profile>

    <!-- ON CLUSTERクエリの同時実行数を制御します -->
    <pool_size>1</pool_size>

    <!--
         クリーンアップ設定（アクティブなタスクは削除されません）
    -->

    <!-- タスクの有効期限 (TTL) を制御します（デフォルト: 1週間） -->
    <task_max_lifetime>604800</task_max_lifetime>

    <!-- クリーンアップの実行間隔を制御します（秒単位） -->
    <cleanup_delay_period>60</cleanup_delay_period>

    <!-- キューに保持できるタスク数を制御します -->
    <max_tasks_in_queue>1000</max_tasks_in_queue>
</distributed_ddl>

distributed_ddl_use_initial_user_and_roles​

有効にすると、ON CLUSTER クエリはリモート分片での実行時に、クエリを開始したユーザーとロールを引き継いで使用します。これによりクラスタ全体でアクセス制御の一貫性が保たれますが、すべてのノードに同じユーザーとロールが存在している必要があります。

dns_allow_resolve_names_to_ipv4​

ホスト名を IPv4 アドレスへ名前解決することを許可します。

dns_allow_resolve_names_to_ipv6​

ホスト名を IPv6 アドレスに解決できるようにします。

dns_cache_max_entries​

内部 DNS キャッシュのエントリの最大数。

dns_cache_update_period​

内部 DNS キャッシュを更新する間隔（秒）。

dns_max_consecutive_failures​

ClickHouse の DNS キャッシュからホスト名を削除する前に許容される、そのホスト名の DNS 解決失敗の連続発生の最大回数。

drop_distributed_cache_pool_size​

分散キャッシュを削除する際に使用されるスレッドプールのサイズ。

drop_distributed_cache_queue_size​

分散キャッシュをドロップする際に使用されるスレッドプールのキューサイズ。

enable_azure_sdk_logging​

Azure SDK によるログ出力を有効にします

encryption​

encryption codecs で使用されるキーを取得するコマンドを設定します。キー（または複数のキー）は、環境変数に書き込むか、設定ファイル内で設定する必要があります。

キーは、16 バイト長の 16 進数または文字列である必要があります。

例

設定ファイルから読み込む:

<encryption_codecs>
    <aes_128_gcm_siv>
        <key>1234567812345678</key>
    </aes_128_gcm_siv>
</encryption_codecs>
注記

キーを設定ファイルに保存することは推奨されません。安全ではありません。安全なディスク上の別の設定ファイルにキーを移動し、その設定ファイルへのシンボリックリンクを config.d/ フォルダに配置できます。

キーが 16 進数表記の場合の、設定ファイルからの読み込み:

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

環境変数からキーを読み込む:

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

ここで current_key_id は暗号化に使用する現在のキーを指定し、指定したすべてのキーを復号に使用できます。

これらの各手法は、複数のキーに対して適用できます。

<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>

ここで current_key_id は、暗号化に使用されている現在のキーを示します。

また、ユーザーは長さが 12 バイトでなければならないノンスを追加することもできます（デフォルトでは、暗号化および復号処理はゼロバイトのみで構成されたノンスを使用します）:

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

または16進数で指定することもできます：

<encryption_codecs>
    <aes_128_gcm_siv>
        <nonce_hex>abcdefabcdef</nonce_hex>
    </aes_128_gcm_siv>
</encryption_codecs>
注記

上記の内容はすべて aes_256_gcm_siv にも適用できます（ただし、キーは32バイト長である必要があります）。

error_log​

デフォルトでは無効になっています。

有効化

エラー履歴の収集 system.error_log を手動で有効化するには、次の内容で /etc/clickhouse-server/config.d/error_log.xml を作成します。

<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>

無効化

error_log 設定を無効化するには、次の内容で /etc/clickhouse-server/config.d/disable_error_log.xml ファイルを作成します。

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

The following settings can be configured by sub-tags:

SettingDescriptionDefaultNote
databaseデータベース名。
tableシステムテーブル名。
engineシステムテーブルに対する MergeTree エンジン定義。partition_by または order_by が定義されている場合は使用できません。指定しない場合はデフォルトで MergeTree が選択されます
partition_byシステムテーブルに対するカスタムパーティショニングキー。システムテーブルに engine を指定する場合、partition_by パラメータは engine の設定内で直接指定する必要があります
ttlテーブルの TTL を指定します。システムテーブルに engine を指定する場合、ttl パラメータは engine の設定内で直接指定する必要があります
order_byシステムテーブルに対するカスタムソートキー。engine が定義されている場合は使用できません。システムテーブルに engine を指定する場合、order_by パラメータは engine の設定内で直接指定する必要があります
storage_policyテーブルに使用するストレージポリシー名（任意）。システムテーブルに engine を指定する場合、storage_policy パラメータは engine の設定内で直接指定する必要があります
settingsMergeTree の動作を制御する追加パラメータ（任意）。システムテーブルに engine を指定する場合、settings パラメータは engine の設定内で直接指定する必要があります
flush_interval_millisecondsメモリ上のバッファからテーブルへデータをフラッシュする間隔。7500
max_size_rowsログの最大行数。未フラッシュのログ数が max_size_rows に達すると、ログがディスクにダンプされます。1048576
reserved_size_rowsログ用に事前確保されるメモリ容量（行数）。8192
buffer_size_rows_flush_threshold行数のしきい値。このしきい値に達すると、バックグラウンドでログをディスクへフラッシュする処理が起動します。max_size_rows / 2
flush_on_crashクラッシュ発生時にログをディスクへダンプするかどうかを設定します。false

format_parsing_thread_pool_queue_size​

入力のパースに使用されるスレッドプールにスケジュールできるジョブ数の上限。

注記

0 の値は無制限を意味します。

format_schema_path​

入力データ用のスキーマが含まれるディレクトリへのパスです。たとえば、CapnProto 形式のスキーマなどです。

例

<!-- 各種入力フォーマットのスキーマファイルを格納するディレクトリ。 -->
<format_schema_path>format_schemas/</format_schema_path>

global_profiler_cpu_time_period_ns​

グローバルプロファイラにおけるCPUクロックタイマーの周期（ナノ秒単位）。グローバルCPUクロックプロファイラを無効にするには、値を 0 に設定します。単一クエリのプロファイリングには少なくとも 10000000（1秒あたり100回）、クラスター全体のプロファイリングには 1000000000（1秒あたり1回）以上の値を推奨します。

global_profiler_real_time_period_ns​

グローバルプロファイラの実時間クロックタイマーの周期（ナノ秒単位）。実時間クロックを用いるグローバルプロファイラを無効にするには 0 を設定します。推奨値は、単一クエリの場合は少なくとも 10000000（1 秒間に 100 回）、クラスタ全体のプロファイリングの場合は 1000000000（1 秒に 1 回）です。

google_protos_path​

Protobuf 型の proto ファイルが格納されているディレクトリを指定します。

例:

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

graphite​

Graphite にデータを送信します。

設定:

  • host – Graphite サーバー。
  • port – Graphite サーバー上のポート。
  • interval – 送信間隔（秒）。
  • timeout – データ送信のタイムアウト（秒）。
  • root_path – キーのプレフィックス。
  • metrics – system.metrics テーブルのデータを送信。
  • events – system.events テーブルから、指定期間に蓄積された差分データを送信。
  • events_cumulative – system.events テーブルの累積データを送信。
  • asynchronous_metrics – system.asynchronous_metrics テーブルのデータを送信。

複数の <graphite> 句を設定できます。たとえば、異なる種類のデータを異なる間隔で送信するために利用できます。

例

<graphite>
    <host>localhost</host>
    <port>42000</port>
    <timeout>0.1</timeout>
    <interval>60</interval>
    <root_path>one_min</root_path>
    <metrics>true</metrics>
    <events>true</events>
    <events_cumulative>false</events_cumulative>
    <asynchronous_metrics>true</asynchronous_metrics>
</graphite>

graphite_rollup​

Graphite 向けのデータ間引き設定です。

詳細については、GraphiteMergeTree を参照してください。

例

<graphite_rollup_example>
    <default>
        <function>max</function>
        <retention>
            <age>0</age>
            <precision>60</precision>
        </retention>
        <retention>
            <age>3600</age>
            <precision>300</precision>
        </retention>
        <retention>
            <age>86400</age>
            <precision>3600</precision>
        </retention>
    </default>
</graphite_rollup_example>

hsts_max_age​

HSTS の有効期限（秒単位）。

注記

値が 0 の場合、ClickHouse は HSTS を無効にします。正の値を設定すると HSTS が有効になり、その値が max-age として使用されます。

例

<hsts_max_age>600000</hsts_max_age>

http_connections_hard_limit​

この制限に達している状態で新規作成を試みると、例外がスローされます。ハード制限を無効にするには 0 に設定します。この制限は、いずれのディスクやストレージにも属さない HTTP 接続に適用されます。

http_connections_soft_limit​

この上限を超えた接続の有効期間は、大幅に短くなります。この制限は、いずれのディスクやストレージにも属さない HTTP 接続に適用されます。

http_connections_store_limit​

この制限を超えた接続は、使用後にリセットされます。接続キャッシュを無効にするには 0 に設定します。この制限は、どのディスクやストレージにも属さない HTTP 接続に適用されます。

http_connections_warn_limit​

使用中の接続の数がこの制限を超えた場合、警告メッセージがログに書き込まれます。この制限は、いずれのディスクやストレージにも属さない HTTP 接続に適用されます。

http_handlers​

カスタム HTTP ハンドラーを定義して使用できるようにします。 新しい HTTP ハンドラーを追加するには、新しい <rule> を追加するだけです。 ルールは定義された順に上から下へチェックされ、 最初にマッチしたもののハンドラーが実行されます。

以下の設定はサブタグで設定できます:

Sub-tagsDefinition
urlリクエスト URL をマッチさせるために使用します。regex: プレフィックスを付けると、正規表現でのマッチが可能です (任意)
methodsリクエストメソッドをマッチさせるために使用します。カンマ区切りで複数のメソッドを指定できます (任意)
headersリクエストヘッダーをマッチさせるために使用します。各子要素 (子要素名がヘッダー名) をマッチさせます。regex: プレフィックスを付けると、正規表現でのマッチが可能です (任意)
handlerリクエストハンドラー
empty_query_stringURL にクエリ文字列が存在しないことをチェックします

handler には以下の設定が含まれ、サブタグで設定できます:

Sub-tagsDefinition
urlリダイレクト先の URL
typeサポートされるタイプ: static, dynamic_query_handler, predefined_query_handler, redirect
statusstatic タイプで使用します。レスポンスのステータスコード
query_param_namedynamic_query_handler タイプで使用します。HTTP リクエストパラメータ内で <query_param_name> に対応する値を取り出して実行します
querypredefined_query_handler タイプで使用します。ハンドラーが呼び出されたときにクエリを実行します
content_typestatic タイプで使用します。レスポンスの Content-Type
response_contentstatic タイプで使用します。クライアントに送信されるレスポンスコンテンツです。file:// または config:// のプレフィックスを使用した場合、ファイルまたは設定からコンテンツを取得してクライアントに送信します

ルールの一覧に加えて、すべてのデフォルトハンドラーを有効にする <defaults/> を指定できます。

Example:

<http_handlers>
    <rule>
        <url>/</url>
        <methods>POST,GET</methods>
        <headers><pragma>no-cache</pragma></headers>
        <handler>
            <type>dynamic_query_handler</type>
            <query_param_name>query</query_param_name>
        </handler>
    </rule>

    <rule>
        <url>/predefined_query</url>
        <methods>POST,GET</methods>
        <handler>
            <type>predefined_query_handler</type>
            <query>SELECT * FROM system.settings</query>
        </handler>
    </rule>

    <rule>
        <handler>
            <type>static</type>
            <status>200</status>
            <content_type>text/plain; charset=UTF-8</content_type>
            <response_content>config://http_server_default_response</response_content>
        </handler>
    </rule>
</http_handlers>

http_options_response​

OPTIONS HTTP リクエストのレスポンスヘッダーを追加するために使用します。 OPTIONS メソッドは、CORS プリフライトリクエストを行う際に使用されます。

詳細は OPTIONS を参照してください。

例:

<http_options_response>
     <header>
            <name>Access-Control-Allow-Origin</name>
            <value>*</value>
     </header>
     <header>
          <name>Access-Control-Allow-Headers</name>
          <value>origin, x-requested-with, x-clickhouse-format, x-clickhouse-user, x-clickhouse-key, Authorization</value>
     </header>
     <header>
          <name>Access-Control-Allow-Methods</name>
          <value>POST, GET, OPTIONS</value>
     </header>
     <header>
          <name>Access-Control-Max-Age</name>
          <value>86400</value>
     </header>
</http_options_response>

http_server_default_response​

ClickHouse の HTTP(S) サーバーにアクセスしたときに、デフォルトで表示されるページです。 デフォルト値は「Ok.」（末尾に改行付き）です。

例

http://localhost:http_port にアクセスしたときに https://tabix.io/ を開きます。

<http_server_default_response>
  <![CDATA[<html ng-app="SMI2"><head><base href="http://ui.tabix.io/"></head><body><div ui-view="" class="content-ui"></div><script src="http://loader.tabix.io/master.js"></script></body></html>]]>
</http_server_default_response>

iceberg_catalog_threadpool_pool_size​

Iceberg カタログのバックグラウンドプールのサイズ

iceberg_catalog_threadpool_queue_size​

Iceberg カタログプールにキューイング可能なタスク数

iceberg_metadata_files_cache_max_entries​

Iceberg メタデータファイルキャッシュの最大エントリ数。0 を指定すると無効になります。

iceberg_metadata_files_cache_policy​

Iceberg のメタデータファイルキャッシュポリシー名。

iceberg_metadata_files_cache_size​

Iceberg メタデータキャッシュの最大サイズ（バイト単位）。0 を指定すると無効になります。

iceberg_metadata_files_cache_size_ratio​

iceberg メタデータキャッシュにおいて、キャッシュ全体サイズに対する（SLRU ポリシー使用時の）保護キューサイズの割合。

ignore_empty_sql_security_in_create_view_query​

true の場合、ClickHouse は CREATE VIEW クエリで空の SQL security ステートメントに対して既定値を保存しません。

注記

この設定は移行期間中にのみ必要であり、バージョン 24.4 では不要になります。

include_from​

置換定義が記述されたファイルへのパスです。XML と YAML の両方の形式がサポートされています。

詳細については、「設定ファイル」のセクションを参照してください。

例

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

index_mark_cache_policy​

セカンダリ索引マークキャッシュのポリシー名。

index_mark_cache_size​

インデックスマークキャッシュの最大サイズ。

注記

0 を指定すると無効になります。

この設定は実行時に変更でき、直ちに反映されます。

index_mark_cache_size_ratio​

セカンダリ索引マークキャッシュにおける保護キュー（SLRU ポリシーの場合）のサイズを、キャッシュ全体のサイズに対する比率として指定します。

index_uncompressed_cache_policy​

セカンダリ索引用の非圧縮キャッシュポリシー名。

index_uncompressed_cache_size​

非圧縮の MergeTree 索引ブロックキャッシュの最大サイズ。

注記

0 を指定するとキャッシュは無効になります。

この設定は実行時に変更でき、直ちに反映されます。

index_uncompressed_cache_size_ratio​

セカンダリ索引の非圧縮キャッシュにおいて、保護キュー（SLRU ポリシーの場合）のサイズがキャッシュ全体サイズに対して占める比率を表します。

interserver_http_credentials​

レプリケーション時に他のサーバーへ接続するために使用されるユーザー名とパスワードです。加えて、サーバーはこれらの認証情報を使って他のレプリカを認証します。 したがって、interserver_http_credentials はクラスター内のすべてのレプリカで同一である必要があります。

注記
  • 既定では、interserver_http_credentials セクションが省略された場合、レプリケーション時に認証は使用されません。
  • interserver_http_credentials の設定は、ClickHouse クライアント認証情報の設定とは関係ありません。
  • これらの認証情報は、HTTP および HTTPS を介したレプリケーションに共通です。

次の設定はサブタグで構成できます:

  • user — ユーザー名。
  • password — パスワード。
  • allow_empty — true の場合、認証情報が設定されていても、他のレプリカが認証なしで接続することを許可します。false の場合、認証なしの接続は拒否されます。既定値: false。
  • old — 認証情報ローテーション時に使用される、古い user と password を保持します。複数の old セクションを指定できます。

認証情報のローテーション

ClickHouse は、すべてのレプリカを同時に停止して設定を更新することなく、インターサーバー認証情報の動的なローテーションをサポートします。認証情報は複数の手順で変更できます。

認証を有効にするには、interserver_http_credentials.allow_empty を true に設定し、認証情報を追加します。これにより、認証の有無にかかわらず接続を許可できます。

<interserver_http_credentials>
    <user>admin</user>
    <password>111</password>
    <allow_empty>true</allow_empty>
</interserver_http_credentials>

すべてのレプリカの構成が完了したら、allow_empty を false に設定するか、この SETTING を削除します。これにより、新しい認証情報の指定が必須になります。

既存の認証情報を変更するには、ユーザー名とパスワードを interserver_http_credentials.old セクションに移動し、user と password を新しい値に更新します。この時点では、サーバーは他のレプリカに接続する際に新しい認証情報を使用し、新旧どちらの認証情報での接続も受け付けます。

<interserver_http_credentials>
    <user>admin</user>
    <password>222</password>
    <old>
        <user>admin</user>
        <password>111</password>
    </old>
    <old>
        <user>temp</user>
        <password>000</password>
    </old>
</interserver_http_credentials>

新しい認証情報がすべてのレプリカに適用されたら、古い認証情報は削除できます。

interserver_http_host​

他のサーバーがこのサーバーにアクセスするために使用できるホスト名です。

省略した場合は、hostname -f コマンドと同じ方法で決定されます。

特定のネットワークインターフェイスに依存したくない場合に便利です。

例

<interserver_http_host>example.clickhouse.com</interserver_http_host>

interserver_http_port​

ClickHouse サーバー間でデータをやり取りするためのポート。

例

<interserver_http_port>9009</interserver_http_port>

interserver_https_host​

interserver_http_host と類似していますが、このホスト名は他のサーバーから HTTPS 経由でこのサーバーにアクセスするために使用されます。

例

<interserver_https_host>example.clickhouse.com</interserver_https_host>

interserver_https_port​

HTTPS 経由で ClickHouse サーバー間のデータ交換に使用するポート。

例

<interserver_https_port>9010</interserver_https_port>

interserver_listen_host​

ClickHouse サーバー間でデータを交換できるホストを制限します。 Keeper を使用している場合は、異なる Keeper インスタンス間の通信にも同じ制限が適用されます。

注記

デフォルトでは、この値は listen_host 設定と同じです。

例

<interserver_listen_host>::ffff:a00:1</interserver_listen_host>
<interserver_listen_host>10.0.0.1</interserver_listen_host>

型:

デフォルト:

io_thread_pool_queue_size​

I/O スレッドプールにスケジュールできるジョブの最大数。

注記

値が 0 の場合は無制限を意味します。

jemalloc_collect_global_profile_samples_in_trace_log​

jemalloc がサンプリングしたメモリアロケーションを system.trace_log に保存します

jemalloc_enable_background_threads​

jemalloc のバックグラウンドスレッド機能を有効にします。jemalloc はバックグラウンドスレッドを使用して未使用のメモリページを解放します。これを無効にするとパフォーマンスの低下を招く可能性があります。

jemalloc_enable_global_profiler​

すべてのスレッドに対して jemalloc のアロケーションプロファイラを有効にします。jemalloc は割り当てと、サンプリング対象となった割り当てに対するすべての解放をサンプリングします。 プロファイルは、SYSTEM JEMALLOC FLUSH PROFILE を使用してフラッシュでき、アロケーション分析に利用できます。 サンプルは、設定項目 jemalloc_collect_global_profile_samples_in_trace_log を使用して system.trace_log に保存することもでき、あるいはクエリ設定 jemalloc_collect_profile_samples_in_trace_log を使用して保存することもできます。 Allocation Profiling を参照してください。

jemalloc_flush_profile_interval_bytes​

jemalloc によるグローバルなピークメモリ使用量が jemalloc_flush_profile_interval_bytes だけ増加すると、jemalloc プロファイルがフラッシュされます

jemalloc_flush_profile_on_memory_exceeded​

総メモリ超過エラー発生時に jemalloc プロファイルをフラッシュします

jemalloc_max_background_threads_num​

作成する jemalloc のバックグラウンドスレッドの最大数。0 に設定すると jemalloc のデフォルト値が使用されます。

keep_alive_timeout​

HTTP プロトコルで新しいリクエストを待機する最大秒数。この秒数を経過すると、ClickHouse は接続を閉じます。

例

<keep_alive_timeout>10</keep_alive_timeout>

keeper_hosts​

動的な設定です。ClickHouse が接続できる可能性のある [Zoo]Keeper ホストの集合を含みます。<auxiliary_zookeepers> の情報は公開されません。

keeper_multiread_batch_size​

バッチ処理をサポートしている [Zoo]Keeper への MultiRead リクエストにおけるバッチの最大サイズです。0 に設定すると、バッチ処理は無効になります。ClickHouse Cloud でのみ利用可能です。

ldap_servers​

ここには、LDAP サーバーとその接続パラメータを列挙します。用途は次のとおりです。

  • password の代わりに ldap 認証メカニズムが指定されている専用ローカルユーザーの認証器として利用する
  • リモートユーザーディレクトリとして利用する

以下の設定はサブタグで構成できます:

SettingDescription
hostLDAP サーバーのホスト名または IP。必須パラメータであり、空にはできません。
portLDAP サーバーのポート。enable_tls が true に設定されている場合のデフォルトは 636、それ以外の場合は 389 です。
bind_dnバインドに使用する DN を構成するためのテンプレート。最終的な DN は、各認証試行時にこのテンプレート内のすべての \{user_name\} 部分文字列を実際のユーザー名に置き換えることで構成されます。
user_dn_detectionバインドされたユーザーの実際のユーザー DN を検出するための LDAP 検索パラメータを指定するセクションです。これは主に、サーバーが Active Directory の場合に、後続のロールマッピングのための検索フィルタで使用されます。結果として得られるユーザー DN は、許可されている箇所での \{user_dn\} 部分文字列の置き換えに使用されます。デフォルトではユーザー DN は bind DN と同一に設定されますが、一度検索が実行されると、実際に検出されたユーザー DN の値で更新されます。
verification_cooldownバインドが成功した後、指定された秒数の間、そのユーザーについては LDAP サーバーへ問い合わせを行わず、すべての連続するリクエストに対して認証済みとみなす期間です。0（デフォルト）を指定するとキャッシュが無効化され、各認証リクエストごとに LDAP サーバーへ問い合わせを行います。
enable_tlsLDAP サーバーへのセキュアな接続を使用するかどうかを制御するフラグです。プレーンテキストのプロトコル（ldap://、非推奨）を使用するには no を指定します。SSL/TLS 上の LDAP（ldaps://、推奨、デフォルト）を使用するには yes を指定します。レガシーな StartTLS プロトコル（プレーンテキストの ldap:// プロトコルを TLS にアップグレードする方式）を使用するには starttls を指定します。
tls_minimum_protocol_versionSSL/TLS の最小プロトコルバージョン。指定可能な値は: ssl2, ssl3, tls1.0, tls1.1, tls1.2（デフォルト）です。
tls_require_certSSL/TLS ピア証明書の検証動作。指定可能な値は: never, allow, try, demand（デフォルト）です。
tls_cert_file証明書ファイルへのパス。
tls_key_file証明書キーファイルへのパス。
tls_ca_cert_fileCA 証明書ファイルへのパス。
tls_ca_cert_dirCA 証明書を含むディレクトリへのパス。
tls_cipher_suite許可される暗号スイート（OpenSSL 表記）。

user_dn_detection はサブタグで構成できます:

SettingDescription
base_dnLDAP 検索のベース DN を構成するためのテンプレート。最終的な DN は、LDAP 検索中にこのテンプレート内のすべての \{user_name\} および \{bind_dn\} 部分文字列を、実際のユーザー名および bind DN に置き換えることで構成されます。
scopeLDAP 検索のスコープ。指定可能な値は: base, one_level, children, subtree（デフォルト）です。
search_filterLDAP 検索の検索フィルタを構成するためのテンプレート。最終的なフィルタは、LDAP 検索中にこのテンプレート内のすべての \{user_name\}、\{bind_dn\}、および \{base_dn\} 部分文字列を、実際のユーザー名、bind DN、および base DN に置き換えることで構成されます。特殊文字は XML 内で適切にエスケープする必要がある点に注意してください。

Example:

<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>

例（後続のロールマッピングのためにユーザー DN 検出を設定した典型的な Active Directory）：

<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>

license_key​

ClickHouse Enterprise Edition のライセンスキー

listen_backlog​

listen ソケットの backlog（保留中接続のキューサイズ）。デフォルト値の 4096 は Linux 5.4+) のデフォルト値と同じです。

通常、この値を変更する必要はありません。理由は次のとおりです。

  • デフォルト値が十分に大きいこと
  • クライアント接続を accept するためにサーバー側に専用スレッドがあること

そのため、たとえ TcpExtListenOverflows（nstat から取得）がゼロ以外で、このカウンタが ClickHouse サーバーで増加していたとしても、この値を増やす必要があるとは限りません。理由は次のとおりです。

  • 通常、4096 で足りない場合は、ClickHouse 内部のスケーリングに何らかの問題があることを示しているため、問題として報告する方が望ましいです。
  • それはサーバーがその後、より多くの接続を処理できることを意味しません（仮に処理できたとしても、その時点ではクライアントはすでにいなくなっている、または切断されている可能性があります）。

例

<listen_backlog>4096</listen_backlog>

listen_host​

リクエストを受け付ける送信元ホストを制限します。サーバーがすべてのホストからのリクエストに応答するようにするには、:: を指定します。

例:

<listen_host>::1</listen_host>
<listen_host>127.0.0.1</listen_host>

listen_reuse_port​

複数のサーバーが同一のアドレスとポートで待ち受けできるようにします。リクエストはオペレーティングシステムによってランダムなサーバーへルーティングされます。この設定を有効にすることは推奨されていません。

例

<listen_reuse_port>0</listen_reuse_port>

タイプ:

デフォルト:

listen_try​

サーバーは、リッスンを開始しようとした際に IPv6 または IPv4 ネットワークが利用できない場合でも、終了しません。

例

<listen_try>0</listen_try>

load_marks_threadpool_pool_size​

マーク読み込み用バックグラウンドスレッドプールのサイズ

load_marks_threadpool_queue_size​

プリフェッチ用プールに投入可能なタスク数の上限

logger​

ログメッセージの出力先とフォーマットを指定します。

キー:

KeyDescription
levelログレベル。指定可能な値: none (ログ出力を無効化)、fatal, critical, error, warning, notice, information,debug, trace, test
logログファイルへのパス。
errorlogエラーログファイルへのパス。
sizeローテーションポリシー: ログファイルの最大サイズ (バイト数)。ログファイルサイズがこの閾値を超えると、リネームおよびアーカイブされ、新しいログファイルが作成されます。
countローテーションポリシー: 履歴として保持するログファイルの最大個数。
stream_compressLZ4 を使用してログメッセージを圧縮します。有効にするには 1 または true を設定します。
consoleコンソールへのログ出力を有効にします。有効にするには 1 または true を設定します。ClickHouse がデーモンモードで動作していない場合のデフォルトは 1、それ以外は 0 です。
console_log_levelコンソール出力用のログレベル。デフォルトは level の値です。
formatting.typeコンソール出力のログフォーマット。現在は json のみがサポートされています。
use_syslogsyslog にもログ出力を転送します。
syslog_levelsyslog へのログ出力で使用するログレベル。
asynctrue (デフォルト) の場合、ログ出力は非同期で行われます (出力チャネルごとにバックグラウンドスレッド 1 本)。false の場合は LOG を呼び出したスレッド内で出力されます。
async_queue_max_size非同期ログ出力時に、フラッシュ待ちキューに保持されるメッセージの最大数。この上限を超えたメッセージは破棄されます。
startup_levelサーバー起動時にルートロガーのレベルを設定するために使用するログレベル。起動後はログレベルが level の設定値に戻されます。
shutdown_levelサーバーのシャットダウン時にルートロガーのレベルを設定するために使用するログレベル。

ログフォーマット指定子

log と errorLog のパスに含まれるファイル名部分では、以下のフォーマット指定子を使用して実際のファイル名を生成できます (ディレクトリ部分では使用できません)。

「Example」カラムは、2023-07-06 18:32:07 時点での出力例を示します。

指定子説明例
%%リテラルの %%
%n改行文字
%t水平タブ文字
%Y年を10進数で表した数値（例: 2017）2023
%y年の下2桁を10進数で表した値（範囲 [00,99]）23
%C年の最初の2桁を10進数で表した数値（範囲 [00,99]）20
%G4 桁のISO 8601 週単位の年、つまり指定した週を含む年を表します。通常は %V と組み合わせて使用する場合にのみ有用です2023
%gISO 8601 の週を基準とした年の下位2桁、すなわち指定された週を含む年を表す2桁の値。23
%b省略された月名。例: Oct（ロケールに依存）Jul
%h%b の同義語Jul
%B完全な月名。例: October（ロケール依存）7月
%m月を10進数で表す値（範囲 [01,12]）07
%U年内の週番号（10進数）（日曜日を週の最初の曜日とする）（範囲 [00,53]）27
%W年内の週番号（週の開始曜日は月曜日）を10進数で表したもの（範囲 [00,53]）27
%VISO 8601 の週番号（範囲 [01,53]）27
%j年内通算日を10進数で表した数値（範囲 [001,366]）187
%d月内の日をゼロ埋めした10進数で表します（範囲 [01,31]）。1桁の場合は先頭に 0 が付きます。06
%e月の日付を、左側をスペースで埋めた10進数で表します（範囲 [1,31]）。1桁の場合は前にスペースが入ります。&nbsp; 6
%a省略された曜日名。例: Fri（ロケールに依存）木
%A曜日名（フルスペル）。例: Friday（ロケールに依存）木曜日
%w日曜日を0とする整数値で表した曜日（範囲 [0-6]）4
%u曜日を表す10進数で、月曜日を1とする（ISO 8601 形式、範囲 [1-7]）4
%H24時間制における時を10進数で表現（範囲 [00-23]）18
%I10 進数で表した時（12 時間制、範囲 [01,12]）06
%M分を表す10進数（範囲 [00,59]）32
%S秒を表す10進数（範囲 [00,60]）07
%c標準的な日付と時刻の文字列。例: Sun Oct 17 04:41:13 2010（ロケールに依存）Thu Jul 6 18:32:07 2023
%xロケールに応じた日付表記（ロケール依存）2023/07/06
%Xローカライズされた時刻表現（例: 18:40:20 や 6:40:20 PM など、ロケールに依存）18:32:07
%D短い MM/DD/YY 形式の日付。%m/%d/%y と同等です。07/06/23
%F短い YYYY-MM-DD 形式の日付で、%Y-%m-%d と同等です2023-07-06
%rロケールに応じた12時間制の時刻06:32:07 PM
%R「%H:%M」と同等18:32
%T"%H:%M:%S"（ISO 8601 の時刻形式）と同等18:32:07
%pロケールに応じた午前／午後（a.m./p.m.）の表記PM
%zISO 8601 形式の UTC からのオフセット（例: -0430）、またはタイムゾーン情報がない場合は文字を含めません+0800
%Zロケールに応じたタイムゾーン名または略称。タイムゾーン情報が利用できない場合は何も出力されないZ AWST

例

<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>

ログメッセージをコンソールのみに出力するには次のようにします:

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

レベルごとのオーバーライド

個々のログ名ごとにログレベルを上書きできます。たとえば、ロガー「Backup」と「RBAC」のすべてのメッセージ出力を抑制する場合です。

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

syslog

ログメッセージを 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>

&lt;syslog&gt; 用のキー:

KeyDescription
addresshost\[:port\] 形式で指定する syslog のアドレス。省略した場合はローカルの syslog デーモンが使用されます。
hostnameログを送信するホスト名（省略可能）。
facilitysyslog の facility keyword。必ず大文字で、かつ "LOG_" プレフィックスを付けて指定する必要があります（例: LOG_USER, LOG_DAEMON, LOG_LOCAL3 など）。デフォルト: address が指定されている場合は LOG_USER、それ以外は LOG_DAEMON。
formatログメッセージの形式。指定可能な値: bsd および syslog.

Log formats

コンソールログに出力されるログ形式を指定できます。現在は JSON のみがサポートされています。

Example

出力される JSON ログの例を次に示します:

{
  "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"
}

JSON ログのサポートを有効にするには、次のスニペットを使用します。

<logger>
    <formatting>
        <type>json</type>
        <!-- チャネルごと(log、errorlog、console、syslog)に設定することも、全チャネルに対してグローバルに設定すること(その場合は省略)も可能です。 -->
        <!-- <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>

JSON ログのキー名の変更

キー名は、<names> タグ内のタグ値を変更することで変更できます。たとえば、DATE_TIME を MY_DATE_TIME に変更するには、<date_time>MY_DATE_TIME</date_time> を使用します。

JSON ログのキーの省略

ログプロパティは、そのプロパティをコメントアウトすることで省略できます。たとえば、ログに query_id を出力しないようにしたい場合は、<query_id> タグをコメントアウトします。

macros​

レプリケートテーブル向けのパラメータ代入です。

レプリケートテーブルを使用しない場合は省略できます。

詳細については、Creating replicated tables セクションを参照してください。

例

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

mark_cache_policy​

マークキャッシュポリシーの名前。

mark_cache_prewarm_ratio​

事前ウォームアップ時にプリウォームする mark cache の総サイズに対する割合。

mark_cache_size​

MergeTree ファミリーのテーブルで使用されるマーク（索引）のキャッシュの最大サイズです。

注記

この設定は実行時に変更でき、直ちに反映されます。

mark_cache_size_ratio​

マークキャッシュにおいて、SLRU ポリシー使用時の保護キューのサイズを、キャッシュ全体のサイズに対する比率で指定します。

max_active_parts_loading_thread_pool_size​

起動時にアクティブなデータパーツ集合をロードするスレッド数。

max_authentication_methods_per_user​

ユーザーごとに作成または変更できる認証方式の最大数です。 この設定を変更しても既存のユーザーには影響しません。認証に関連する CREATE/ALTER クエリが、この設定で指定された上限を超えると失敗します。 認証に関連しない CREATE/ALTER クエリは成功します。

注記

値が 0 の場合は無制限を意味します。

max_backup_bandwidth_for_server​

サーバー上のすべてのバックアップに対する、1 秒あたりの最大読み取り帯域幅（バイト数）です。0 を指定すると無制限になります。

max_backups_io_thread_pool_free_size​

Backups IO Thread プール内のアイドルスレッド数が max_backup_io_thread_pool_free_size を超えた場合、ClickHouse はアイドル状態のスレッドが占有しているリソースを解放し、プールサイズを縮小します。必要に応じて、スレッドは再度作成されます。

max_backups_io_thread_pool_size​

ClickHouse は Backups IO Thread プール内のスレッドを使用して、S3 バックアップの I/O 操作を実行します。max_backups_io_thread_pool_size は、このプール内のスレッド数の上限を設定します。

max_build_vector_similarity_index_thread_pool_size​

ベクトル索引を構築する際に使用するスレッド数の上限です。

注記

0 を指定すると、すべてのコアが使用されます。

max_concurrent_insert_queries​

同時に実行できる挿入クエリの総数の上限。

注記

値が 0（デフォルト）の場合は無制限となります。

この設定は実行時に変更でき、即座に反映されます。すでに実行中のクエリには影響しません。

max_concurrent_queries​

同時に実行できるクエリの総数の上限です。INSERT および SELECT クエリに対する上限や、ユーザーのクエリ数の最大値に対する制限も合わせて考慮する必要があります。

関連項目:

注記

0（デフォルト）の場合は無制限を意味します。

この設定は実行時に変更でき、即座に反映されます。すでに実行中のクエリには適用されません。

max_concurrent_select_queries​

同時に実行できる SELECT クエリ数の合計の上限。

注記

0（デフォルト）の場合は無制限を意味します。

この設定は実行時に変更でき、即座に反映されます。すでに実行中のクエリには影響しません。

max_connections​

サーバーの最大接続数。

max_database_num_to_throw​

データベース数がこの値を超えると、サーバーは例外を発生させます。0 を指定すると制限なしになります。

max_database_num_to_warn​

アタッチ済みのデータベース数が指定された値を超えた場合、ClickHouse サーバーは警告メッセージを system.warnings テーブルに追加します。

例

<max_database_num_to_warn>50</max_database_num_to_warn>

max_database_replicated_create_table_thread_pool_size​

DatabaseReplicated データベースでレプリカのリカバリ中にテーブルを作成するためのスレッド数。0 の場合、スレッド数はコア数と同じになります。

max_dictionary_num_to_throw​

Dictionary の数がこの値を超えると、サーバーは例外を送出します。

次のデータベースエンジンを使用するテーブルのみをカウントします:

  • Atomic
  • Ordinary
  • Replicated
  • Lazy
注記

値が 0 の場合、制限はありません。

例

<max_dictionary_num_to_throw>400</max_dictionary_num_to_throw>

max_dictionary_num_to_warn​

アタッチされている Dictionary の数が指定した値を超えると、ClickHouse サーバーは system.warnings テーブルに警告メッセージを追加します。

例

<max_dictionary_num_to_warn>400</max_dictionary_num_to_warn>

max_distributed_cache_read_bandwidth_for_server​

サーバーにおける分散キャッシュからの合計読み取り速度の上限（1 秒あたりのバイト数）。0 は無制限を意味します。

max_distributed_cache_write_bandwidth_for_server​

サーバーの分散キャッシュに対する合計書き込み速度の上限を、1 秒あたりのバイト数で指定します。0 は無制限を意味します。

max_entries_for_hash_table_stats​

集約中に収集されるハッシュテーブル統計に含めることができるエントリ数の上限

max_fetch_partition_thread_pool_size​

ALTER TABLE FETCH PARTITION 操作に使用されるスレッド数。

max_format_parsing_thread_pool_free_size​

入力をパースするためのスレッドプールにおいて、アイドル状態で待機させておくスレッドの最大数。

max_format_parsing_thread_pool_size​

入力の解析に使用されるスレッドの合計最大数。

max_io_thread_pool_free_size​

IO スレッドプール内のアイドルスレッド数が max_io_thread_pool_free_size を超えると、ClickHouse はこれらのスレッドが占有しているリソースを解放し、プールサイズを縮小します。必要に応じて、スレッドは再作成されます。

max_io_thread_pool_size​

ClickHouse は IO スレッドプール内のスレッドを使用して、S3 とのやり取りなどの一部の IO 処理を実行します。max_io_thread_pool_size は、プール内のスレッド数の上限を指定します。

max_keep_alive_requests​

1 つの keep-alive 接続で、ClickHouse サーバーによって接続が閉じられるまでに許可されるリクエストの最大数。

例

<max_keep_alive_requests>10</max_keep_alive_requests>

max_local_read_bandwidth_for_server​

ローカル読み取りの最大速度（バイト/秒）。

注記

値が 0 の場合、無制限を意味します。

max_local_write_bandwidth_for_server​

ローカルへの書き込み速度の上限（1 秒あたりのバイト数）。

注記

値が 0 の場合は無制限を意味します。

max_materialized_views_count_for_table​

テーブルに関連付けられる materialized view の数の上限。

注記

ここではテーブルに直接依存する view のみが対象であり、ある view を基に別の view を作成する場合は対象外です。

max_merges_bandwidth_for_server​

サーバーで実行されるすべてのマージ処理における最大読み取り速度（1 秒あたりのバイト数）。0 の場合は無制限を意味します。

max_mutations_bandwidth_for_server​

サーバー上のすべての mutation の最大読み取り帯域幅（1 秒あたりのバイト数）。0 の場合は無制限です。

max_named_collection_num_to_throw​

名前付きコレクションの数がこの値を超える場合、サーバーは例外をスローします。

注記

0 は、制限がないことを意味します。

例

<max_named_collection_num_to_throw>400</max_named_collection_num_to_throw>

max_named_collection_num_to_warn​

名前付きコレクションの数が指定された値を超えた場合、ClickHouse server は警告メッセージを system.warnings テーブルに追加します。

例

<max_named_collection_num_to_warn>400</max_named_collection_num_to_warn>

max_open_files​

最大で開くことのできるファイル数。

注記

getrlimit() 関数が誤った値を返すため、macOS ではこのオプションの使用を推奨しています。

例

<max_open_files>262144</max_open_files>

max_os_cpu_wait_time_ratio_to_drop_connection​

接続を切断するかどうかを判断するために使用される、OS における CPU の待機時間（OSCPUWaitMicroseconds メトリクス）とビジー時間（OSCPUVirtualTimeMicroseconds メトリクス）の最大比。切断の発生確率の計算には、この比の最小値と最大値の間の線形補間が使用され、この値に達した時点で確率は 1 になります。 詳細については、サーバー CPU 高負荷時の動作制御 を参照してください。

max_outdated_parts_loading_thread_pool_size​

起動時に非アクティブなデータパーツ（古いパーツ）の集合を読み込むためのスレッド数。

max_part_num_to_warn​

アクティブなパーツの数が指定した値を超えた場合、ClickHouse サーバーは system.warnings テーブルに警告メッセージを追加します。

例

<max_part_num_to_warn>400</max_part_num_to_warn>

max_partition_size_to_drop​

パーティション削除に対する制限です。

MergeTree テーブルのサイズが max_partition_size_to_drop（バイト単位）を超える場合、DROP PARTITION クエリを使用してパーティションを削除することはできません。 この設定を適用するために ClickHouse サーバーを再起動する必要はありません。制限を無効化する別の方法として、<clickhouse-path>/flags/force_drop_table ファイルを作成する手段もあります。

注記

値が 0 の場合、制限なしでパーティションを削除できます。

この制限は DROP TABLE および TRUNCATE TABLE には適用されません。max_table_size_to_drop を参照してください。

例

<max_partition_size_to_drop>0</max_partition_size_to_drop>

max_parts_cleaning_thread_pool_size​

非アクティブなデータパーツを同時に削除するためのスレッド数。

max_pending_mutations_execution_time_to_warn​

保留中のミューテーションのいずれかが指定した値（秒）を超えた場合、ClickHouse サーバーは警告メッセージを system.warnings テーブルに追加します。

例

<max_pending_mutations_execution_time_to_warn>10000</max_pending_mutations_execution_time_to_warn>

max_pending_mutations_to_warn​

保留中の mutation の数が指定された値を超えると、ClickHouse サーバーは system.warnings テーブルに警告メッセージを追加します。

例

<max_pending_mutations_to_warn>400</max_pending_mutations_to_warn>

max_prefixes_deserialization_thread_pool_free_size​

prefixes のデシリアライゼーション用スレッドプール内のアイドルスレッド数が max_prefixes_deserialization_thread_pool_free_size を超えた場合、ClickHouse はそれらのスレッドが占有しているリソースを解放し、プールのサイズを縮小します。スレッドは必要に応じて再作成されます。

max_prefixes_deserialization_thread_pool_size​

ClickHouse は、MergeTree の Wide パーツにおけるファイルプレフィックスからカラムおよびサブカラムのメタデータを並列に読み取るために、プレフィックスのデシリアライズ用スレッドプールからスレッドを使用します。max_prefixes_deserialization_thread_pool_size は、このプール内のスレッド数の上限を指定します。

max_remote_read_network_bandwidth_for_server​

読み取り時に、ネットワーク経由で行われるデータ転送の最大速度を、1 秒あたりのバイト数で指定します。

注記

0（デフォルト）の場合は無制限を意味します。

max_remote_write_network_bandwidth_for_server​

サーバーへの書き込み時に、ネットワーク上で行われるデータ交換の最大速度（1 秒あたりのバイト数）。

注記

0（デフォルト）の場合は無制限を意味します。

max_replicated_fetches_network_bandwidth_for_server​

レプリケートされたフェッチに対する、ネットワークでのデータ転送の最大速度（1 秒あたりのバイト数）。0 は無制限を意味します。

max_replicated_sends_network_bandwidth_for_server​

レプリケート送信におけるネットワーク上でのデータ転送の最大速度（バイト/秒）。0 を指定すると無制限になります。

max_replicated_table_num_to_throw​

レプリケートテーブルの数がこの値を超えると、サーバーは例外をスローします。

次のデータベースエンジンに属するテーブルのみがカウント対象です：

  • Atomic
  • Ordinary
  • Replicated
  • Lazy
注記

値 0 は制限なしを意味します。

例

<max_replicated_table_num_to_throw>400</max_replicated_table_num_to_throw>

max_server_memory_usage​

サーバーが使用できるメモリの最大量をバイト単位で指定します。

注記

サーバーのメモリ最大使用量は、max_server_memory_usage_to_ram_ratio の設定によってさらに制限されます。

例外的に、値が 0（デフォルト）の場合、サーバーは利用可能なすべてのメモリを使用できます（ただし、max_server_memory_usage_to_ram_ratio による制限は引き続き適用されます）。

max_server_memory_usage_to_ram_ratio​

サーバーが使用することを許可されているメモリの最大量を、利用可能なメモリ全体に対する比率で指定します。

たとえば、0.9（デフォルト）の場合、サーバーは利用可能なメモリの 90% までを使用できます。

メモリ容量の少ないシステムで、メモリ使用量を抑えるために利用します。 RAM やスワップが少ないホストでは、max_server_memory_usage_to_ram_ratio を 1 より大きな値に設定する必要がある場合があります。

注記

サーバーの最大メモリ消費量は、max_server_memory_usage の設定によってさらに制限されます。

max_session_timeout​

セッションの最大タイムアウト時間（秒）。

例:

<max_session_timeout>3600</max_session_timeout>

max_table_num_to_throw​

テーブル数がこの値を超える場合、サーバーは例外をスローします。

次のテーブルはカウントに含まれません:

  • view
  • remote
  • dictionary
  • system

次のデータベースエンジンのテーブルのみをカウントします:

  • Atomic
  • Ordinary
  • Replicated
  • Lazy
注記

0 の値は制限がないことを意味します。

例

<max_table_num_to_throw>400</max_table_num_to_throw>

max_table_num_to_warn​

アタッチされているテーブルの数が指定された値を超えると、ClickHouse サーバーは system.warnings テーブルに警告メッセージを追加します。

例

<max_table_num_to_warn>400</max_table_num_to_warn>

max_table_size_to_drop​

テーブルの削除に関する制限。

MergeTree テーブルのサイズが max_table_size_to_drop（バイト単位）を超える場合、DROP クエリや TRUNCATE クエリを使用して削除することはできません。

注記

0 を指定すると、すべてのテーブルを制限なしで削除できます。

この設定は ClickHouse サーバーを再起動しなくても反映されます。制限を無効化する別の方法として、<clickhouse-path>/flags/force_drop_table ファイルを作成することもできます。

例

<max_table_size_to_drop>0</max_table_size_to_drop>

max_temporary_data_on_disk_size​

外部集約、JOIN、ソート処理で使用される一時データに対して、ディスク上で使用できる最大容量を指定します。 この制限を超えたクエリは、例外が発生して失敗します。

注記

0 の値は無制限を意味します。

関連項目:

max_thread_pool_free_size​

グローバルスレッドプール内のアイドルスレッド数が max_thread_pool_free_size を超えると、ClickHouse は一部のスレッドによって占有されているリソースを解放し、プールサイズを縮小します。必要に応じてスレッドは再び作成されます。

例

<max_thread_pool_free_size>1200</max_thread_pool_free_size>

max_thread_pool_size​

ClickHouse はクエリを処理する際に Global Thread pool に属するスレッドを使用します。クエリを処理するためのアイドルスレッドがない場合は、プール内に新しいスレッドが作成されます。max_thread_pool_size は、プール内のスレッド数の上限を設定します。

例

<max_thread_pool_size>12000</max_thread_pool_size>

max_unexpected_parts_loading_thread_pool_size​

起動時に非アクティブな予期しないデータパーツ集合を読み込むスレッド数。

max_view_num_to_throw​

ビュー数がこの値を超えると、サーバーは例外をスローします。

次のデータベースエンジンのテーブルのみがカウントされます:

  • Atomic
  • Ordinary
  • Replicated
  • Lazy
注記

0 の場合は制限なしを意味します。

例

<max_view_num_to_throw>400</max_view_num_to_throw>

max_view_num_to_warn​

アタッチされているビューの数が指定された値を超えると、ClickHouse サーバーは警告メッセージを system.warnings テーブルに記録します。

例

<max_view_num_to_warn>400</max_view_num_to_warn>

max_waiting_queries​

同時に待機状態となるクエリの総数の上限。 待機中のクエリの実行は、必要なテーブルが非同期で読み込まれている間はブロックされます（async_load_databases を参照）。

注記

待機中のクエリは、以下の設定で制御される制限をチェックする際にはカウントされません。

この調整は、サーバー起動直後にこれらの制限にすぐに達してしまうことを避けるために行われます。

注記

値 0（デフォルト）は無制限を意味します。

この設定は実行時に変更でき、直ちに有効になります。すでに実行中のクエリには影響しません。

memory_worker_correct_memory_tracker​

jemalloc や cgroups などの外部ソースからの情報に基づいて、バックグラウンドのメモリワーカーが内部メモリトラッカーを補正するかどうかを制御します。

memory_worker_period_ms​

バックグラウンドのメモリワーカーのティック間隔を指定します。このワーカーはメモリトラッカーによるメモリ使用量を補正し、メモリ使用量が高い場合に未使用ページをクリーンアップします。0 に設定すると、メモリ使用元に応じてデフォルト値が使用されます。

memory_worker_use_cgroup​

現在の cgroup メモリ使用量情報を利用して、メモリトラッキングを補正します。

merge_tree​

MergeTree テーブルの細かなチューニングを行うための設定です。

詳細については、MergeTreeSettings.h ヘッダーファイルを参照してください。

例

<merge_tree>
    <max_suspicious_broken_parts>5</max_suspicious_broken_parts>
</merge_tree>

merge_workload​

マージ処理とその他のワークロードとの間で、リソースの利用および共有を制御するために使用します。指定した値は、すべてのバックグラウンドマージに対する workload 設定値として使用されます。MergeTree の設定で上書きできます。

関連項目

merges_mutations_memory_usage_soft_limit​

マージおよびミューテーション処理の実行に使用できる RAM の上限を設定します。 ClickHouse がこの上限に達すると、新しいバックグラウンドのマージやミューテーション処理はスケジュールされなくなりますが、すでにスケジュール済みのタスクの実行は継続されます。

注記

0 の値は無制限を意味します。

例

<merges_mutations_memory_usage_soft_limit>0</merges_mutations_memory_usage_soft_limit>

merges_mutations_memory_usage_to_ram_ratio​

デフォルト値 merges_mutations_memory_usage_soft_limit は、memory_amount * merges_mutations_memory_usage_to_ram_ratio で計算されます。

関連項目:

metric_log​

デフォルトでは無効になっています。

有効化

メトリクスの履歴収集 system.metric_log を手動で有効化するには、以下の内容を記述した /etc/clickhouse-server/config.d/metric_log.xml を作成します。

<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>

無効化

metric_log の設定を無効化するには、次の内容で /etc/clickhouse-server/config.d/disable_metric_log.xml ファイルを作成します：

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

The following settings can be configured by sub-tags:

SettingDescriptionDefaultNote
databaseデータベース名。
tableシステムテーブル名。
engineシステムテーブルに対する MergeTree エンジン定義。partition_by または order_by が定義されている場合は使用できません。指定しない場合はデフォルトで MergeTree が選択されます
partition_byシステムテーブルに対するカスタムパーティショニングキー。システムテーブルに engine を指定する場合、partition_by パラメータは engine の設定内で直接指定する必要があります
ttlテーブルの TTL を指定します。システムテーブルに engine を指定する場合、ttl パラメータは engine の設定内で直接指定する必要があります
order_byシステムテーブルに対するカスタムソートキー。engine が定義されている場合は使用できません。システムテーブルに engine を指定する場合、order_by パラメータは engine の設定内で直接指定する必要があります
storage_policyテーブルに使用するストレージポリシー名（任意）。システムテーブルに engine を指定する場合、storage_policy パラメータは engine の設定内で直接指定する必要があります
settingsMergeTree の動作を制御する追加パラメータ（任意）。システムテーブルに engine を指定する場合、settings パラメータは engine の設定内で直接指定する必要があります
flush_interval_millisecondsメモリ上のバッファからテーブルへデータをフラッシュする間隔。7500
max_size_rowsログの最大行数。未フラッシュのログ数が max_size_rows に達すると、ログがディスクにダンプされます。1048576
reserved_size_rowsログ用に事前確保されるメモリ容量（行数）。8192
buffer_size_rows_flush_threshold行数のしきい値。このしきい値に達すると、バックグラウンドでログをディスクへフラッシュする処理が起動します。max_size_rows / 2
flush_on_crashクラッシュ発生時にログをディスクへダンプするかどうかを設定します。false

min_os_cpu_wait_time_ratio_to_drop_connection​

接続を切断するかどうかを判断するための、OS における CPU の待機時間（OSCPUWaitMicroseconds メトリクス）とビジー時間（OSCPUVirtualTimeMicroseconds メトリクス）の最小比率です。切断確率を計算するために、最小比率と最大比率の間で線形補間が使用され、この比率では確率は 0 になります。 詳細は サーバー CPU 過負荷時の動作制御 を参照してください。

mlock_executable​

起動後に mlockall を実行し、最初のクエリのレイテンシを低減し、高い I/O 負荷時に ClickHouse 実行ファイルがページアウトされるのを防ぎます。

注記

このオプションを有効にすることは推奨されますが、その場合、起動時間が最大で数秒ほど長くなります。 また、この設定は「CAP_IPC_LOCK」ケーパビリティが付与されていないと機能しないことに注意してください。

例

<mlock_executable>false</mlock_executable>

mmap_cache_size​

この設定により、頻繁な open/close 呼び出し（それに伴うページフォルトのため非常にコストが高い）を回避し、複数のスレッドやクエリ間でマッピングを再利用できます。設定値はマッピングされた領域の数（通常はマッピングされたファイル数と同じ）を表します。

マッピングされたファイル内のデータ量は、次のシステムテーブルの以下のメトリクスで監視できます。

注記

マッピングされたファイル内のデータ量はメモリを直接消費せず、クエリやサーバーのメモリ使用量にも計上されません。これは、このメモリが OS のページキャッシュと同様に破棄可能であるためです。キャッシュは、MergeTree ファミリーのテーブルで古いパーツが削除されるとき（ファイルがクローズされるとき）に自動的にドロップされ、SYSTEM DROP MMAP CACHE クエリにより手動でドロップすることもできます。

この設定は実行時に変更でき、即座に有効になります。

mutation_workload​

ミューテーションとその他のワークロード間で、リソースの利用および共有を制御するために使用します。指定した値は、すべてのバックグラウンドミューテーションで workload 設定の値として使用されます。MergeTree の設定で上書きできます。

関連項目

mysql_port​

MySQL プロトコルでクライアントと通信するためのポート。

注記
  • 正の整数は待ち受けるポート番号を指定します
  • 空値は、MySQL プロトコルでのクライアントとの通信を無効にするために使用されます

例

<mysql_port>9004</mysql_port>

mysql_require_secure_transport​

true に設定されている場合、mysql_port を介したクライアントとのセキュアな通信が必須になります。--ssl-mode=none オプションでの接続は拒否されます。OpenSSL の設定と併用してください。

openSSL​

SSL クライアント/サーバー構成。

SSL のサポートは libpoco ライブラリによって提供されます。利用可能な構成オプションについては SSLManager.h を参照してください。デフォルト値は SSLManager.cpp で確認できます。

サーバー/クラアイント構成用のキー:

オプション概要デフォルト値
privateKeyFilePEM 証明書の秘密鍵ファイルへのパス。このファイルには、鍵と証明書の両方を同時に含めることができます。
certificateFilePEM 形式のクライアント／サーバー証明書ファイルへのパス。privateKeyFile に証明書が含まれている場合は指定を省略できます。
caConfig信頼された CA 証明書を含むファイルまたはディレクトリへのパス。ファイルを指す場合、そのファイルは PEM 形式でなければならず、複数の CA 証明書を含めることができます。ディレクトリを指す場合、そのディレクトリには CA 証明書ごとに 1 つの .pem ファイルを含める必要があります。ファイル名は CA サブジェクト名のハッシュ値で解決されます。詳細は SSL_CTX_load_verify_locations の man ページを参照してください。
verificationModeノード証明書の検証方法です。詳細は Context クラスの説明を参照してください。設定可能な値: none, relaxed, strict, once。relaxed
verificationDepth検証対象となる証明書チェーンの最大長。証明書チェーンの長さが設定値を超えると、検証は失敗します。9
loadDefaultCAFileOpenSSL で組み込み CA 証明書を使用するかどうかを指定します。ClickHouse は、組み込み CA 証明書がファイル /etc/ssl/cert.pem（またはディレクトリ /etc/ssl/certs）か、環境変数 SSL_CERT_FILE（または SSL_CERT_DIR）で指定されたファイル（またはディレクトリ）に存在すると想定します。true
cipherListサポートされている OpenSSL の暗号スイートALL:!ADH:!LOW:!EXP:!MD5:!3DES:@STRENGTH
cacheSessionsセッションのキャッシュを有効または無効にします。sessionIdContext と組み合わせて使用する必要があります。指定可能な値: true, false。false
sessionIdContextサーバーが生成する各識別子に付加する、一意なランダム文字列です。文字列の長さは SSL_MAX_SSL_SESSION_ID_LENGTH を超えてはなりません。サーバー側でセッションをキャッシュする場合にも、クライアントがキャッシュを要求した場合にも問題を回避できるため、このパラメータの指定を常に推奨します。$\{application.name\}
sessionCacheSizeサーバーがキャッシュするセッションの最大数です。値を 0 にすると、セッション数は無制限になります。1024*20
sessionTimeoutセッションをサーバー側にキャッシュしておく時間（時間単位）。2
extendedVerification有効にした場合は、証明書の CN または SAN がピアのホスト名と一致していることを確認してください。false
requireTLSv1TLSv1 接続を必須とします。有効な値: true, false。false
requireTLSv1_1TLSv1.1 接続を必須とします。指定可能な値：true、false。false
requireTLSv1_2TLSv1.2 接続を必須とします。許容値: true、false。false
fipsOpenSSL の FIPS モードを有効にします。ライブラリで使用している OpenSSL のバージョンが FIPS をサポートしている場合にのみ有効です。false
privateKeyPassphraseHandler秘密鍵にアクセスするためのパスフレーズを要求するクラス（PrivateKeyPassphraseHandler のサブクラス）。たとえば、<privateKeyPassphraseHandler>, <name>KeyFileHandler</name>, <options><password>test</password></options>, </privateKeyPassphraseHandler> のように指定します。KeyConsoleHandler
invalidCertificateHandler無効な証明書を検証するためのクラス（CertificateHandler のサブクラス）。例：<invalidCertificateHandler><name>RejectCertificateHandler</name></invalidCertificateHandler>。RejectCertificateHandler
disableProtocols使用が禁止されているプロトコル。
preferServerCiphersサーバー側暗号スイート（クライアント優先）。false

設定例:

<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>
        <!-- 自己署名証明書を使用する場合: <verificationMode>none</verificationMode> -->
        <invalidCertificateHandler>
            <!-- 自己署名証明書を使用する場合: <name>AcceptCertificateHandler</name> -->
            <name>RejectCertificateHandler</name>
        </invalidCertificateHandler>
    </client>
</openSSL>

opentelemetry_span_log​

opentelemetry_span_log システムテーブルに関する設定です。

The following settings can be configured by sub-tags:

SettingDescriptionDefaultNote
databaseデータベース名。
tableシステムテーブル名。
engineシステムテーブルに対する MergeTree エンジン定義。partition_by または order_by が定義されている場合は使用できません。指定しない場合はデフォルトで MergeTree が選択されます
partition_byシステムテーブルに対するカスタムパーティショニングキー。システムテーブルに engine を指定する場合、partition_by パラメータは engine の設定内で直接指定する必要があります
ttlテーブルの TTL を指定します。システムテーブルに engine を指定する場合、ttl パラメータは engine の設定内で直接指定する必要があります
order_byシステムテーブルに対するカスタムソートキー。engine が定義されている場合は使用できません。システムテーブルに engine を指定する場合、order_by パラメータは engine の設定内で直接指定する必要があります
storage_policyテーブルに使用するストレージポリシー名（任意）。システムテーブルに engine を指定する場合、storage_policy パラメータは engine の設定内で直接指定する必要があります
settingsMergeTree の動作を制御する追加パラメータ（任意）。システムテーブルに engine を指定する場合、settings パラメータは engine の設定内で直接指定する必要があります
flush_interval_millisecondsメモリ上のバッファからテーブルへデータをフラッシュする間隔。7500
max_size_rowsログの最大行数。未フラッシュのログ数が max_size_rows に達すると、ログがディスクにダンプされます。1048576
reserved_size_rowsログ用に事前確保されるメモリ容量（行数）。8192
buffer_size_rows_flush_threshold行数のしきい値。このしきい値に達すると、バックグラウンドでログをディスクへフラッシュする処理が起動します。max_size_rows / 2
flush_on_crashクラッシュ発生時にログをディスクへダンプするかどうかを設定します。false

例：

<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>

os_cpu_busy_time_threshold​

CPU が有用な処理を行っていると見なすための、OS の CPU ビジー時間（OSCPUVirtualTimeMicroseconds メトリクス）に対する閾値（マイクロ秒単位）です。ビジー時間がこの値未満の場合は、CPU が過負荷状態であるとは見なされません。

os_threads_nice_value_distributed_cache_tcp_handler​

分散キャッシュ TCP ハンドラーのスレッドに対する Linux の nice 値です。値が小さいほど CPU の優先度が高くなります。

CAP_SYS_NICE ケーパビリティが必要です。付与されていない場合は何も行われません (no-op) となります。

取りうる値の範囲: -20 〜 19。

os_threads_nice_value_merge_mutate​

マージおよびミューテーションスレッドに対する Linux の nice 値です。値が低いほど CPU 優先度は高くなります。

CAP_SYS_NICE ケーパビリティが必要です。ない場合は設定は無効になります。

取り得る値: -20 〜 19。

os_threads_nice_value_zookeeper_client_send_receive​

ZooKeeper クライアントの送受信スレッドに対する Linux の nice 値です。値が小さいほど CPU の優先度が高くなります。

CAP_SYS_NICE ケーパビリティが必要です。ない場合は何も行われません。

取りうる値: -20 〜 19。

page_cache_free_memory_ratio​

ユーザー空間のページキャッシュには使わずに空けておくメモリ制限値に対する割合。Linux の min_free_kbytes の設定に相当します。

page_cache_history_window_ms​

解放されたメモリがユーザー空間のページキャッシュで利用可能になるまでの遅延時間。

page_cache_max_size​

ユーザー空間ページキャッシュの最大サイズです。キャッシュを無効にするには 0 を設定します。この値が page_cache_min_size より大きい場合、キャッシュサイズはこの範囲内で継続的に調整され、合計メモリ使用量が上限（max_server_memory_usage[_to_ram_ratio]）を下回るように保ちつつ、利用可能なメモリの大部分を使用するようになります。

page_cache_min_size​

ユーザー空間ページキャッシュの最小サイズ。

page_cache_policy​

ユーザー空間ページキャッシュのポリシー名。

page_cache_shards​

ミューテックス競合を減らすため、ユーザー空間ページキャッシュをこの数の分片にストライプします。実験的な機能であり、性能向上が見込める可能性は低いです。

page_cache_size_ratio​

ユーザースペースページキャッシュ内の保護キューのサイズを、キャッシュ全体のサイズに対する比率で指定します。

part_log​

MergeTree に関連するログイベントを記録します。たとえば、データの追加やマージなどです。ログを使用してマージアルゴリズムをシミュレートし、その特性を比較できます。マージ処理を可視化することもできます。

クエリは、別のファイルではなく system.part_log テーブルに記録されます。このテーブル名は table パラメータで構成できます（後述）。

The following settings can be configured by sub-tags:

SettingDescriptionDefaultNote
databaseデータベース名。
tableシステムテーブル名。
engineシステムテーブルに対する MergeTree エンジン定義。partition_by または order_by が定義されている場合は使用できません。指定しない場合はデフォルトで MergeTree が選択されます
partition_byシステムテーブルに対するカスタムパーティショニングキー。システムテーブルに engine を指定する場合、partition_by パラメータは engine の設定内で直接指定する必要があります
ttlテーブルの TTL を指定します。システムテーブルに engine を指定する場合、ttl パラメータは engine の設定内で直接指定する必要があります
order_byシステムテーブルに対するカスタムソートキー。engine が定義されている場合は使用できません。システムテーブルに engine を指定する場合、order_by パラメータは engine の設定内で直接指定する必要があります
storage_policyテーブルに使用するストレージポリシー名（任意）。システムテーブルに engine を指定する場合、storage_policy パラメータは engine の設定内で直接指定する必要があります
settingsMergeTree の動作を制御する追加パラメータ（任意）。システムテーブルに engine を指定する場合、settings パラメータは engine の設定内で直接指定する必要があります
flush_interval_millisecondsメモリ上のバッファからテーブルへデータをフラッシュする間隔。7500
max_size_rowsログの最大行数。未フラッシュのログ数が max_size_rows に達すると、ログがディスクにダンプされます。1048576
reserved_size_rowsログ用に事前確保されるメモリ容量（行数）。8192
buffer_size_rows_flush_threshold行数のしきい値。このしきい値に達すると、バックグラウンドでログをディスクへフラッシュする処理が起動します。max_size_rows / 2
flush_on_crashクラッシュ発生時にログをディスクへダンプするかどうかを設定します。false

例

<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>

parts_kill_delay_period​

SharedMergeTree のパーツを完全に削除するまでの期間。ClickHouse Cloud でのみ利用できます。

parts_kill_delay_period_random_add​

非常に多数のテーブルがある場合に、サンダリング・ハード (thundering herd) 問題が発生して ZooKeeper が DoS 状態になることを避けるために、kill_delay_period に 0〜x 秒の範囲で一様分布に従う値を加算します。ClickHouse Cloud でのみ利用可能です。

parts_killer_pool_size​

共有された MergeTree の不要なパーツをクリーンアップするためのスレッド数です。ClickHouse Cloud でのみ利用可能です。

path​

データを格納しているディレクトリへのパス。

注記

末尾のスラッシュは必須です。

例

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

postgresql_port​

PostgreSQL プロトコル経由でクライアントと通信するためのポート。

注記
  • 正の整数は待ち受けるポート番号を指定します。
  • 空値は、PostgreSQL プロトコル経由でのクライアントとの通信を無効にするために使用されます。

例

<postgresql_port>9005</postgresql_port>

postgresql_require_secure_transport​

true に設定すると、postgresql_port 経由でクライアントとのセキュアな通信が必須になります。sslmode=disable オプションでの接続は拒否されます。OpenSSL の設定と併用してください。

prefetch_threadpool_pool_size​

リモートオブジェクトストレージ用プリフェッチのバックグラウンドプールのサイズ

prefetch_threadpool_queue_size​

プリフェッチ用プールに投入可能なタスクの最大数

prefixes_deserialization_thread_pool_thread_pool_queue_size​

prefixes deserialization スレッドプールでスケジュール可能なジョブの最大数。

注記

値が 0 の場合は無制限を意味します。

prepare_system_log_tables_on_startup​

true に設定されている場合、ClickHouse は起動前に設定されているすべての system.*_log テーブルを作成します。これらのテーブルに依存する起動スクリプトがある場合に有用です。

primary_index_cache_policy​

プライマリ索引キャッシュポリシーの名前です。

primary_index_cache_prewarm_ratio​

プリウォーム時にマークキャッシュの合計サイズのうち、どの程度を事前に読み込むかを指定する比率です。

primary_index_cache_size​

プライマリ索引（MergeTree ファミリーのテーブルの索引）用キャッシュの最大サイズ。

primary_index_cache_size_ratio​

プライマリ索引キャッシュにおいて、保護キュー（SLRU ポリシーの場合）のサイズがキャッシュ全体サイズに対して占める比率。

process_query_plan_packet​

この設定を有効にすると、QueryPlan パケットを読み込めるようになります。このパケットは、serialize_query_plan が有効な場合に分散クエリ向けに送信されます。 クエリプランのバイナリデシリアライズ処理に存在するバグに起因するセキュリティ上の問題を避けるため、デフォルトでは無効になっています。

例

<process_query_plan_packet>true</process_query_plan_packet>

processors_profile_log​

processors_profile_log システムテーブルの設定です。

The following settings can be configured by sub-tags:

SettingDescriptionDefaultNote
databaseデータベース名。
tableシステムテーブル名。
engineシステムテーブルに対する MergeTree エンジン定義。partition_by または order_by が定義されている場合は使用できません。指定しない場合はデフォルトで MergeTree が選択されます
partition_byシステムテーブルに対するカスタムパーティショニングキー。システムテーブルに engine を指定する場合、partition_by パラメータは engine の設定内で直接指定する必要があります
ttlテーブルの TTL を指定します。システムテーブルに engine を指定する場合、ttl パラメータは engine の設定内で直接指定する必要があります
order_byシステムテーブルに対するカスタムソートキー。engine が定義されている場合は使用できません。システムテーブルに engine を指定する場合、order_by パラメータは engine の設定内で直接指定する必要があります
storage_policyテーブルに使用するストレージポリシー名（任意）。システムテーブルに engine を指定する場合、storage_policy パラメータは engine の設定内で直接指定する必要があります
settingsMergeTree の動作を制御する追加パラメータ（任意）。システムテーブルに engine を指定する場合、settings パラメータは engine の設定内で直接指定する必要があります
flush_interval_millisecondsメモリ上のバッファからテーブルへデータをフラッシュする間隔。7500
max_size_rowsログの最大行数。未フラッシュのログ数が max_size_rows に達すると、ログがディスクにダンプされます。1048576
reserved_size_rowsログ用に事前確保されるメモリ容量（行数）。8192
buffer_size_rows_flush_threshold行数のしきい値。このしきい値に達すると、バックグラウンドでログをディスクへフラッシュする処理が起動します。max_size_rows / 2
flush_on_crashクラッシュ発生時にログをディスクへダンプするかどうかを設定します。false

既定の設定は以下のとおりです。

<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​

Prometheus からスクレイプされるメトリクスデータを公開します。

Settings:

  • endpoint – Prometheus サーバーがメトリクスをスクレイプするための HTTP エンドポイント。先頭は '/' とします。
  • port – endpoint 用のポート。
  • metrics – system.metrics テーブルのメトリクスを公開します。
  • events – system.events テーブルのメトリクスを公開します。
  • asynchronous_metrics – system.asynchronous_metrics テーブルから現在のメトリクス値を公開します。
  • errors - 直近のサーバー再起動以降に発生した、エラーコードごとのエラー発生回数を公開します。この情報は system.errors からも取得できます。

Example

<clickhouse>
    <listen_host>0.0.0.0</listen_host>
    <http_port>8123</http_port>
    <tcp_port>9000</tcp_port>
    <!-- highlight-start -->
    <prometheus>
        <endpoint>/metrics</endpoint>
        <port>9363</port>
        <metrics>true</metrics>
        <events>true</events>
        <asynchronous_metrics>true</asynchronous_metrics>
        <errors>true</errors>
    </prometheus>
    <!-- highlight-end -->
</clickhouse>

次を確認します（127.0.0.1 を ClickHouse サーバーの IP アドレスまたはホスト名に置き換えてください）:

curl 127.0.0.1:9363/metrics

proxy​

HTTP および HTTPS リクエスト用のプロキシサーバーを定義します。現在、S3 ストレージ、S3 テーブル関数、および URL 関数で利用できます。

プロキシサーバーを定義する方法は 3 つあります。

  • 環境変数
  • プロキシリスト
  • リモートプロキシリゾルバー

特定のホストについては、no_proxy を使用してプロキシサーバーをバイパスすることもできます。

環境変数

http_proxy および https_proxy 環境変数を使用すると、特定のプロトコルに対して プロキシサーバーを指定できます。これらがシステムに設定されていれば、そのまま利用できます。

これは、あるプロトコルに対してプロキシサーバーが 1 つだけであり、そのプロキシサーバーが変更されない場合に最も簡単な方法です。

プロキシリスト

この方法では、あるプロトコルに対して 1 つ以上の プロキシサーバーを指定できます。複数のプロキシサーバーが定義されている場合、 ClickHouse は異なるプロキシをラウンドロビン方式で使用し、サーバー間で 負荷を分散します。これは、あるプロトコルに対して複数の プロキシサーバーが存在し、プロキシサーバーのリストが変更されない場合に最も簡単な方法です。

Configuration template

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

下のタブで親フィールドを選択すると、その子フィールドが表示されます:

フィールド説明
<http>1 つ以上の HTTP プロキシのリスト
<https>1 つ以上の HTTPS プロキシのリスト

リモートプロキシリゾルバ

プロキシサーバーが動的に変化することがあります。その場合は、リゾルバのエンドポイントを定義できます。ClickHouse はそのエンドポイントに空の GET リクエストを送信し、リモートリゾルバはプロキシホストを返す必要があります。 ClickHouse はそれを使用して、次のテンプレートに従ってプロキシ URI を生成します: \{proxy_scheme\}://\{proxy_host\}:{proxy_port}

設定テンプレート

<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>

以下のタブで親フィールドを選択すると、その子フィールドが表示されます:

FieldDescription
<http>1つ以上の resolver のリスト*
<https>1つ以上の resolver のリスト*

Precedence

プロキシ設定は次の優先順位で決定されます。

OrderSetting
1.リモートプロキシ resolver
2.プロキシリスト
3.環境変数

ClickHouse は、リクエストプロトコルに対して、最も優先度の高い resolver の種類を確認します。定義されていなければ、 環境 resolver に到達するまで、次に優先度の高い resolver の種類を順に確認します。 これにより、複数種類の resolver を併用することも可能になります。

query_cache​

Query cache の設定。

利用可能な設定は以下のとおりです。

SettingDescriptionDefault Value
max_size_in_bytesキャッシュの最大サイズ（バイト単位）。0 の場合、クエリキャッシュは無効化されます。1073741824
max_entriesキャッシュに保存される SELECT クエリ結果の最大件数。1024
max_entry_size_in_bytesキャッシュに保存できる SELECT クエリ結果の最大サイズ（バイト単位）。1048576
max_entry_size_in_rowsキャッシュに保存できる SELECT クエリ結果の最大行数。30000000
注記
  • 設定の変更は直ちに有効になります。
  • クエリキャッシュ用のデータは DRAM 上に確保されます。メモリが逼迫している場合は、max_size_in_bytes を小さい値に設定するか、クエリキャッシュを無効化するようにしてください。

例

<query_cache>
    <max_size_in_bytes>1073741824</max_size_in_bytes>
    <max_entries>1024</max_entries>
    <max_entry_size_in_bytes>1048576</max_entry_size_in_bytes>
    <max_entry_size_in_rows>30000000</max_entry_size_in_rows>
</query_cache>

query_condition_cache_policy​

クエリ条件キャッシュのポリシー名。

query_condition_cache_size​

クエリ条件キャッシュの最大サイズ。

注記

このSETTINGは実行時に変更でき、その変更は即座に反映されます。

query_condition_cache_size_ratio​

クエリ条件キャッシュにおける保護キューのサイズ（SLRU ポリシーの場合）を、キャッシュ全体のサイズに対する比率で表します。

query_log​

log_queries=1 設定で受信したクエリをログに記録するための設定です。

クエリは別ファイルではなく、system.query_log テーブルに記録されます。table パラメータでテーブル名を変更できます（下記参照）。

The following settings can be configured by sub-tags:

SettingDescriptionDefaultNote
databaseデータベース名。
tableシステムテーブル名。
engineシステムテーブルに対する MergeTree エンジン定義。partition_by または order_by が定義されている場合は使用できません。指定しない場合はデフォルトで MergeTree が選択されます
partition_byシステムテーブルに対するカスタムパーティショニングキー。システムテーブルに engine を指定する場合、partition_by パラメータは engine の設定内で直接指定する必要があります
ttlテーブルの TTL を指定します。システムテーブルに engine を指定する場合、ttl パラメータは engine の設定内で直接指定する必要があります
order_byシステムテーブルに対するカスタムソートキー。engine が定義されている場合は使用できません。システムテーブルに engine を指定する場合、order_by パラメータは engine の設定内で直接指定する必要があります
storage_policyテーブルに使用するストレージポリシー名（任意）。システムテーブルに engine を指定する場合、storage_policy パラメータは engine の設定内で直接指定する必要があります
settingsMergeTree の動作を制御する追加パラメータ（任意）。システムテーブルに engine を指定する場合、settings パラメータは engine の設定内で直接指定する必要があります
flush_interval_millisecondsメモリ上のバッファからテーブルへデータをフラッシュする間隔。7500
max_size_rowsログの最大行数。未フラッシュのログ数が max_size_rows に達すると、ログがディスクにダンプされます。1048576
reserved_size_rowsログ用に事前確保されるメモリ容量（行数）。8192
buffer_size_rows_flush_threshold行数のしきい値。このしきい値に達すると、バックグラウンドでログをディスクへフラッシュする処理が起動します。max_size_rows / 2
flush_on_crashクラッシュ発生時にログをディスクへダンプするかどうかを設定します。false

テーブルが存在しない場合、ClickHouse がテーブルを作成します。ClickHouse サーバーをアップデートした際にクエリログの構造が変更されていた場合は、古い構造のテーブルの名前が変更され、新しいテーブルが自動的に作成されます。

例

<query_log>
    <database>system</database>
    <table>query_log</table>
    <engine>Engine = MergeTree PARTITION BY event_date ORDER BY event_time TTL event_date + INTERVAL 30 day</engine>
    <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>
</query_log>

query_masking_rules​

正規表現に基づくルールで、サーバーログに保存される前にクエリおよびすべてのログメッセージに適用されます。 system.query_log、system.text_log、system.processes テーブル、およびクライアントへ送信されるログが対象です。これにより、SQL クエリ内の名前、メールアドレス、個人識別子、クレジットカード番号などの機密データがログに漏えいするのを防ぐことができます。

例

<query_masking_rules>
    <rule>
        <name>SSNを隠す</name>
        <regexp>(^|\D)\d{3}-\d{2}-\d{4}($|\D)</regexp>
        <replace>000-00-0000</replace>
    </rule>
</query_masking_rules>

設定項目:

SettingDescription
nameルール名（オプション）
regexpRE2 互換の正規表現（必須）
replace機密データを置き換えるための文字列（オプション、デフォルトはアスタリスク 6 個）

マスキングルールはクエリ全体に適用されます（不正な形式の / 解析不能なクエリから機密データが漏えいするのを防ぐため）。

system.events テーブルには QueryMaskingRulesMatch カウンタがあり、クエリマスキングルールにマッチした総件数が記録されます。

分散クエリの場合は、各サーバーを個別に設定する必要があります。そうしないと、他ノードに渡されたサブクエリはマスキングされずに保存されます。

query_metric_log​

デフォルトでは無効になっています。

有効化

メトリクス履歴の収集 system.query_metric_log を手動で有効にするには、次の内容で /etc/clickhouse-server/config.d/query_metric_log.xml を作成します：

<clickhouse>
    <query_metric_log>
        <database>system</database>
        <table>query_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>
    </query_metric_log>
</clickhouse>

無効化

query_metric_log 設定を無効にするには、次の内容でファイル /etc/clickhouse-server/config.d/disable_query_metric_log.xml を作成します。

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

The following settings can be configured by sub-tags:

SettingDescriptionDefaultNote
databaseデータベース名。
tableシステムテーブル名。
engineシステムテーブルに対する MergeTree エンジン定義。partition_by または order_by が定義されている場合は使用できません。指定しない場合はデフォルトで MergeTree が選択されます
partition_byシステムテーブルに対するカスタムパーティショニングキー。システムテーブルに engine を指定する場合、partition_by パラメータは engine の設定内で直接指定する必要があります
ttlテーブルの TTL を指定します。システムテーブルに engine を指定する場合、ttl パラメータは engine の設定内で直接指定する必要があります
order_byシステムテーブルに対するカスタムソートキー。engine が定義されている場合は使用できません。システムテーブルに engine を指定する場合、order_by パラメータは engine の設定内で直接指定する必要があります
storage_policyテーブルに使用するストレージポリシー名（任意）。システムテーブルに engine を指定する場合、storage_policy パラメータは engine の設定内で直接指定する必要があります
settingsMergeTree の動作を制御する追加パラメータ（任意）。システムテーブルに engine を指定する場合、settings パラメータは engine の設定内で直接指定する必要があります
flush_interval_millisecondsメモリ上のバッファからテーブルへデータをフラッシュする間隔。7500
max_size_rowsログの最大行数。未フラッシュのログ数が max_size_rows に達すると、ログがディスクにダンプされます。1048576
reserved_size_rowsログ用に事前確保されるメモリ容量（行数）。8192
buffer_size_rows_flush_threshold行数のしきい値。このしきい値に達すると、バックグラウンドでログをディスクへフラッシュする処理が起動します。max_size_rows / 2
flush_on_crashクラッシュ発生時にログをディスクへダンプするかどうかを設定します。false

query_thread_log​

log_query_threads=1 設定を有効にした場合に、受信したクエリのスレッドをログに記録するための設定です。

クエリは、個別のファイルではなく system.query_thread_log テーブルに記録されます。テーブル名は table パラメータで変更できます（下記参照）。

The following settings can be configured by sub-tags:

SettingDescriptionDefaultNote
databaseデータベース名。
tableシステムテーブル名。
engineシステムテーブルに対する MergeTree エンジン定義。partition_by または order_by が定義されている場合は使用できません。指定しない場合はデフォルトで MergeTree が選択されます
partition_byシステムテーブルに対するカスタムパーティショニングキー。システムテーブルに engine を指定する場合、partition_by パラメータは engine の設定内で直接指定する必要があります
ttlテーブルの TTL を指定します。システムテーブルに engine を指定する場合、ttl パラメータは engine の設定内で直接指定する必要があります
order_byシステムテーブルに対するカスタムソートキー。engine が定義されている場合は使用できません。システムテーブルに engine を指定する場合、order_by パラメータは engine の設定内で直接指定する必要があります
storage_policyテーブルに使用するストレージポリシー名（任意）。システムテーブルに engine を指定する場合、storage_policy パラメータは engine の設定内で直接指定する必要があります
settingsMergeTree の動作を制御する追加パラメータ（任意）。システムテーブルに engine を指定する場合、settings パラメータは engine の設定内で直接指定する必要があります
flush_interval_millisecondsメモリ上のバッファからテーブルへデータをフラッシュする間隔。7500
max_size_rowsログの最大行数。未フラッシュのログ数が max_size_rows に達すると、ログがディスクにダンプされます。1048576
reserved_size_rowsログ用に事前確保されるメモリ容量（行数）。8192
buffer_size_rows_flush_threshold行数のしきい値。このしきい値に達すると、バックグラウンドでログをディスクへフラッシュする処理が起動します。max_size_rows / 2
flush_on_crashクラッシュ発生時にログをディスクへダンプするかどうかを設定します。false

テーブルが存在しない場合、ClickHouse はテーブルを作成します。ClickHouse サーバーのアップグレード時にクエリスレッドログの構造が変更された場合は、古い構造のテーブルの名前が変更され、新しいテーブルが自動的に作成されます。

例

<query_thread_log>
    <database>system</database>
    <table>query_thread_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>
</query_thread_log>

query_views_log​

log_query_views=1 設定により受信したクエリに応じて、ビュー（ライブビュー、マテリアライズドビューなど）をログに記録するための設定です。

クエリは、別ファイルではなく system.query_views_log テーブルに記録されます。table パラメータ（後述）でテーブル名を変更できます。

The following settings can be configured by sub-tags:

SettingDescriptionDefaultNote
databaseデータベース名。
tableシステムテーブル名。
engineシステムテーブルに対する MergeTree エンジン定義。partition_by または order_by が定義されている場合は使用できません。指定しない場合はデフォルトで MergeTree が選択されます
partition_byシステムテーブルに対するカスタムパーティショニングキー。システムテーブルに engine を指定する場合、partition_by パラメータは engine の設定内で直接指定する必要があります
ttlテーブルの TTL を指定します。システムテーブルに engine を指定する場合、ttl パラメータは engine の設定内で直接指定する必要があります
order_byシステムテーブルに対するカスタムソートキー。engine が定義されている場合は使用できません。システムテーブルに engine を指定する場合、order_by パラメータは engine の設定内で直接指定する必要があります
storage_policyテーブルに使用するストレージポリシー名（任意）。システムテーブルに engine を指定する場合、storage_policy パラメータは engine の設定内で直接指定する必要があります
settingsMergeTree の動作を制御する追加パラメータ（任意）。システムテーブルに engine を指定する場合、settings パラメータは engine の設定内で直接指定する必要があります
flush_interval_millisecondsメモリ上のバッファからテーブルへデータをフラッシュする間隔。7500
max_size_rowsログの最大行数。未フラッシュのログ数が max_size_rows に達すると、ログがディスクにダンプされます。1048576
reserved_size_rowsログ用に事前確保されるメモリ容量（行数）。8192
buffer_size_rows_flush_threshold行数のしきい値。このしきい値に達すると、バックグラウンドでログをディスクへフラッシュする処理が起動します。max_size_rows / 2
flush_on_crashクラッシュ発生時にログをディスクへダンプするかどうかを設定します。false

テーブルが存在しない場合、ClickHouse が作成します。ClickHouse サーバーのアップデート時に query views ログの構造が変更された場合は、古い構造のテーブルの名前が変更され、新しいテーブルが自動的に作成されます。

例

<query_views_log>
    <database>system</database>
    <table>query_views_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>
</query_views_log>

remap_executable​

マシンコード（「text」）用メモリをヒュージページを用いて再割り当てするための設定です。

注記

この機能は非常に実験的なものです。

例:

<remap_executable>false</remap_executable>

remote_servers​

Distributed テーブルエンジンおよび cluster テーブル関数で使用されるクラスタの設定。

例

<remote_servers incl="clickhouse_remote_servers" />

incl 属性の設定値については、「Configuration files」セクションを参照してください。

関連項目

remote_url_allow_hosts​

URL 関連のストレージエンジンおよびテーブル関数で使用を許可するホストの一覧を指定します。

\<host\> XML タグでホストを追加する場合:

  • 名前解決 (DNS 解決) の前に名前がチェックされるため、URL 内に記載されているものと完全に同一に指定する必要があります。例: <host>clickhouse.com</host>
  • URL 内でポートが明示的に指定されている場合は、host:port 全体が一体としてチェックされます。例: <host>clickhouse.com:80</host>
  • ホストをポートなしで指定した場合、そのホストの任意のポートが許可されます。例: <host>clickhouse.com</host> が指定されている場合、clickhouse.com:20 (FTP)、clickhouse.com:80 (HTTP)、clickhouse.com:443 (HTTPS) などが許可されます。
  • ホストを IP アドレスとして指定した場合は、URL に記載されているとおりの形でチェックされます。例: [2a02:6b8:a::a]。
  • リダイレクトが存在し、リダイレクトのサポートが有効になっている場合は、すべてのリダイレクト (location フィールド) がチェックされます。

例:

<remote_url_allow_hosts>
    <host>clickhouse.com</host>
</remote_url_allow_hosts>

replica_group_name​

Replicated データベース用のレプリカグループ名。

Replicated データベースによって作成されるクラスターは、同じグループ内のレプリカで構成されます。 DDL クエリは同じグループ内のレプリカのみを待機します。

デフォルトは空です。

例

<replica_group_name>バックアップ</replica_group_name>

replicated_fetches_http_connection_timeout​

パーツのフェッチ要求に対する HTTP 接続のタイムアウトです。明示的に設定されていない場合は、デフォルトプロファイルの http_connection_timeout を継承します。

replicated_fetches_http_receive_timeout​

フェッチパーツリクエストに対する HTTP 受信タイムアウト。明示的に設定しない場合は、デフォルトプロファイルの http_receive_timeout の値を継承します。

replicated_fetches_http_send_timeout​

パーツ取得リクエストに対する HTTP 送信タイムアウト。明示的に設定されていない場合は、デフォルトプロファイル http_send_timeout の値が継承されます。

replicated_merge_tree​

ReplicatedMergeTree テーブル向けの微調整用設定です。この設定が優先されます。

詳細については、ヘッダーファイル MergeTreeSettings.h を参照してください。

例

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

restore_threads​

RESTORE リクエストの実行に使用されるスレッドの最大数。

s3_credentials_provider_max_cache_size​

キャッシュできる S3 資格情報プロバイダの最大数

s3_max_redirects​

S3 リダイレクトに対して許可されるホップ数の最大値。

s3_retry_attempts​

Aws::Client::RetryStrategy 用の設定です。Aws::Client 自体がリトライを行い、0 はリトライしないことを意味します。

s3queue_disable_streaming​

テーブルが作成済みでマテリアライズドビューがアタッチされている場合でも、S3Queue のストリーミングを無効化します

s3queue_log​

s3queue_log システムテーブルに関する設定です。

The following settings can be configured by sub-tags:

SettingDescriptionDefaultNote
databaseデータベース名。
tableシステムテーブル名。
engineシステムテーブルに対する MergeTree エンジン定義。partition_by または order_by が定義されている場合は使用できません。指定しない場合はデフォルトで MergeTree が選択されます
partition_byシステムテーブルに対するカスタムパーティショニングキー。システムテーブルに engine を指定する場合、partition_by パラメータは engine の設定内で直接指定する必要があります
ttlテーブルの TTL を指定します。システムテーブルに engine を指定する場合、ttl パラメータは engine の設定内で直接指定する必要があります
order_byシステムテーブルに対するカスタムソートキー。engine が定義されている場合は使用できません。システムテーブルに engine を指定する場合、order_by パラメータは engine の設定内で直接指定する必要があります
storage_policyテーブルに使用するストレージポリシー名（任意）。システムテーブルに engine を指定する場合、storage_policy パラメータは engine の設定内で直接指定する必要があります
settingsMergeTree の動作を制御する追加パラメータ（任意）。システムテーブルに engine を指定する場合、settings パラメータは engine の設定内で直接指定する必要があります
flush_interval_millisecondsメモリ上のバッファからテーブルへデータをフラッシュする間隔。7500
max_size_rowsログの最大行数。未フラッシュのログ数が max_size_rows に達すると、ログがディスクにダンプされます。1048576
reserved_size_rowsログ用に事前確保されるメモリ容量（行数）。8192
buffer_size_rows_flush_threshold行数のしきい値。このしきい値に達すると、バックグラウンドでログをディスクへフラッシュする処理が起動します。max_size_rows / 2
flush_on_crashクラッシュ発生時にログをディスクへダンプするかどうかを設定します。false

既定の設定は次のとおりです。

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

send_crash_reports​

ClickHouse コア開発チームにクラッシュレポートを送信するための設定です。

特に本番導入前の環境では、有効化しておくことを強く推奨します。

Keys:

KeyDescription
enabled機能を有効にするかどうかを制御するブール型フラグです。デフォルトは true です。クラッシュレポートを送信したくない場合は false に設定します。
send_logical_errorsLOGICAL_ERROR は assert のようなもので、ClickHouse のバグを示します。このブール型フラグは、これらの例外を送信するかどうかを制御します（デフォルト: true）。
endpointクラッシュレポートの送信先エンドポイント URL を上書きできます。

推奨される使い方

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

series_keeper_path​

generateSerialID 関数によって生成される、自動インクリメント番号付きの Keeper 内のパスです。各シリーズはこのパス配下のノードになります。

show_addresses_in_stack_traces​

true に設定すると、スタックトレースにアドレスを表示します

shutdown_wait_backups_and_restores​

true に設定すると、ClickHouse はシャットダウン前に、実行中のバックアップおよびリストアが完了するまで待機します。

shutdown_wait_unfinished​

未完了のクエリが終了するまで待機する秒数

shutdown_wait_unfinished_queries​

true に設定すると、ClickHouse はシャットダウン前に実行中のクエリが完了するまで待機します。

skip_binary_checksum_checks​

ClickHouse バイナリに対するチェックサム整合性検証をスキップします

ssh_server​

ホストキーの公開鍵部分は、最初の接続時に SSH クライアント側の known_hosts ファイルに書き込まれます。

Host Key Configurations はデフォルトでは無効になっています。 ホストキー設定のコメントアウトを外し、対応する ssh キーへのパスを指定して有効化してください：

例：

<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>

startup_mv_delay_ms​

マテリアライズドビュー作成の遅延をシミュレートするためのデバッグ用パラメータ。

storage_configuration​

ストレージの複数ディスク構成を行えるようにします。

ストレージ構成は次の構造になります：

<storage_configuration>
    <disks>
        <!-- 設定 -->
    </disks>
    <policies>
        <!-- 設定 -->
    </policies>
</storage_configuration>

ディスクの設定​

disks の設定は、以下の構造に従います。

<storage_configuration>
    <disks>
        <disk_name_1>
            <path>/mnt/fast_ssd/clickhouse/</path>
        </disk_name_1>
        <disk_name_2>
            <path>/mnt/hdd1/clickhouse/</path>
            <keep_free_space_bytes>10485760</keep_free_space_bytes>
        </disk_name_2>
        <disk_name_3>
            <path>/mnt/hdd2/clickhouse/</path>
            <keep_free_space_bytes>10485760</keep_free_space_bytes>
        </disk_name_3>
        ...
    </disks>
</storage_configuration>

上記のサブタグでは、disks に対して次の設定を定義します。

SettingDescription
<disk_name_N>一意である必要があるディスクの名前。
pathサーバーデータ（data および shadow カタログ）が保存されるパス。末尾は / である必要があります。
keep_free_space_bytesディスク上で予約しておく空き領域のサイズ。
注記

ディスクの順序は問いません。

ポリシーの設定​

上記のサブタグは、policies に対して次の設定を定義します。

SettingDescription
policy_name_Nポリシー名。ポリシー名は一意である必要があります。
volume_name_Nボリューム名。ボリューム名は一意である必要があります。
diskボリューム内にあるディスク。
max_data_part_size_bytesこのボリューム内の任意のディスク上に存在できるデータ chunk の最大サイズ。マージの結果として予測される chunk サイズが max_data_part_size_bytes を超える場合、その chunk は次のボリュームに書き込まれます。基本的に、この機能により、新規 / 小さい chunk をホット (SSD) ボリュームに保存し、大きなサイズに達したときにコールド (HDD) ボリュームへ移動できます。ポリシーにボリュームが 1 つしかない場合、このオプションは使用しないでください。
move_factorボリューム上の利用可能な空き容量の割合。空き容量がこの割合を下回ると、（存在する場合は）次のボリュームへデータの移動が開始されます。移動の際、chunk はサイズの大きいものから小さいものへ（降順で）ソートされ、合計サイズが move_factor の条件を満たす chunk が選択されます。すべての chunk を合わせても条件を満たせない場合は、すべての chunk が移動されます。
perform_ttl_move_on_insert挿入時の有効期限 (TTL) 切れデータの移動を無効にします。デフォルト（有効な場合）では、すでに TTL に基づく移動ルールに従って有効期限切れとなっているデータを挿入すると、即座にその移動ルールで指定されたボリューム / ディスクに移動されます。ターゲットのボリューム / ディスクが遅い場合（例: S3）、これは挿入処理を大きく低速化する可能性があります。無効にした場合、有効期限切れのデータ部分はいったんデフォルトのボリュームに書き込まれ、その後すぐに有効期限 (TTL) 用ルールで指定されたボリュームに移動されます。
load_balancingディスクのバランシングポリシー。round_robin または least_used。
least_used_ttl_msすべてのディスク上の利用可能な空き容量を更新するためのタイムアウト（ミリ秒）を設定します（0 - 常に更新、-1 - 一切更新しない、デフォルト値は 60000）。ディスクが ClickHouse のみで使用され、ファイルシステムのオンラインリサイズの対象とならない場合は、-1 を使用できます。その他のケースでは、最終的に誤った容量割り当てにつながるため、推奨されません。
prefer_not_to_mergeこのボリューム上のデータパーツのマージを無効にします。注意: これは潜在的に有害で、パフォーマンス低下を引き起こす可能性があります。この設定を有効にすると（推奨しません）、このボリューム上でのデータマージは禁止されます（これは好ましくありません）。これにより、ClickHouse が低速ディスクとどのようにやり取りするかを制御できますが、基本的には使用しないことを推奨します。
volume_priorityボリュームが埋められる優先度（順序）を定義します。値が小さいほど優先度が高くなります。パラメータ値は自然数であり、1 から N（N は指定されたパラメータ値の最大値）までの範囲を欠番なくカバーしている必要があります。

volume_priority について:

  • すべてのボリュームにこのパラメータが設定されている場合、指定された順序で優先されます。
  • 一部の ボリュームのみに設定されている場合、設定されていないボリュームは最も低い優先度になります。設定されているボリュームはタグ値に従って優先され、それ以外のボリュームは設定ファイル内での記述順によって相互の優先度が決まります。
  • どの ボリュームにもこのパラメータが設定されていない場合、設定ファイル内での記述順によって順序が決まります。
  • ボリュームの優先度は、同一である必要はありません。

storage_connections_hard_limit​

この制限に達した状態で新規作成を行おうとすると、例外がスローされます。ハードリミットを無効にするには 0 に設定します。この制限はストレージの接続に適用されます。

storage_connections_soft_limit​

この上限を超えた接続の有効期間 (TTL) は大幅に短くなります。この上限はストレージへの接続に適用されます。

storage_connections_store_limit​

この上限を超えた接続は、使用後にリセットされます。接続キャッシュを無効にするには 0 を設定します。この上限はストレージの接続に適用されます。

storage_connections_warn_limit​

使用中の接続数がこの上限を超えた場合、警告メッセージがログに書き込まれます。この上限はストレージへの接続に適用されます。

storage_metadata_write_full_object_key​

VERSION_FULL_OBJECT_KEY 形式でディスクのメタデータファイルを書き込みます。デフォルトで有効です。この設定は非推奨となっています。

storage_shared_set_join_use_inner_uuid​

有効にすると、SharedSet と SharedJoin の作成時に内部 UUID が生成されます。ClickHouse Cloud でのみ利用可能です。

table_engines_require_grant​

true に設定すると、特定のエンジンを使用してテーブルを作成するには、ユーザーに対する GRANT が必要になります（例: GRANT TABLE ENGINE ON TinyLog to user）。

注記

デフォルトでは、後方互換性のため、特定のテーブルエンジンを使用してテーブルを作成する際の GRANT はチェックされませんが、これを true に設定することで、この動作を変更できます。

tables_loader_background_pool_size​

バックグラウンドプールで非同期ロードジョブを実行するスレッド数を設定します。バックグラウンドプールは、そのテーブルを待っているクエリが存在しない場合に、サーバー起動後にテーブルを非同期でロードするために使用されます。テーブル数が多い場合は、バックグラウンドプール内のスレッド数を少なく保つことが有用な場合があります。これにより、同時クエリ実行のための CPU リソースを確保できます。

注記

0 を指定すると、利用可能なすべての CPU が使用されます。

tables_loader_foreground_pool_size​

フォアグラウンドプールでロードジョブを実行するスレッド数を設定します。フォアグラウンドプールは、サーバーがポートでの待ち受けを開始する前にテーブルを同期的にロードする場合や、ロード完了を待機しているテーブルをロードする場合に使用されます。フォアグラウンドプールはバックグラウンドプールより高い優先度を持ちます。つまり、フォアグラウンドプールでジョブが実行されている間は、バックグラウンドプールで新たなジョブは開始されません。

注記

値 0 の場合は、利用可能なすべての CPU が使用されます。

tcp_close_connection_after_queries_num​

TCP 接続ごとに、接続を閉じるまでに実行を許可されるクエリの最大数です。無制限にするには 0 を設定します。

tcp_close_connection_after_queries_seconds​

TCP 接続が閉じられるまでの最大存続時間（秒）。接続の存続時間を無制限にするには 0 に設定します。

tcp_port​

TCPプロトコル経由でクライアントとの通信に使用するポートです。

例

<tcp_port>9000</tcp_port>

tcp_port_secure​

クライアントとのセキュアな通信に使用される TCP ポートです。OpenSSL の設定と併せて使用します。

デフォルト値

<tcp_port_secure>9440</tcp_port_secure>

tcp_ssh_port​

SSH サーバー用のポートです。ユーザーは、このポートを利用して接続し、PTY 上の組み込みクライアントを使って対話的にクエリを実行できます。

例:

<tcp_ssh_port>9022</tcp_ssh_port>

temporary_data_in_cache​

このオプションを使用すると、一時データは特定のディスクに対応するキャッシュ内に保存されます。 このセクションでは、タイプが cache のディスク名を指定する必要があります。 その場合、キャッシュと一時データは同じ領域を共有し、一時データを作成するためにディスクキャッシュが追い出されることがあります。

注記

一時データの保存を構成する際に使用できるオプションは、tmp_path、tmp_policy、temporary_data_in_cache のいずれか 1 つだけです。

例

local_disk 用のキャッシュと一時データの両方が、ファイルシステム上の /tiny_local_cache に保存され、tiny_local_cache によって管理されます。

<clickhouse>
<storage_configuration>
<disks>
<local_disk>
<type>local</type>
<path>/local_disk/</path>
</local_disk>

<!-- highlight-start -->
<tiny_local_cache>
<type>cache</type>
<disk>local_disk</disk>
<path>/tiny_local_cache/</path>
<max_size_rows>10M</max_size_rows>
<max_file_segment_size>1M</max_file_segment_size>
<cache_on_write_operations>1</cache_on_write_operations>
</tiny_local_cache>
<!-- highlight-end -->
</disks>
</storage_configuration>

<!-- highlight-start -->
<temporary_data_in_cache>tiny_local_cache</temporary_data_in_cache>
<!-- highlight-end -->
</clickhouse>

temporary_data_in_distributed_cache​

一時データを分散キャッシュに保存するかどうかを制御します。

text_index_dictionary_block_cache_max_entries​

テキスト索引用Dictionaryブロックのキャッシュサイズ（エントリ数）。0 を指定すると無効になります。

テキスト索引 Dictionary ブロックキャッシュポリシー​

テキスト索引 Dictionary のブロックキャッシュポリシー名。

text_index_dictionary_block_cache_size​

テキスト索引用のDictionaryブロックキャッシュのサイズです。0 に設定すると無効になります。

注記

この設定は実行時に変更でき、即座に有効になります。

text_index_dictionary_block_cache_size_ratio​

テキスト索引 Dictionary のブロックキャッシュにおける、保護キュー（SLRU ポリシーの場合）のサイズを、キャッシュ全体サイズに対する比率で指定します。

text_index_header_cache_max_entries​

テキスト索引ヘッダー用キャッシュのサイズ（エントリ数）。0 の場合はキャッシュは無効になります。

text_index_header_cache_policy​

テキスト索引ヘッダーのキャッシュポリシー名。

text_index_header_cache_size​

テキストインデックスヘッダー用キャッシュのサイズ。0 の場合は無効になります。

注記

この設定は実行時に変更可能で、即座に反映されます。

text_index_header_cache_size_ratio​

テキストインデックスヘッダーキャッシュにおいて、SLRU ポリシー使用時の保護キューのサイズを、キャッシュ全体サイズに対する比率で指定します。

text_index_postings_cache_max_entries​

テキストインデックスのポスティングリスト用キャッシュのサイズ（エントリ数）。0 の場合は無効です。

text_index_postings_cache_policy​

テキスト索引のポスティングリストキャッシュポリシーの名前です。

text_index_postings_cache_size​

テキストインデックスのポスティングリスト用キャッシュのサイズです。0 の場合は無効になります。

注記

この設定は実行時に変更でき、直ちに反映されます。

text_index_postings_cache_size_ratio​

テキストインデックスのポスティングリストキャッシュにおいて、SLRU ポリシーを使用する場合の保護キューのサイズを、キャッシュ全体のサイズに対する比率で指定します。

text_log​

テキストメッセージをログに記録するための text_log システムテーブルの設定です。

The following settings can be configured by sub-tags:

SettingDescriptionDefaultNote
databaseデータベース名。
tableシステムテーブル名。
engineシステムテーブルに対する MergeTree エンジン定義。partition_by または order_by が定義されている場合は使用できません。指定しない場合はデフォルトで MergeTree が選択されます
partition_byシステムテーブルに対するカスタムパーティショニングキー。システムテーブルに engine を指定する場合、partition_by パラメータは engine の設定内で直接指定する必要があります
ttlテーブルの TTL を指定します。システムテーブルに engine を指定する場合、ttl パラメータは engine の設定内で直接指定する必要があります
order_byシステムテーブルに対するカスタムソートキー。engine が定義されている場合は使用できません。システムテーブルに engine を指定する場合、order_by パラメータは engine の設定内で直接指定する必要があります
storage_policyテーブルに使用するストレージポリシー名（任意）。システムテーブルに engine を指定する場合、storage_policy パラメータは engine の設定内で直接指定する必要があります
settingsMergeTree の動作を制御する追加パラメータ（任意）。システムテーブルに engine を指定する場合、settings パラメータは engine の設定内で直接指定する必要があります
flush_interval_millisecondsメモリ上のバッファからテーブルへデータをフラッシュする間隔。7500
max_size_rowsログの最大行数。未フラッシュのログ数が max_size_rows に達すると、ログがディスクにダンプされます。1048576
reserved_size_rowsログ用に事前確保されるメモリ容量（行数）。8192
buffer_size_rows_flush_threshold行数のしきい値。このしきい値に達すると、バックグラウンドでログをディスクへフラッシュする処理が起動します。max_size_rows / 2
flush_on_crashクラッシュ発生時にログをディスクへダンプするかどうかを設定します。false

加えて、次の設定があります：

設定項目説明デフォルト値
levelテーブルに保存されるメッセージの最大レベル（デフォルトは Trace）を指定します。Trace

例

<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​

グローバルスレッドプールにスケジュールできるジョブの最大数です。キューサイズを増やすとメモリ使用量が増加します。この値は max_thread_pool_size と同じにすることを推奨します。

注記

0 を指定すると無制限になります。

例

<thread_pool_queue_size>12000</thread_pool_queue_size>

threadpool_local_fs_reader_pool_size​

local_filesystem_read_method = 'pread_threadpool' の場合に、ローカルファイルシステムからの読み取りに使用するスレッドプールのスレッド数。

threadpool_local_fs_reader_queue_size​

ローカルファイルシステムからの読み取りを行うスレッドプールに対してスケジュール可能なジョブの最大数。

threadpool_remote_fs_reader_pool_size​

remote_filesystem_read_method = 'threadpool' の場合に、リモートファイルシステムからの読み取りに使用されるスレッドプールのスレッド数。

threadpool_remote_fs_reader_queue_size​

リモートファイルシステムの読み取りを行うためにスレッドプール上でスケジュール可能なジョブの最大数。

threadpool_writer_pool_size​

オブジェクトストレージへの書き込みリクエストを処理するバックグラウンドプールのサイズ

threadpool_writer_queue_size​

オブジェクトストレージへの書き込みリクエスト用にバックグラウンドプールへ投入できるタスクの最大数

throw_on_unknown_workload​

クエリ SETTING workload で参照される不明な WORKLOAD へのアクセス時の挙動を定義します。

  • true の場合、不明な WORKLOAD へアクセスしようとしたクエリから RESOURCE_ACCESS_DENIED 例外がスローされます。WORKLOAD の階層が確立され、WORKLOAD default を含むようになった後に、すべてのクエリに対してリソーススケジューリングを強制するのに有用です。
  • false（デフォルト）の場合、不明な WORKLOAD を指す workload SETTING を持つクエリには、リソーススケジューリングなしで無制限のアクセスが許可されます。これは、WORKLOAD 階層を構成している段階で、WORKLOAD default が追加される前に重要です。

Example

<throw_on_unknown_workload>true</throw_on_unknown_workload>

関連項目

timezone​

サーバーのタイムゾーン。

UTC または地理的な場所を表す IANA タイムゾーン識別子として指定します（例: Africa/Abidjan）。

タイムゾーンは、DateTime 型フィールドをテキスト形式（画面表示やファイル出力）に変換する際や、文字列から DateTime を取得する際に、String と DateTime の形式を相互変換するために必要です。また、入力パラメータとしてタイムゾーンを受け取らない日付や時刻を扱う関数でも、タイムゾーンが使用されます。

例

<timezone>Asia/Istanbul</timezone>

関連項目

tmp_path​

大規模なクエリを処理するための一時データを保存する、ローカルファイルシステム上のパス。

注記
  • 一時データの保存方法を構成するために指定できるオプションは、tmp_path、tmp_policy、temporary_data_in_cache のいずれか 1 つのみです。
  • パスの末尾のスラッシュは必須です。

例

<tmp_path>/var/lib/clickhouse/tmp/</tmp_path>

tmp_policy​

一時データ用ストレージのポリシーです。tmp プレフィックスを持つすべてのファイルは起動時に削除されます。

注記

tmp_policy としてオブジェクトストレージを使用する際の推奨事項:

  • 各サーバーごとに別々の bucket:path を使用する
  • metadata_type=plain を使用する
  • このバケットに対して有効期限 (TTL) を設定することも検討してください
注記
  • 一時データストレージを構成するために使用できるオプションは tmp_path、tmp_policy、temporary_data_in_cache のいずれか 1 つだけです。
  • move_factor、keep_free_space_bytes、max_data_part_size_bytes は無視されます。
  • ポリシーはボリュームを ちょうど 1 つだけ 持つ必要があります。

詳細については MergeTree テーブルエンジン のドキュメントを参照してください。

例

/disk1 が満杯になった場合、一時データは /disk2 に保存されます。

<clickhouse>
<storage_configuration>
<disks>
<disk1>
<path>/disk1/</path>
</disk1>
<disk2>
<path>/disk2/</path>
</disk2>
</disks>

<policies>
<!-- highlight-start -->
<tmp_two_disks>
<volumes>
<main>
<disk>disk1</disk>
<disk>disk2</disk>
</main>
</volumes>
</tmp_two_disks>
<!-- highlight-end -->
</policies>
</storage_configuration>

<!-- highlight-start -->
<tmp_policy>tmp_two_disks</tmp_policy>
<!-- highlight-end -->
</clickhouse>

top_level_domains_list​

追加するカスタムトップレベルドメインのリストを定義します。各エントリは <name>/path/to/file</name> という形式です。

例えば:

<top_level_domains_lists>
    <public_suffix_list>/path/to/public_suffix_list.dat</public_suffix_list>
</top_level_domains_lists>

こちらも参照してください:

  • 関数 cutToFirstSignificantSubdomainCustom およびそのバリエーション。 これらはカスタム TLD リスト名を引数に取り、トップレベルドメインから最初の有意なサブドメインまでを含むドメイン部分を返します。

total_memory_profiler_sample_max_allocation_size​

total_memory_profiler_sample_probability に等しい確率で、サイズが指定値以下のメモリアロケーションをランダムに収集します。0 は無効を意味します。このしきい値が期待どおりに機能するようにするには、max_untracked_memory を 0 に設定することを検討してください。

total_memory_profiler_sample_min_allocation_size​

total_memory_profiler_sample_probability と同じ確率で、指定した値以上のサイズのランダムなメモリアロケーションを収集します。0 は無効を意味します。このしきい値を想定どおりに機能させるには、max_untracked_memory を 0 に設定することを推奨します。

total_memory_profiler_step​

サーバーのメモリ使用量が、指定したステップごとのバイト数しきい値を超えるたびに、メモリプロファイラは割り当て元のスタックトレースを収集します。0 はメモリプロファイラが無効であることを意味します。数メガバイト未満の値を指定すると、サーバーの動作が遅くなります。

total_memory_tracker_sample_probability​

ランダムなメモリアロケーションおよび解放を収集し、指定した確率で trace_type が MemorySample のレコードとして system.trace_log システムテーブルに書き込みます。この確率は、アロケーションまたは解放 1 回ごとに適用され、アロケーションサイズには依存しません。サンプリングは、未追跡メモリ量が未追跡メモリの上限（デフォルト値は 4 MiB）を超えた場合にのみ行われることに注意してください。total_memory_profiler_step を小さくすると、この上限も小さくできます。より細かい粒度でサンプリングするには、total_memory_profiler_step を 1 に設定できます。

可能な値:

  • 正の倍精度浮動小数点数。
  • 0 — ランダムなアロケーションおよび解放を system.trace_log システムテーブルに書き込む処理を無効にします。

trace_log​

trace_log システムテーブルの動作に関する設定です。

The following settings can be configured by sub-tags:

SettingDescriptionDefaultNote
databaseデータベース名。
tableシステムテーブル名。
engineシステムテーブルに対する MergeTree エンジン定義。partition_by または order_by が定義されている場合は使用できません。指定しない場合はデフォルトで MergeTree が選択されます
partition_byシステムテーブルに対するカスタムパーティショニングキー。システムテーブルに engine を指定する場合、partition_by パラメータは engine の設定内で直接指定する必要があります
ttlテーブルの TTL を指定します。システムテーブルに engine を指定する場合、ttl パラメータは engine の設定内で直接指定する必要があります
order_byシステムテーブルに対するカスタムソートキー。engine が定義されている場合は使用できません。システムテーブルに engine を指定する場合、order_by パラメータは engine の設定内で直接指定する必要があります
storage_policyテーブルに使用するストレージポリシー名（任意）。システムテーブルに engine を指定する場合、storage_policy パラメータは engine の設定内で直接指定する必要があります
settingsMergeTree の動作を制御する追加パラメータ（任意）。システムテーブルに engine を指定する場合、settings パラメータは engine の設定内で直接指定する必要があります
flush_interval_millisecondsメモリ上のバッファからテーブルへデータをフラッシュする間隔。7500
max_size_rowsログの最大行数。未フラッシュのログ数が max_size_rows に達すると、ログがディスクにダンプされます。1048576
reserved_size_rowsログ用に事前確保されるメモリ容量（行数）。8192
buffer_size_rows_flush_threshold行数のしきい値。このしきい値に達すると、バックグラウンドでログをディスクへフラッシュする処理が起動します。max_size_rows / 2
flush_on_crashクラッシュ発生時にログをディスクへダンプするかどうかを設定します。false

デフォルトのサーバー設定ファイル config.xml には、次の設定セクションが含まれています。

<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>

uncompressed_cache_policy​

非圧縮キャッシュポリシーの名前。

uncompressed_cache_size​

MergeTree ファミリーのテーブルエンジンで使用される非圧縮データの最大サイズ（バイト単位）。

サーバー全体で 1 つの共有キャッシュがあります。メモリは要求に応じて割り当てられます。オプション use_uncompressed_cache が有効な場合にキャッシュが使用されます。

非圧縮キャッシュは、特にごく短時間で完了するクエリに有効です。

注記

値が 0 の場合は無効であることを意味します。

この設定は実行時に変更でき、即座に反映されます。

uncompressed_cache_size_ratio​

非圧縮キャッシュにおける保護キューのサイズを、キャッシュ全体のサイズに対する比率で指定します（SLRU ポリシーの場合）。

url_scheme_mappers​

短縮またはシンボリックな URL プレフィックスを完全な URL へマッピングするための設定。

例：

<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>

use_minimalistic_part_header_in_zookeeper​

ZooKeeper におけるデータパーツヘッダーの保存方法を制御します。この設定は MergeTree ファミリーにのみ適用されます。次の場所で指定できます。

config.xml ファイルの merge_tree セクションでグローバルに指定する場合

ClickHouse はサーバー上のすべてのテーブルに対してこの設定を使用します。設定はいつでも変更できます。既存のテーブルも、設定が変更されるとその挙動が変わります。

テーブルごとに指定する場合

テーブルを作成する際に、対応する engine setting を指定します。この設定をテーブルに個別指定した場合、そのテーブルの挙動は、グローバル設定が変わっても変化しません。

設定可能な値

  • 0 — 機能を無効にします。
  • 1 — 機能を有効にします。

use_minimalistic_part_header_in_zookeeper = 1 の場合、replicated テーブルは、データパーツのヘッダーを 1 つの znode を用いてコンパクトに保存します。テーブルに多くのカラムが含まれている場合、この保存方式により ZooKeeper に保存されるデータ量を大幅に削減できます。

注記

use_minimalistic_part_header_in_zookeeper = 1 を適用した後は、この設定をサポートしていないバージョンの ClickHouse サーバーへダウングレードできません。クラスタ内のサーバーで ClickHouse をアップグレードする際は注意してください。すべてのサーバーを一度にアップグレードしないでください。ClickHouse の新バージョンは、テスト環境、またはクラスタ内の一部のサーバーで試験する方が安全です。

この設定で既に保存されたデータパーツヘッダーは、以前の（非コンパクトな）表現に戻すことはできません。

user_defined_executable_functions_config​

実行可能なユーザー定義関数用の設定ファイルへのパスです。

パス:

  • 絶対パス、またはサーバーの設定ファイルからの相対パスを指定します。
  • パスにはワイルドカードの * や ? を含めることができます。

参照:

例

<user_defined_executable_functions_config>*_function.xml</user_defined_executable_functions_config>

user_defined_path​

ユーザー定義のファイルを格納するディレクトリです。SQL のユーザー定義関数で使用されます。詳しくは SQL User Defined Functions を参照してください。

例

<user_defined_path>/var/lib/clickhouse/user_defined/</user_defined_path>

user_directories​

以下の設定を含む設定ファイルのセクションです:

  • 事前定義されたユーザーを記述した設定ファイルへのパス。
  • SQL コマンドで作成されたユーザーが保存されるフォルダへのパス。
  • SQL コマンドで作成されたユーザーが保存およびレプリケートされる ZooKeeper ノードパス。

このセクションが指定されている場合、users_config と access_control_path からのパスは使用されません。

user_directories セクションには任意の数の項目を含めることができ、項目の順序は優先順位を意味します（上にある項目ほど優先順位が高くなります）。

例

<user_directories>
    <users_xml>
        <path>/etc/clickhouse-server/users.xml</path>
    </users_xml>
    <local_directory>
        <path>/var/lib/clickhouse/access/</path>
    </local_directory>
</user_directories>

ユーザー、ロール、行ポリシー、QUOTA、およびプロファイルは ZooKeeper に格納することもできます：

<user_directories>
    <users_xml>
        <path>/etc/clickhouse-server/users.xml</path>
    </users_xml>
    <replicated>
        <zookeeper_path>/clickhouse/access/</zookeeper_path>
    </replicated>
</user_directories>

memory セクションおよび ldap セクションを定義することもできます。memory は情報をディスクに書き込まずメモリ内のみに保存することを意味し、ldap は情報を LDAP サーバー上に保存することを意味します。

ローカルに定義されていないユーザーのリモートユーザーディレクトリとして LDAP サーバーを追加するには、次の設定を持つ 1 つの ldap セクションを定義します:

SettingDescription
serverldap_servers 設定セクションで定義された LDAP サーバー名のいずれか。このパラメータは必須で、空にはできません。
rolesLDAP サーバーから取得された各ユーザーに割り当てられる、ローカルに定義されたロールの一覧を持つセクション。ロールが指定されていない場合、ユーザーは認証後にいかなる操作も実行できません。列挙されたロールのいずれかが認証時点でローカルに定義されていない場合、指定されたパスワードが誤っている場合と同様に、認証試行は失敗します。

例

<ldap>
    <server>my_ldap_server</server>
        <roles>
            <my_local_role1 />
            <my_local_role2 />
        </roles>
</ldap>

user_files_path​

ユーザーファイルを格納するディレクトリです。テーブル関数 file()、fileCluster() で使用されます。

例

<user_files_path>/var/lib/clickhouse/user_files/</user_files_path>

user_scripts_path​

ユーザースクリプトファイルを格納するディレクトリです。Executable ユーザー定義関数で使用されます。詳細は Executable User Defined Functions を参照してください。

例

<user_scripts_path>/var/lib/clickhouse/user_scripts/</user_scripts_path>

型:

デフォルト値:

users_config​

次の内容を含むファイルへのパスです：

  • ユーザー設定
  • アクセス権限
  • 設定プロファイル
  • クォータ設定

例

<users_config>users.xml</users_config>

validate_tcp_client_information​

クエリパケットを受信した際にクライアント情報の検証を有効にするかどうかを制御します。

デフォルトでは false です：

<validate_tcp_client_information>false</validate_tcp_client_information>

vector_similarity_index_cache_max_entries​

ベクトル類似度索引用キャッシュのサイズ（エントリ数）。設定値が 0 の場合は無効になります。

vector_similarity_index_cache_policy​

ベクトル類似度索引キャッシュポリシーの名前。

vector_similarity_index_cache_size​

ベクトル類似性索引用キャッシュのサイズです。0 を指定すると無効になります。

注記

この設定は実行時に変更可能で、直ちに反映されます。

vector_similarity_index_cache_size_ratio​

ベクトル類似度索引キャッシュにおける（SLRU ポリシーの場合の）保護キューのサイズが、キャッシュ全体サイズに対して占める割合を表します。

wait_dictionaries_load_at_startup​

この設定は、dictionaries_lazy_load が false の場合の動作を指定します。 （dictionaries_lazy_load が true の場合、この設定は何の影響も与えません。）

wait_dictionaries_load_at_startup が false の場合、サーバーは起動時にすべての Dictionary の読み込みを開始し、その読み込みと並行して接続を受け付けます。 ある Dictionary がクエリ内で初めて使用されるとき、その Dictionary がまだ読み込まれていない場合は、クエリはその Dictionary の読み込みが完了するまで待機します。 wait_dictionaries_load_at_startup を false に設定すると、ClickHouse の起動を高速化できますが、一部のクエリの実行が遅くなる可能性があります （いくつかの Dictionary の読み込み完了を待つ必要があるため）。

wait_dictionaries_load_at_startup が true の場合、サーバーは起動時に、すべての Dictionary の読み込み（成功・失敗を問わず）が完了するまで待機し、その後で接続の受け付けを開始します。

例

<wait_dictionaries_load_at_startup>true</wait_dictionaries_load_at_startup>

workload_path​

すべての CREATE WORKLOAD および CREATE RESOURCE クエリの保存先として使用されるディレクトリです。デフォルトでは、サーバーのワーキングディレクトリ配下の /workload/ フォルダが使用されます。

例

<workload_path>/var/lib/clickhouse/workload/</workload_path>

関連項目

workload_zookeeper_path​

ZooKeeper ノードへのパスです。すべての CREATE WORKLOAD および CREATE RESOURCE クエリのストレージとして使用されます。整合性を保つため、すべての SQL 定義は 1 つの znode の値として保存されます。デフォルトでは ZooKeeper は使用されず、定義は ディスク 上に保存されます。

例

<workload_zookeeper_path>/clickhouse/workload/definitions.sql</workload_zookeeper_path>

関連項目

zookeeper​

ClickHouse が ZooKeeper クラスターと連携するための設定を含みます。ClickHouse は、レプリケーテッドテーブルを使用する場合に、レプリカのメタデータを保存するために ZooKeeper を使用します。レプリケーテッドテーブルを使用しない場合、このセクションのパラメータは省略できます。

以下の設定はサブタグで指定できます:

SettingDescription
nodeZooKeeper エンドポイント。複数のエンドポイントを設定できます。例: <node index="1"><host>example_host</host><port>2181</port></node>。index 属性は、ZooKeeper クラスターへの接続を試行する際のノードの順序を指定します。
session_timeout_msクライアントセッションの最大タイムアウト時間 (ミリ秒)。
operation_timeout_ms1 つの操作の最大タイムアウト時間 (ミリ秒)。
root (optional)ClickHouse サーバーが使用する znode のルートとして使用される znode。
fallback_session_lifetime.min (optional)プライマリが利用できない場合にフォールバックノードへの ZooKeeper セッション存続時間の最小制限 (ロードバランシング)。秒単位で指定。デフォルト: 3 時間。
fallback_session_lifetime.max (optional)プライマリが利用できない場合にフォールバックノードへの ZooKeeper セッション存続時間の最大制限 (ロードバランシング)。秒単位で指定。デフォルト: 6 時間。
identity (optional)要求された znode にアクセスするために ZooKeeper によって要求されるユーザー名とパスワード。
use_compression (optional)true に設定すると Keeper プロトコルで圧縮を有効にします。

また、ZooKeeper ノードの選択アルゴリズムを指定できる zookeeper_load_balancing 設定 (任意) もあります:

Algorithm NameDescription
randomZooKeeper ノードのうち 1 つをランダムに選択します。
in_order最初の ZooKeeper ノードを選択し、それが利用できない場合は 2 番目、その次という順に選択します。
nearest_hostnameサーバーのホスト名と最も類似したホスト名を持つ ZooKeeper ノードを選択します。ホスト名は名前の接頭辞で比較されます。
hostname_levenshtein_distancenearest_hostname と同様ですが、ホスト名をレーベンシュタイン距離で比較します。
first_or_random最初の ZooKeeper ノードを選択し、それが利用できない場合は残りの ZooKeeper ノードのうち 1 つをランダムに選択します。
round_robin最初の ZooKeeper ノードを選択し、再接続が発生した場合は次のノードを選択します。

設定例

<zookeeper>
    <node>
        <host>example1</host>
        <port>2181</port>
    </node>
    <node>
        <host>example2</host>
        <port>2181</port>
    </node>
    <session_timeout_ms>30000</session_timeout_ms>
    <operation_timeout_ms>10000</operation_timeout_ms>
    <!-- オプション。Chroot サフィックス。存在している必要があります。 -->
    <root>/path/to/zookeeper/node</root>
    <!-- オプション。Zookeeper ダイジェスト ACL 文字列。 -->
    <identity>user:password</identity>
    <!--<zookeeper_load_balancing>random / in_order / nearest_hostname / hostname_levenshtein_distance / first_or_random / round_robin</zookeeper_load_balancing>-->
    <zookeeper_load_balancing>random</zookeeper_load_balancing>
</zookeeper>

関連項目

zookeeper_log​

zookeeper_log システムテーブルに関する設定です。

以下の設定は、サブタグごとに構成できます:

The following settings can be configured by sub-tags:

SettingDescriptionDefaultNote
databaseデータベース名。
tableシステムテーブル名。
engineシステムテーブルに対する MergeTree エンジン定義。partition_by または order_by が定義されている場合は使用できません。指定しない場合はデフォルトで MergeTree が選択されます
partition_byシステムテーブルに対するカスタムパーティショニングキー。システムテーブルに engine を指定する場合、partition_by パラメータは engine の設定内で直接指定する必要があります
ttlテーブルの TTL を指定します。システムテーブルに engine を指定する場合、ttl パラメータは engine の設定内で直接指定する必要があります
order_byシステムテーブルに対するカスタムソートキー。engine が定義されている場合は使用できません。システムテーブルに engine を指定する場合、order_by パラメータは engine の設定内で直接指定する必要があります
storage_policyテーブルに使用するストレージポリシー名（任意）。システムテーブルに engine を指定する場合、storage_policy パラメータは engine の設定内で直接指定する必要があります
settingsMergeTree の動作を制御する追加パラメータ（任意）。システムテーブルに engine を指定する場合、settings パラメータは engine の設定内で直接指定する必要があります
flush_interval_millisecondsメモリ上のバッファからテーブルへデータをフラッシュする間隔。7500
max_size_rowsログの最大行数。未フラッシュのログ数が max_size_rows に達すると、ログがディスクにダンプされます。1048576
reserved_size_rowsログ用に事前確保されるメモリ容量（行数）。8192
buffer_size_rows_flush_threshold行数のしきい値。このしきい値に達すると、バックグラウンドでログをディスクへフラッシュする処理が起動します。max_size_rows / 2
flush_on_crashクラッシュ発生時にログをディスクへダンプするかどうかを設定します。false

例

<clickhouse>
    <zookeeper_log>
        <database>system</database>
        <table>zookeeper_log</table>
        <flush_interval_milliseconds>7500</flush_interval_milliseconds>
        <ttl>event_date + INTERVAL 1 WEEK DELETE</ttl>
    </zookeeper_log>
</clickhouse>