服务器设置

本节包含服务器设置的说明。这些设置无法在会话级或查询级进行更改。

有关 ClickHouse 中配置文件的更多信息，请参阅 Configuration Files。

其他设置在 Settings 一节中进行了说明。在学习这些设置之前，建议先阅读 Configuration files 一节，并注意替换机制的用法（incl 和 optional 属性）。

abort_on_logical_error

在出现 LOGICAL_ERROR 异常时使服务器崩溃。仅供专家使用。

access_control_improvements

访问控制系统可选改进项的设置。

Setting	Description	Default
`users_without_row_policies_can_read_rows`	设置没有宽松行策略的用户是否仍然可以使用 `SELECT` 查询读取行。例如，如果有两个用户 A 和 B，并且只为 A 定义了行策略，那么如果此设置为 true，用户 B 将看到所有行；如果此设置为 false，用户 B 将看不到任何行。	`true`
`on_cluster_queries_require_cluster_grant`	设置 `ON CLUSTER` 查询是否需要 `CLUSTER` 授权。	`true`
`select_from_system_db_requires_grant`	设置 `SELECT * FROM system.<table>` 是否需要任何权限，以及是否可以由任意用户执行。如果设置为 true，则该查询需要 `GRANT SELECT ON system.<table>`，与非 system 表相同。例外情况：少数 system 表（`tables`、`columns`、`databases` 以及一些常量表，如 `one`、`contributors`）对所有人仍然可访问；并且如果授予了某个 `SHOW` 权限（例如 `SHOW USERS`），则对应的 system 表（即 `system.users`）将可访问。	`true`
`select_from_information_schema_requires_grant`	设置 `SELECT * FROM information_schema.<table>` 是否需要任何权限，以及是否可以由任意用户执行。如果设置为 true，则该查询需要 `GRANT SELECT ON information_schema.<table>`，与普通表相同。	`true`
`settings_constraints_replace_previous`	设置在设置配置文件中针对某个设置添加的约束，是否会抵消此前针对该设置的约束（在其他配置文件中定义）的效果，包括那些未被新约束显式设置的字段。它还会启用 `changeable_in_readonly` 约束类型。	`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 功能设置 readonly 约束。

注意

当值为 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，则在优雅关闭时会刷新异步插入队列

async_insert_threads

用于在后台实际解析并插入数据的最大线程数。值为 0 表示禁用异步模式。

async_load_databases

异步加载数据库和表。

如果为 true，则在 ClickHouse 服务器启动之后，所有使用 Ordinary、Atomic 和 Replicated 引擎的非系统数据库将被异步加载。参见 system.asynchronous_loader 表，以及 tables_loader_background_pool_size 和 tables_loader_foreground_pool_size 服务器设置。任何试图访问尚未加载完成的表的查询，都会等待该表完成启动。如果加载任务失败，查询会重新抛出错误（而不是在 async_load_databases = false 的情况下关闭整个服务器）。至少被一个查询等待的表将以更高优先级加载。针对某个数据库的 DDL 查询会等待该数据库完成启动。同时建议设置 max_waiting_queries 以限制等待查询的总数量。
如果为 false，所有数据库会在服务器启动时加载。

示例

<async_load_databases>true</async_load_databases>

async_load_system_database

系统表的异步加载。如果 system 数据库中有大量日志表和数据部件，该选项很有用。与 async_load_databases 设置相互独立。

如果设置为 true，所有使用 Ordinary、Atomic 和 Replicated 引擎的 system 数据库将在 ClickHouse 服务器启动后异步加载。参见 system.asynchronous_loader 表以及 tables_loader_background_pool_size 和 tables_loader_foreground_pool_size 服务器设置。任何试图访问尚未加载的 system 表的查询，都会等待该表启动完成。至少有一个查询正在等待的表将以更高优先级进行加载。还可以考虑设置 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 系统表的相关设置，用于记录异步插入操作。

以下设置可以通过子标签进行配置：

Setting	Description	Default	Note
`database`	数据库名称。
`table`	系统表名称。
`engine`	系统表的 MergeTree 引擎定义。		如果已定义 `partition_by` 或 `order_by`，则不能使用该设置。如果未指定，则默认选择 `MergeTree`
`partition_by`	系统表的自定义分区键。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `partition_by` 参数
`ttl`	指定表的 TTL。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `ttl` 参数
`order_by`	系统表的自定义排序键。如果已定义 `engine`，则不能使用该设置。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `order_by` 参数
`storage_policy`	要用于该表的存储策略名称（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `storage_policy` 参数
`settings`	控制 MergeTree 行为的额外参数（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `settings` 参数
`flush_interval_milliseconds`	将内存缓冲区中的数据刷新到表的时间间隔。	`7500`
`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 设置，应创建如下文件 /etc/clickhouse-server/config.d/disable_asynchronous_metric_log.xml，其内容如下：

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

以下设置可以通过子标签进行配置：

Setting	Description	Default	Note
`database`	数据库名称。
`table`	系统表名称。
`engine`	系统表的 MergeTree 引擎定义。		如果已定义 `partition_by` 或 `order_by`，则不能使用该设置。如果未指定，则默认选择 `MergeTree`
`partition_by`	系统表的自定义分区键。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `partition_by` 参数
`ttl`	指定表的 TTL。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `ttl` 参数
`order_by`	系统表的自定义排序键。如果已定义 `engine`，则不能使用该设置。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `order_by` 参数
`storage_policy`	要用于该表的存储策略名称（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `storage_policy` 参数
`settings`	控制 MergeTree 行为的额外参数（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `settings` 参数
`flush_interval_milliseconds`	将内存缓冲区中的数据刷新到表的时间间隔。	`7500`
`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 引擎表刷新（flush）操作时可使用的最大线程数。

background_common_pool_size

在后台为 *MergeTree 引擎表执行各种操作（主要是垃圾回收）时所能使用的最大线程数。

background_distributed_schedule_pool_size

用于执行分布式发送操作的最大线程数。

background_fetches_pool_size

在后台为 *MergeTree 引擎表从其他副本获取数据分片时可使用的最大线程数。

background_merges_mutations_concurrency_ratio

设置线程数与可并发执行的后台合并和变更（mutations）数量之间的比例。

例如，如果该比例为 2，并且 background_pool_size 设置为 16，那么 ClickHouse 可以并发执行 32 个后台合并。这之所以可行，是因为后台操作可以被挂起和延后。这样可以让小型合并获得更高的执行优先级。

注意

只能在运行时增加此比例；若要降低它，必须重启服务器。

与 background_pool_size 设置类似，为了向后兼容，可以在 default profile 中应用 background_merges_mutations_concurrency_ratio。

background_merges_mutations_scheduling_policy

用于控制如何调度后台合并（merge）和变更操作（mutation）的策略。可选值为：round_robin 和 shortest_task_first。

该策略对应的算法用于从后台线程池中选择要执行的下一个合并或变更任务。该策略可以在运行时更改，而无需重启服务器。为了向后兼容，可以从 default 配置文件中应用该设置。

可选值：

round_robin — 所有并发进行的合并和变更任务按轮询（round-robin）顺序执行，以确保不会出现任务饥饿。较小的合并由于需要合并的块更少，会比更大的合并完成得更快。
shortest_task_first — 始终优先执行较小的合并或变更。合并和变更会根据其结果大小分配优先级。结果较小的合并会被严格优先于较大的合并执行。该策略可以以最快速度完成小数据片段的合并，但在被大量 INSERT 操作严重压载的分区中，可能导致大合并无限期处于饥饿状态，迟迟得不到执行。

background_message_broker_schedule_pool_size

用于执行消息流式处理后台任务的最大线程数。

background_move_pool_size

在后台将 MergeTree 引擎表的数据片段移动到其他磁盘或卷时可使用的最大线程数。

background_pool_size

设置为 MergeTree 引擎表执行后台合并（merge）和数据变更（mutation）的线程数量。

注意

出于向后兼容的考虑，也可以在 ClickHouse 服务器启动时，通过 default profile 配置来应用此设置。
在运行时你只能增加线程数。
若要降低线程数，必须重启服务器。
通过调整此设置，你可以管理 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_log 系统表的相关参数，用于记录 BACKUP 和 RESTORE 操作。

以下设置可以通过子标签进行配置：

Setting	Description	Default	Note
`database`	数据库名称。
`table`	系统表名称。
`engine`	系统表的 MergeTree 引擎定义。		如果已定义 `partition_by` 或 `order_by`，则不能使用该设置。如果未指定，则默认选择 `MergeTree`
`partition_by`	系统表的自定义分区键。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `partition_by` 参数
`ttl`	指定表的 TTL。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `ttl` 参数
`order_by`	系统表的自定义排序键。如果已定义 `engine`，则不能使用该设置。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `order_by` 参数
`storage_policy`	要用于该表的存储策略名称（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `storage_policy` 参数
`settings`	控制 MergeTree 行为的额外参数（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `settings` 参数
`flush_interval_milliseconds`	将内存缓冲区中的数据刷新到表的时间间隔。	`7500`
`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 语句时。

以下设置可以在子标签中进行配置：

设置	类型	说明	默认值
`allow_concurrent_backups`	Bool	确定是否允许在同一主机上并发运行多个备份操作。	`true`
`allow_concurrent_restores`	Bool	确定是否允许在同一主机上并发运行多个恢复操作。	`true`
`allowed_disk`	String	使用 `File()` 时要备份到的磁盘。必须设置此参数才能使用 `File`。	``
`allowed_path`	String	使用 `File()` 时要备份到的路径。必须设置此参数才能使用 `File`。	``
`attempts_to_collect_metadata_before_sleep`	UInt	在比较后发现元数据不一致时，在进入休眠前尝试重新收集元数据的次数。	`2`
`collect_metadata_timeout`	UInt64	备份期间收集元数据的超时时间（毫秒）。	`600000`
`compare_collected_metadata`	Bool	若为 true，则会将收集到的元数据与现有元数据进行比较，以确保它们在备份期间未被更改。	`true`
`create_table_timeout`	UInt64	恢复期间创建表的超时时间（毫秒）。	`300000`
`max_attempts_after_bad_version`	UInt64	在协调备份/恢复过程中遇到 bad version 错误后，重试的最大次数。	`3`
`max_sleep_before_next_attempt_to_collect_metadata`	UInt64	在下一次尝试收集元数据之前的最大休眠时间（毫秒）。	`100`
`min_sleep_before_next_attempt_to_collect_metadata`	UInt64	在下一次尝试收集元数据之前的最小休眠时间（毫秒）。	`5000`
`remove_backup_files_after_failure`	Bool	如果 `BACKUP` 命令失败，ClickHouse 将尝试删除在失败前已复制到备份中的文件，否则会保留这些已复制的文件不做处理。	`true`
`sync_period_ms`	UInt64	协调备份/恢复的同步周期（毫秒）。	`5000`
`test_inject_sleep`	Bool	用于测试的休眠注入。	`false`
`test_randomize_order`	Bool	若为 true，则会随机化某些操作的顺序，用于测试目的。	`false`
`zookeeper_path`	String	使用 `ON 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 系统表的设置。

以下设置可以通过子标签进行配置：

Setting	Description	Default	Note
`database`	数据库名称。
`table`	系统表名称。
`engine`	系统表的 MergeTree 引擎定义。		如果已定义 `partition_by` 或 `order_by`，则不能使用该设置。如果未指定，则默认选择 `MergeTree`
`partition_by`	系统表的自定义分区键。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `partition_by` 参数
`ttl`	指定表的 TTL。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `ttl` 参数
`order_by`	系统表的自定义排序键。如果已定义 `engine`，则不能使用该设置。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `order_by` 参数
`storage_policy`	要用于该表的存储策略名称（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `storage_policy` 参数
`settings`	控制 MergeTree 行为的额外参数（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `settings` 参数
`flush_interval_milliseconds`	将内存缓冲区中的数据刷新到表的时间间隔。	`7500`
`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

设置编译后的表达式的缓存大小（以字节为单位）。

压缩

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 slots）进行调度的策略。该算法用于控制在并发查询之间如何分配有限数量的 CPU 槽位。调度器可以在运行时更改，而无需重启服务器。

可能的取值：

round_robin — 每个 use_concurrency_control = 1 的查询最多可分配 max_threads 个 CPU 槽位，每个线程占用一个槽位。发生竞争时，CPU 槽位按轮询方式分配给各个查询。注意，第一个槽位是无条件分配的，这可能导致不公平，并在存在大量 max_threads = 1 的查询时，提高具有较大 max_threads 的查询的延迟。
fair_round_robin — 每个 use_concurrency_control = 1 的查询最多可分配 max_threads - 1 个 CPU 槽位。它是 round_robin 的一种变体，不为每个查询的第一个线程分配 CPU 槽位。这样，max_threads = 1 的查询不需要任何槽位，因此无法不公平地占用所有槽位。不会无条件分配任何槽位。

concurrent_threads_soft_limit_num

用于运行所有查询的最大查询处理线程数（不包括用于从远程服务器获取数据的线程）。这不是一个硬性限制。如果达到该限制，查询仍然至少会获得一个线程来运行。如果在执行期间有更多线程变为可用，查询可以扩展到所需的线程数。

注意

值为 0（默认）表示不受限制。

concurrent_threads_soft_limit_ratio_to_cores

与 concurrent_threads_soft_limit_num 相同，但其值按 CPU 核心数的比例计算。

config_reload_interval_ms

ClickHouse 多久重新加载配置并检查是否有新变更

core_dump

配置 core dump 文件大小的软限制值。

注意

硬限制通过系统工具进行配置。

示例

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

cpu_slot_preemption

定义如何为 CPU 资源（MASTER THREAD 和 WORKER THREAD）进行工作负载调度。

如果为 true（推荐），则基于实际消耗的 CPU 时间进行核算。会为相互竞争的工作负载分配公平的 CPU 时间。Slot 在限定时间内分配，到期后需要重新请求。在 CPU 资源过载的情况下，请求 slot 可能会阻塞线程执行，即可能发生抢占（preemption）。这可确保 CPU 时间上的公平性。
如果为 false（默认），则基于分配的 CPU slot 数量进行核算。会为相互竞争的工作负载分配公平数量的 CPU slot。线程启动时分配一个 slot，在线程执行期间持续占用，直到线程结束执行后才释放。用于查询执行的线程数只能从 1 增加到 max_threads，不会减少。这对长时间运行的查询更有利，但可能导致短查询出现 CPU 饥饿。

示例

<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 系统表操作的相关设置。

可以通过子标签配置以下设置：

Setting	Description	Default	Note
`database`	数据库名称。
`table`	系统表名称。
`engine`	系统表的 MergeTree 引擎定义。		如果定义了 `partition_by` 或 `order_by`，则不能使用该项。如果未指定，默认选择 `MergeTree`
`partition_by`	系统表的自定义分区键。		如果为系统表指定了 `engine`，则应在 'engine' 内直接指定 `partition_by` 参数
`ttl`	指定表的 TTL。		如果为系统表指定了 `engine`，则应在 'engine' 内直接指定 `ttl` 参数
`order_by`	系统表的自定义排序键。如果定义了 `engine`，则不能使用该项。		如果为系统表指定了 `engine`，则应在 'engine' 内直接指定 `order_by` 参数
`storage_policy`	表所使用的存储策略名称（可选）。		如果为系统表指定了 `engine`，则应在 'engine' 内直接指定 `storage_policy` 参数
`settings`	控制 MergeTree 行为的其他参数（可选）。		如果为系统表指定了 `engine`，则应在 'engine' 内直接指定 `settings` 参数
`flush_interval_milliseconds`	将内存中缓冲区的数据刷新到表中的时间间隔。	`7500`
`max_size_rows`	日志的最大行数。当未刷新的日志数量达到 `max_size_rows` 时，会将日志转储到磁盘。	`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' 系统表的参数。

以下设置可以通过子标签进行配置：

Setting	Description	Default	Note
`database`	数据库名称。
`table`	系统表名称。
`engine`	系统表的 MergeTree 引擎定义。		如果已定义 `partition_by` 或 `order_by`，则不能使用该设置。如果未指定，则默认选择 `MergeTree`
`partition_by`	系统表的自定义分区键。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `partition_by` 参数
`ttl`	指定表的 TTL。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `ttl` 参数
`order_by`	系统表的自定义排序键。如果已定义 `engine`，则不能使用该设置。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `order_by` 参数
`storage_policy`	要用于该表的存储策略名称（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `storage_policy` 参数
`settings`	控制 MergeTree 行为的额外参数（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `settings` 参数
`flush_interval_milliseconds`	将内存缓冲区中的数据刷新到表的时间间隔。	`7500`
`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

默认设置配置文件。设置配置文件定义在 user_config 设置指定的文件中。

示例

<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

字典的惰性加载。

如果为 true，则每个字典会在首次使用时加载。加载失败时，使用该字典的函数会抛出异常。
如果为 false，则服务器会在启动时加载所有字典。

注意

服务器在启动时会等待所有字典加载完成后，才会开始接受任何连接（例外：如果 wait_dictionaries_load_at_startup 被设置为 false）。

示例

<dictionaries_lazy_load>true</dictionaries_lazy_load>

dictionary_background_reconnect_interval

启用 background_reconnect 时，MySQL 和 Postgres 字典在连接失败后重试连接的时间间隔（毫秒）。

disable_insertion_and_mutation

禁用 insert/alter/delete 查询。若需要只读节点以防止插入和 mutation 影响读取性能，则会启用此设置。即使启用了该设置，仍然允许向外部引擎（S3、DataLake、MySQL、PostrgeSQL、Kafka 等）执行插入操作。

disable_internal_dns_cache

禁用内部 DNS 缓存。建议在基础设施经常变更的系统（如 Kubernetes）中运行 ClickHouse 时禁用内部 DNS 缓存。

disable_tunneling_for_https_requests_over_http_proxy

默认情况下，会使用隧道模式（即 HTTP CONNECT）通过 HTTP 代理发起 HTTPS 请求。可以使用此设置来禁用该行为。

no_proxy

默认情况下，所有请求都会通过代理。若要对特定主机禁用代理，必须设置 no_proxy 变量。它可以在 list 和 remote 解析器的 <proxy> 子句中设置，也可以在 environment 解析器中作为环境变量进行设置。它支持 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_soft_limit

超过此限制的连接其存活时间会被大幅缩短。此限制适用于磁盘连接数。

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_keep_up_free_connections_ratio * max_connections 时，将关闭最近最久未活动的连接，直到空闲连接数再次超过该限制。

distributed_ddl

在集群上管理执行分布式 DDL 查询（CREATE、DROP、ALTER、RENAME）。仅在启用 ZooKeeper 时生效。

<distributed_ddl> 中可配置的参数包括：

Setting	Description	Default Value
`path`	Keeper 中用于 DDL 查询 `task_queue` 的路径
`profile`	用于执行 DDL 查询的配置文件（profile）
`pool_size`	可以同时运行的 `ON CLUSTER` 查询数量
`max_tasks_in_queue`	队列中可以存在的最大任务数。	`1,000`
`task_max_lifetime`	如果节点存在时间超过该值则删除该节点。	`7 * 24 * 60 * 60`（一周的秒数）
`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 字节的字符串。

示例

从配置加载：

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

注意

不建议在配置文件中存储密钥，这样做不安全。你可以将密钥移动到安全磁盘上的单独配置文件中，并在 config.d/ 目录中为该配置文件创建符号链接。

当密钥以十六进制表示时，从配置中加载：

<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 字节长的 nonce（默认情况下，加密和解密过程使用的是由零字节组成的 nonce）：

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

也可以使用十六进制表示：

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

以下设置可以通过子标签进行配置：

Setting	Description	Default	Note
`database`	数据库名称。
`table`	系统表名称。
`engine`	系统表的 MergeTree 引擎定义。		如果已定义 `partition_by` 或 `order_by`，则不能使用该设置。如果未指定，则默认选择 `MergeTree`
`partition_by`	系统表的自定义分区键。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `partition_by` 参数
`ttl`	指定表的 TTL。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `ttl` 参数
`order_by`	系统表的自定义排序键。如果已定义 `engine`，则不能使用该设置。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `order_by` 参数
`storage_policy`	要用于该表的存储策略名称（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `storage_policy` 参数
`settings`	控制 MergeTree 行为的额外参数（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `settings` 参数
`flush_interval_milliseconds`	将内存缓冲区中的数据刷新到表的时间间隔。	`7500`
`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

包含输入数据 schema 的目录路径，例如用于 CapnProto 格式的 schema。

示例

<!-- 包含各种输入格式架构文件的目录。 -->
<format_schema_path>format_schemas/</format_schema_path>

global_profiler_cpu_time_period_ns

全局分析器的 CPU 时钟计时周期（以纳秒为单位）。将该值设置为 0 可关闭全局 CPU 时钟分析器。推荐值：对于单个查询至少为 10000000（每秒 100 次），对于集群范围的分析至少为 1000000000（每秒 1 次）。

global_profiler_real_time_period_ns

全局分析器的真实时钟计时器周期（单位：纳秒）。将该值设置为 0 可关闭真实时钟全局分析器。对于单个查询，建议值至少为 10000000（每秒 100 次）；对于集群级分析，建议值为 1000000000（每秒 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_soft_limit

超过该限制的连接的存活时间会显著缩短。此限制适用于不隶属于任何磁盘或存储的 HTTP 连接。

http_connections_store_limit

超过此限制的连接在使用后将被重置。将其设为 0 可关闭连接缓存。该限制适用于不属于任何磁盘或存储的 HTTP 连接。

http_connections_warn_limit

当处于使用状态的连接数超过该限制时，将在日志中记录警告消息。该限制适用于不隶属于任何磁盘或存储的 HTTP 连接。

http_handlers

允许使用自定义 HTTP 处理器。要添加一个新的 http 处理器，只需添加一个新的 <rule>。规则会按定义时从上到下的顺序进行检查，第一个匹配成功的规则将运行对应的处理器。

可以通过子标签配置以下设置：

Sub-tags	Definition
`url`	用于匹配请求 URL，可以使用前缀 'regex:' 启用正则表达式匹配（可选）
`methods`	用于匹配请求方法，可以使用逗号分隔多个方法匹配项（可选）
`headers`	用于匹配请求头，匹配每个子元素（子元素名称即为 header 名称），可以使用前缀 'regex:' 启用正则表达式匹配（可选）
`handler`	请求处理器
`empty_query_string`	用于检查 URL 中是否不存在查询字符串

handler 包含以下设置，可以通过子标签进行配置：

Sub-tags	Definition
`url`	重定向目标地址
`type`	支持的类型：static、dynamic_query_handler、predefined_query_handler、redirect
`status`	与 static 类型一起使用，响应状态码
`query_param_name`	与 dynamic_query_handler 类型一起使用，从 HTTP 请求参数中提取名为 `<query_param_name>` 的参数值并执行
`query`	与 predefined_query_handler 类型一起使用，在处理器被调用时执行该查询
`content_type`	与 static 类型一起使用，响应的 content-type
`response_content`	与 static 类型一起使用，发送给客户端的响应内容；当使用前缀 'file://' 或 'config://' 时，从文件或配置中读取内容并发送给客户端

除了规则列表之外，还可以指定 <defaults/>，用于启用所有默认处理器。

示例：

<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 catalog 线程池任务队列中可排队的最大任务数

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 凭证。可以分多个步骤更改凭证。

要启用身份验证，请将 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，或移除该设置。这样会强制要求使用新凭据进行身份验证。

要更改现有凭据，请将用户名和密码移动到 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

ClickHouse 服务器之间使用 HTTPS 协议交换数据的端口。

示例

<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

可以在 IO 线程池中调度的最大任务数。

注意

值为 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 或查询设置 jemalloc_collect_profile_samples_in_trace_log 将采样数据存储到 system.trace_log 中。参见 Allocation Profiling

jemalloc_flush_profile_interval_bytes

当全局峰值内存使用量相较上次刷新后累计增加了 jemalloc_flush_profile_interval_bytes 时，将刷新 jemalloc 性能分析数据

jemalloc_flush_profile_on_memory_exceeded

当出现总内存超限错误时，将刷新 jemalloc 性能分析文件

jemalloc_max_background_threads_num

要创建的 jemalloc 后台线程的最大数量，将其设为 0 表示使用 jemalloc 的默认值

keep_alive_timeout

在关闭连接之前，ClickHouse 通过 HTTP 协议等待新的传入请求的时间（秒）。

示例

<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 服务器及其连接参数，以便：

将它们用作特定本地用户的身份验证服务，这些用户的身份验证机制指定为 ldap，而不是 password
将它们用作远程用户目录。

可以通过子标签配置以下设置：

Setting	Description
`host`	LDAP 服务器主机名或 IP，此参数为必填项且不能为空。
`port`	LDAP 服务器端口，如果 `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_tls`	控制是否对 LDAP 服务器使用安全连接的标志。指定 `no` 以使用明文 (`ldap://`) 协议（不推荐）。指定 `yes` 以使用基于 SSL/TLS 的 LDAP (`ldaps://`) 协议（推荐，默认值）。指定 `starttls` 以使用传统的 StartTLS 协议（将明文 (`ldap://`) 协议升级为 TLS）。
`tls_minimum_protocol_version`	SSL/TLS 的最小协议版本。可接受的值为：`ssl2`、`ssl3`、`tls1.0`、`tls1.1`、`tls1.2`（默认值）。
`tls_require_cert`	SSL/TLS 对端证书验证行为。可接受的值为：`never`、`allow`、`try`、`demand`（默认值）。
`tls_cert_file`	证书文件路径。
`tls_key_file`	证书密钥文件路径。
`tls_ca_cert_file`	CA 证书文件路径。
`tls_ca_cert_dir`	包含 CA 证书的目录路径。
`tls_cipher_suite`	允许的密码套件（使用 OpenSSL 表示法）。

user_dn_detection 设置可以通过子标签进行配置：

Setting	Description
`base_dn`	用于构造 LDAP 搜索 base DN 的模板。最终 DN 将通过在 LDAP 搜索期间，把模板中所有 `\{user_name\}` 和 '{bind_dn}' 子串替换为实际用户名和 bind DN 来构造。
`scope`	LDAP 搜索的范围。可接受的值为：`base`、`one_level`、`children`、`subtree`（默认值）。
`search_filter`	用于构造 LDAP 搜索过滤器的模板。最终过滤器将通过在 LDAP 搜索期间，把模板中所有 `\{user_name\}`、`\{bind_dn\}` 和 `\{base_dn\}` 子串替换为实际的用户名、bind DN 和 base DN 来构造。注意，必须在 XML 中对特殊字符进行正确转义。

示例：

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

示例（典型的 Active Directory 环境，已配置用户 DN 检测用于后续角色映射）：

<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

监听套接字的积压队列（待处理连接的队列长度）。默认值 4096 与 Linux 5.4+) 中的默认值相同。

通常不需要修改这个值，因为：

默认值已经足够大
为了接受客户端连接，服务器有专门的线程

因此，即使你在 ClickHouse 服务器上看到 TcpExtListenOverflows（来自 nstat）为非零且该计数器在增长，也并不意味着需要增大此值，因为：

通常如果 4096 不够，说明存在某些 ClickHouse 内部的伸缩性问题，因此最好提交一个 issue。
这并不意味着服务器之后就能处理更多连接（即使可以，届时客户端可能已经离开或断开连接）。

示例

<listen_backlog>4096</listen_backlog>

listen_host

对可发起请求的主机的限制。若希望服务器响应来自所有主机的请求，请指定 ::。

示例：

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

listen_reuse_port

允许多个服务器监听同一个 address:port。请求将由操作系统随机路由至某个服务器。不建议启用此设置。

示例

<listen_reuse_port>0</listen_reuse_port>

类型：

默认值：

listen_try

在尝试开始监听时，如果 IPv6 或 IPv4 网络不可用，服务器不会退出。

示例

<listen_try>0</listen_try>

load_marks_threadpool_pool_size

用于加载 marks 的后台线程池的大小

load_marks_threadpool_queue_size

预取池中最多可排入的任务数量

logger

日志消息的位置和格式。

键:

Key	Description
`level`	日志级别。可接受的值：`none`（关闭日志）、`fatal`、`critical`、`error`、`warning`、`notice`、`information`、`debug`、`trace`、`test`
`log`	日志文件的路径。
`errorlog`	错误日志文件的路径。
`size`	轮转策略：日志文件的最大大小（字节）。一旦日志文件大小超过该阈值，它将被重命名并归档，并创建一个新的日志文件。
`count`	轮转策略：最多保留的历史日志文件数量。
`stream_compress`	使用 LZ4 压缩日志消息。设置为 `1` 或 `true` 以启用。
`console`	启用向控制台输出日志。设置为 `1` 或 `true` 以启用。如果 ClickHouse 不以守护进程模式运行，默认值为 `1`，否则为 `0`。
`console_log_level`	控制台输出的日志级别。默认与 `level` 相同。
`formatting.type`	控制台输出的日志格式。目前仅支持 `json`。
`use_syslog`	同时将日志输出转发到 syslog。
`syslog_level`	向 syslog 记录日志时使用的日志级别。
`async`	当为 `true`（默认）时，日志将以异步方式记录（每个输出通道一个后台线程）。否则将在调用 LOG 的线程中完成日志记录。
`async_queue_max_size`	使用异步日志时，队列中等待刷新的最大消息数量。超出的消息将被丢弃。
`startup_level`	启动级别用于在服务器启动时设置根 logger 的级别。启动完成后，日志级别会恢复为 `level` 设置。
`shutdown_level`	关闭级别用于在服务器关闭时设置根 logger 的级别。

日志格式说明符

log 和 errorLog 路径中的文件名支持以下格式说明符，用于生成最终的文件名（路径中的目录部分不支持这些说明符）。

“Example” 列展示的是在 2023-07-06 18:32:07 时的输出。

说明符	说明	示例
`%%`	字面 % 符号	`%`
`%n`	换行符
`%t`	水平 Tab 字符
`%Y`	年份（十进制数），例如 2017	`2023`
`%y`	年份最后两位，表示为十进制数（范围 [00,99]）	`23`
`%C`	年份的前两位十进制数字（范围 [00,99]）	`20`
`%G`	四位数的 ISO 8601 周历年份，即包含指定周的年份。通常仅在与 `%V` 一起使用时有用。	`2023`
`%g`	ISO 8601 周历年份的最后 2 位数字，即包含所指定周的年份。	`23`
`%b`	缩写的月份名称，例如 Oct（取决于区域设置）	`7月`
`%h`	%b 的同义词	`7月`
`%B`	完整月份名称，例如 October（取决于语言环境）	`7月`
`%m`	以十进制数字表示的月份（范围 [01,12]）	`07`
`%U`	一年中的第几周，以十进制数表示（星期日为一周的第一天）（范围 [00,53]）	`27`
`%W`	一年中的周数（以十进制数表示，星期一为一周的第一天）（范围 [00,53]）	`27`
`%V`	ISO 8601 周数（范围 [01,53]）	`27`
`%j`	一年中的第几天，用十进制数表示（范围 [001,366]）	`187`
`%d`	以零填充的十进制数表示的日期（日，范围 [01,31]）。一位数前补零。	`06`
`%e`	以空格填充的十进制表示的日期（范围 [1,31]）。一位数前补一个空格。	`  6`
`%a`	星期名称的缩写，例如 Fri（取决于区域设置）	`周四`
`%A`	完整的星期名称，例如 Friday（取决于所使用的区域设置）	`星期四`
`%w`	星期几，以整数表示，周日为 0（范围 [0-6]）	`4`
`%u`	将星期几表示为十进制数，其中星期一为 1（ISO 8601 格式），取值范围为 [1-7]	`4`
`%H`	24 小时制的小时，以十进制数表示（范围 [00-23]）	`18`
`%I`	以十进制表示的小时数，12 小时制（范围 [01,12]）	`06`
`%M`	以十进制表示的分钟数（范围 [00,59]）	`32`
`%S`	以十进制表示的秒（范围 [00,60]）	`07`
`%c`	标准日期和时间字符串，例如 Sun Oct 17 04:41:13 2010（取决于区域设置）	`Thu Jul 6 18:32:07 2023`
`%x`	本地化的日期表示形式（因区域设置而异）	`2023 年 7 月 6 日`
`%X`	本地化的时间表示形式，例如 18:40:20 或 6:40:20 PM（取决于区域设置）	`18:32:07`
`%D`	短格式 MM/DD/YY 日期，等同于 %m/%d/%y	`2023-07-06`
`%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`	本地化的上午或下午标记（取决于语言环境）	`PM`
`%z`	相对于 UTC 的偏移量，采用 ISO 8601 格式（例如 -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>

<syslog> 的键：

Key	Description
`address`	syslog 的地址，格式为 `host\[:port\]`。如果省略，则使用本地守护进程。
`hostname`	发送日志的主机名（可选）。
`facility`	syslog 的 facility 关键字。必须全部大写并带有 `LOG_` 前缀，例如 `LOG_USER`、`LOG_DAEMON`、`LOG_LOCAL3` 等。默认值：如果指定了 `address` 则为 `LOG_USER`，否则为 `LOG_DAEMON`。
`format`	日志消息格式。可选值：`bsd` 和 `syslog.`

日志格式

可以指定输出到控制台日志中的日志格式。目前仅支持 JSON。

示例

下面是一个输出 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": "已接收信号 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

用于复制表的参数替换。

如果不使用复制表，则可以省略。

更多信息，参见创建复制表一节。

示例

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

mark_cache_policy

Mark 缓存策略的名称。

mark_cache_prewarm_ratio

在预热期间要填充的 mark 缓存容量占其总容量的比例。

mark_cache_size

MergeTree 表引擎家族（MergeTree）的标记（索引）缓存的最大容量。

注意

此设置可以在运行时修改，并会立即生效。

mark_cache_size_ratio

在标记缓存中（采用 SLRU 策略时）受保护队列大小与缓存总大小的比例。

max_active_parts_loading_thread_pool_size

在启动时用于加载活动数据部分集合（Active）的线程数。

max_authentication_methods_per_user

创建或修改用户时可为其配置的最大身份验证方法数量。更改此设置不会影响现有用户。当创建或修改与身份验证相关的查询超出该设置中指定的上限时，查询将执行失败。与身份验证无关的创建或修改查询则会照常成功执行。

注意

值 0 表示不限制。

max_backup_bandwidth_for_server

服务器上所有备份操作的最大读取速度（字节/秒）。0 表示不限速。

max_backups_io_thread_pool_free_size

如果 Backups IO 线程池中空闲线程的数量超过 max_backup_io_thread_pool_free_size，ClickHouse 将释放这些空闲线程占用的资源，并相应缩小线程池的大小。如有需要，可以重新创建线程。

max_backups_io_thread_pool_size

ClickHouse 使用 Backups IO 线程池中的线程来执行与 S3 备份相关的 I/O 操作。max_backups_io_thread_pool_size 限制线程池中的最大线程数。

max_build_vector_similarity_index_thread_pool_size

构建向量索引时可使用的最大线程数。

注意

值为 0 表示使用所有 CPU 核心。

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 中，副本恢复期间用于创建表的线程数。为零表示线程数等于 CPU 核心数。

max_dictionary_num_to_throw

如果字典的数量大于该值，服务器会抛出异常。

仅统计以下数据库引擎的表：

Atomic
Ordinary
Replicated
Lazy

注意

值 0 表示不做限制。

示例

<max_dictionary_num_to_throw>400</max_dictionary_num_to_throw>

max_dictionary_num_to_warn

当已附加的字典数量超过指定值时，ClickHouse 服务器会向 system.warnings 表中添加警告信息。

示例

<max_dictionary_num_to_warn>400</max_dictionary_num_to_warn>

max_distributed_cache_read_bandwidth_for_server

服务器上从分布式缓存读取数据的最大总带宽（以字节/秒计）。0 表示不限制。

max_distributed_cache_write_bandwidth_for_server

服务器端写入分布式缓存的最大总写入速度（以字节/秒为单位）。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 线程池中的线程来执行某些 IO 操作（例如与 S3 进行交互）。max_io_thread_pool_size 用于限制线程池中的最大线程数量。

max_keep_alive_requests

在 ClickHouse 服务器关闭单个 keep-alive 连接之前，该连接上允许处理的最大请求数。

示例

<max_keep_alive_requests>10</max_keep_alive_requests>

max_local_read_bandwidth_for_server

本地读取的最大带宽，单位为字节每秒。

注意

值为 0 表示无限制。

max_local_write_bandwidth_for_server

本地写入的最大速度，单位为字节/秒。

注意

值为 0 表示不限制。

max_materialized_views_count_for_table

限制附加到某个表的物化视图数量。

注意

此处仅计算直接依赖该表的视图，基于视图之上再创建的视图不计入在内。

max_merges_bandwidth_for_server

服务器上所有合并操作的最大读取带宽（以每秒字节数计）。0 表示不限制。

max_mutations_bandwidth_for_server

服务器上所有变更操作（mutation）的最大读取带宽，单位为字节/秒。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 服务器会向 system.warnings 表中添加警告信息。

示例

<max_named_collection_num_to_warn>400</max_named_collection_num_to_warn>

max_open_files

最大可打开文件数。

注意

我们建议在 macOS 上使用此选项，因为 getrlimit() 函数返回的值不正确。

示例

<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

如果活动数据分片（active parts）的数量超过指定值，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

如果任何一个尚未完成的 mutation 的执行时间超过指定的秒数，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

如果前缀反序列化线程池中空闲线程的数量超过 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

通过网络执行读操作时的数据交换最大速度（以字节每秒为单位）。

注意

值为 0（默认）表示不限制。

max_remote_write_network_bandwidth_for_server

写入时通过网络进行数据交换的最大带宽（单位：字节/秒）。

注意

值为 0（默认）表示不限制。

max_replicated_fetches_network_bandwidth_for_server

副本获取（replicated fetches）在网络上的数据交换最大速度，单位为字节每秒。零表示无限制。

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

可用于外部聚合、连接或排序的磁盘空间最大用量。超出此限制的查询会抛出异常并失败。

注意

值为 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 使用全局线程池中的线程来处理查询。如果没有空闲线程用于处理查询，则会在池中创建新的线程。max_thread_pool_size 用于限制线程池中的最大线程数。

示例

<max_thread_pool_size>12000</max_thread_pool_size>

max_unexpected_parts_loading_thread_pool_size

在启动时用于加载非活动数据部分集合（unexpected parts，意外产生的数据部分）的线程数。

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

设置在执行合并（merge）和变更（mutation）操作时允许使用的 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>

以下设置可以通过子标签进行配置：

Setting	Description	Default	Note
`database`	数据库名称。
`table`	系统表名称。
`engine`	系统表的 MergeTree 引擎定义。		如果已定义 `partition_by` 或 `order_by`，则不能使用该设置。如果未指定，则默认选择 `MergeTree`
`partition_by`	系统表的自定义分区键。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `partition_by` 参数
`ttl`	指定表的 TTL。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `ttl` 参数
`order_by`	系统表的自定义排序键。如果已定义 `engine`，则不能使用该设置。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `order_by` 参数
`storage_policy`	要用于该表的存储策略名称（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `storage_policy` 参数
`settings`	控制 MergeTree 行为的额外参数（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `settings` 参数
`flush_interval_milliseconds`	将内存缓冲区中的数据刷新到表的时间间隔。	`7500`
`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

用于判定是否断开连接的操作系统 CPU 等待时间（OSCPUWaitMicroseconds 指标）与忙碌时间（OSCPUVirtualTimeMicroseconds 指标）之间的最小比值。通过在最小和最大比值之间进行线性插值来计算概率，在该比值处概率为 0。更多信息参见在服务器 CPU 过载时控制行为。

mlock_executable

在启动后执行 mlockall，以降低首次查询的延迟，并防止在高 IO 负载下将 ClickHouse 可执行文件从内存换出。

注意

推荐启用此选项，但会使启动时间最多增加几秒。请注意，没有 "CAP_IPC_LOCK" 能力时，此设置将不起作用。

示例

<mlock_executable>false</mlock_executable>

mmap_cache_size

此设置可以避免频繁的打开/关闭调用（由于随之而来的页错误，这些调用开销很大），并允许在多个线程和查询之间复用映射。该设置的数值表示映射区域的数量（通常等于被映射文件的数量）。

映射文件中的数据量可以在以下系统表中通过下列指标进行监控：

MMappedFiles/MMappedFileBytes/MMapCacheCells 位于 system.metrics、system.metric_log
CreatedReadBufferMMap/CreatedReadBufferMMapFailed/MMappedFileCacheHits/MMappedFileCacheMisses 位于 system.events、system.processes、system.query_log、system.query_thread_log、system.query_views_log

注意

映射文件中的数据量本身不会直接消耗内存，也不会计入查询或服务器的内存使用中——因为这部分内存可以像操作系统页缓存一样被丢弃。当 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 中找到。

服务器/客户端设置使用的键：

选项	说明	默认值
`privateKeyFile`	PEM 证书私钥所在文件的路径。该文件可以同时包含私钥和证书。
`certificateFile`	PEM 格式的客户端/服务器证书文件路径。如果 `privateKeyFile` 已包含证书，则可以省略本选项。
`caConfig`	包含受信任 CA 证书的文件或目录的路径。若指向某个文件，该文件必须为 PEM 格式，并且可以包含多个 CA 证书。若指向某个目录，则该目录中必须为每个 CA 证书提供一个 .pem 文件。文件名将根据 CA 主题名的哈希值进行查找。详细信息请参见 SSL_CTX_load_verify_locations 的 man 页面。
`verificationMode`	用于检查节点的证书的方法。详情参见 Context 类的说明。可能的取值：`none`、`relaxed`、`strict`、`once`。	`relaxed`
`verificationDepth`	验证链的最大长度。如果证书链长度超过设定值，则验证失败。	`9`
`loadDefaultCAFile`	是否使用 OpenSSL 的内置 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`
`requireTLSv1`	是否要求使用 TLSv1 连接。可选值：`true`、`false`。	`false`
`requireTLSv1_1`	要求使用 TLSv1.1 连接。可接受的值：`true`、`false`。	`false`
`requireTLSv1_2`	是否要求使用 TLSv1.2 连接。可接受的取值：`true`、`false`。	`false`
`fips`	启用 OpenSSL 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 系统表的相关设置。

以下设置可以通过子标签进行配置：

Setting	Description	Default	Note
`database`	数据库名称。
`table`	系统表名称。
`engine`	系统表的 MergeTree 引擎定义。		如果已定义 `partition_by` 或 `order_by`，则不能使用该设置。如果未指定，则默认选择 `MergeTree`
`partition_by`	系统表的自定义分区键。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `partition_by` 参数
`ttl`	指定表的 TTL。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `ttl` 参数
`order_by`	系统表的自定义排序键。如果已定义 `engine`，则不能使用该设置。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `order_by` 参数
`storage_policy`	要用于该表的存储策略名称（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `storage_policy` 参数
`settings`	控制 MergeTree 行为的额外参数（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `settings` 参数
`flush_interval_milliseconds`	将内存缓冲区中的数据刷新到表的时间间隔。	`7500`
`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 是否在执行有用工作的操作系统 CPU 忙碌时间阈值（以微秒为单位，对应 OSCPUVirtualTimeMicroseconds 指标）。如果忙碌时间低于该值，则不会被视为 CPU 过载。

os_threads_nice_value_distributed_cache_tcp_handler

分布式缓存 TCP 处理器线程在 Linux 中的 nice 值。数值越低，CPU 优先级越高。

需要 CAP_SYS_NICE 权限，否则不生效。

取值范围：-20 到 19。

os_threads_nice_value_merge_mutate

用于合并和变更（mutation）线程的 Linux nice 值。值越小，CPU 优先级越高。

需要 CAP_SYS_NICE 权限，否则设置不会生效（no-op）。

可选值范围：-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 参数中配置该表的名称（见下文）。

以下设置可以通过子标签进行配置：

Setting	Description	Default	Note
`database`	数据库名称。
`table`	系统表名称。
`engine`	系统表的 MergeTree 引擎定义。		如果已定义 `partition_by` 或 `order_by`，则不能使用该设置。如果未指定，则默认选择 `MergeTree`
`partition_by`	系统表的自定义分区键。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `partition_by` 参数
`ttl`	指定表的 TTL。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `ttl` 参数
`order_by`	系统表的自定义排序键。如果已定义 `engine`，则不能使用该设置。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `order_by` 参数
`storage_policy`	要用于该表的存储策略名称（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `storage_policy` 参数
`settings`	控制 MergeTree 行为的额外参数（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `settings` 参数
`flush_interval_milliseconds`	将内存缓冲区中的数据刷新到表的时间间隔。	`7500`
`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

向 kill_delay_period 添加一个在 0 到 x 秒之间均匀分布的随机值，以避免在表数量非常多的情况下出现惊群效应，从而对 ZooKeeper 造成 DoS。仅在 ClickHouse Cloud 中可用。

parts_killer_pool_size

用于清理共享 MergeTree 中过期数据部件（parts）的线程数。仅在 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

前缀反序列化线程池中可调度的最大作业数。

注意

值为 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 系统表的设置。

以下设置可以通过子标签进行配置：

Setting	Description	Default	Note
`database`	数据库名称。
`table`	系统表名称。
`engine`	系统表的 MergeTree 引擎定义。		如果已定义 `partition_by` 或 `order_by`，则不能使用该设置。如果未指定，则默认选择 `MergeTree`
`partition_by`	系统表的自定义分区键。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `partition_by` 参数
`ttl`	指定表的 TTL。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `ttl` 参数
`order_by`	系统表的自定义排序键。如果已定义 `engine`，则不能使用该设置。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `order_by` 参数
`storage_policy`	要用于该表的存储策略名称（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `storage_policy` 参数
`settings`	控制 MergeTree 行为的额外参数（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `settings` 参数
`flush_interval_milliseconds`	将内存缓冲区中的数据刷新到表的时间间隔。	`7500`
`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 抓取的指标数据。

设置：

endpoint – Prometheus 服务器用于抓取指标的 HTTP endpoint，以 '/' 开头。
port – endpoint 使用的端口。
metrics – 暴露来自 system.metrics 表的指标。
events – 暴露来自 system.events 表的指标。
asynchronous_metrics – 暴露来自 system.asynchronous_metrics 表的当前指标值。
errors - 暴露自上次服务器重启以来按错误代码统计的错误数量。该信息同样可以从 system.errors 中获取。

示例

<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 函数支持该功能。

定义代理服务器有三种方式：

环境变量
代理列表
远程代理解析器

也支持通过使用 no_proxy 为特定主机绕过代理服务器。

Environment variables

http_proxy 和 https_proxy 环境变量允许为指定协议设置代理服务器。如果已在系统中配置，它应当可以无缝生效。

当某个协议只有一个代理服务器且该代理服务器不会变化时，这是最简单的方式。

Proxy lists

这种方式允许为某个协议指定一个或多个代理服务器。如果定义了多个代理服务器， ClickHouse 会以轮询（round-robin）的方式使用不同的代理，从而在服务器之间平衡负载。当某个协议有多个代理服务器且代理服务器列表不会变化时，这是最简单的方式。

Configuration template

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

在下方选项卡中选择一个父字段以查看其子字段：

<proxy>
<http> and <https>

字段	描述
`<http>`	一个或多个 HTTP 代理的列表
`<https>`	一个或多个 HTTPS 代理的列表

字段	描述
`<uri>`	代理的 URI

远程代理解析器（remote proxy resolvers）

代理服务器可能会动态变化。此时，可以为解析器（resolver）定义一个端点。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>

在下面的选项卡中选择一个父字段以查看其子字段：

<proxy>
<http> and <https>
<resolver>

字段	描述
`<http>`	一个或多个解析器的列表*
`<https>`	一个或多个解析器的列表*

字段	描述
`<resolver>`	解析器的端点及其他详细信息

注意

可以包含多个 <resolver> 元素，但对于某个给定协议，只会使用第一个 <resolver>。该协议的其他 <resolver> 元素会被忽略。这意味着（如有需要）负载均衡应由远程解析器实现。

字段	描述
`<endpoint>`	代理解析器的 URI
`<proxy_scheme>`	最终代理 URI 所使用的协议。可以是 `http` 或 `https`。
`<proxy_port>`	代理解析器的端口号
`<proxy_cache_time>`	ClickHouse 应缓存来自解析器的值的时间（秒）。将该值设置为 `0` 会导致 ClickHouse 针对每个 HTTP 或 HTTPS 请求都联系解析器。

优先顺序

代理设置按以下顺序确定：

顺序	设置
1.	远程代理解析器
2.	代理列表
3.	环境变量

ClickHouse 将根据请求协议检查优先级最高的解析器类型。若未定义，则会依次检查下一个优先级较高的解析器类型，直到检查到环境解析器为止。这也允许混合使用多种解析器类型。

query_cache

查询缓存配置。

支持以下设置：

Setting	Description	Default 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

查询条件缓存的最大容量。

注意

此设置可以在运行时修改，并会立即生效。

query_condition_cache_size_ratio

查询条件缓存中受保护队列的大小（在使用 SLRU 策略时），相对于该缓存总大小的比值。

query_log

在启用 log_queries=1 设置时，用于记录接收到的查询的相关配置。

查询会被记录到 system.query_log 表中，而不是单独的文件中。您可以通过 table 参数（见下文）更改该表的名称。

以下设置可以通过子标签进行配置：

Setting	Description	Default	Note
`database`	数据库名称。
`table`	系统表名称。
`engine`	系统表的 MergeTree 引擎定义。		如果已定义 `partition_by` 或 `order_by`，则不能使用该设置。如果未指定，则默认选择 `MergeTree`
`partition_by`	系统表的自定义分区键。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `partition_by` 参数
`ttl`	指定表的 TTL。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `ttl` 参数
`order_by`	系统表的自定义排序键。如果已定义 `engine`，则不能使用该设置。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `order_by` 参数
`storage_policy`	要用于该表的存储策略名称（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `storage_policy` 参数
`settings`	控制 MergeTree 行为的额外参数（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `settings` 参数
`flush_interval_milliseconds`	将内存缓冲区中的数据刷新到表的时间间隔。	`7500`
`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>

配置字段：

Setting	Description
`name`	规则名称（可选）
`regexp`	与 RE2 兼容的正则表达式（必需）
`replace`	用于替换敏感数据的字符串（可选，默认是六个星号）

掩码规则将应用于整个查询（以防止从格式错误 / 无法解析的查询中泄露敏感数据）。

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>

以下设置可以通过子标签进行配置：

Setting	Description	Default	Note
`database`	数据库名称。
`table`	系统表名称。
`engine`	系统表的 MergeTree 引擎定义。		如果已定义 `partition_by` 或 `order_by`，则不能使用该设置。如果未指定，则默认选择 `MergeTree`
`partition_by`	系统表的自定义分区键。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `partition_by` 参数
`ttl`	指定表的 TTL。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `ttl` 参数
`order_by`	系统表的自定义排序键。如果已定义 `engine`，则不能使用该设置。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `order_by` 参数
`storage_policy`	要用于该表的存储策略名称（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `storage_policy` 参数
`settings`	控制 MergeTree 行为的额外参数（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `settings` 参数
`flush_interval_milliseconds`	将内存缓冲区中的数据刷新到表的时间间隔。	`7500`
`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 参数更改该表的名称（见下文）。

以下设置可以通过子标签进行配置：

Setting	Description	Default	Note
`database`	数据库名称。
`table`	系统表名称。
`engine`	系统表的 MergeTree 引擎定义。		如果已定义 `partition_by` 或 `order_by`，则不能使用该设置。如果未指定，则默认选择 `MergeTree`
`partition_by`	系统表的自定义分区键。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `partition_by` 参数
`ttl`	指定表的 TTL。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `ttl` 参数
`order_by`	系统表的自定义排序键。如果已定义 `engine`，则不能使用该设置。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `order_by` 参数
`storage_policy`	要用于该表的存储策略名称（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `storage_policy` 参数
`settings`	控制 MergeTree 行为的额外参数（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `settings` 参数
`flush_interval_milliseconds`	将内存缓冲区中的数据刷新到表的时间间隔。	`7500`
`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 参数更改该表的名称（见下文）。

以下设置可以通过子标签进行配置：

Setting	Description	Default	Note
`database`	数据库名称。
`table`	系统表名称。
`engine`	系统表的 MergeTree 引擎定义。		如果已定义 `partition_by` 或 `order_by`，则不能使用该设置。如果未指定，则默认选择 `MergeTree`
`partition_by`	系统表的自定义分区键。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `partition_by` 参数
`ttl`	指定表的 TTL。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `ttl` 参数
`order_by`	系统表的自定义排序键。如果已定义 `engine`，则不能使用该设置。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `order_by` 参数
`storage_policy`	要用于该表的存储策略名称（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `storage_policy` 参数
`settings`	控制 MergeTree 行为的额外参数（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `settings` 参数
`flush_interval_milliseconds`	将内存缓冲区中的数据刷新到表的时间间隔。	`7500`
`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_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 属性的值，请参见“配置文件”部分。

另请参阅

remote_url_allow_hosts

在与 URL 相关的存储引擎和表函数中允许使用的主机列表。

在使用 \<host\> XML 标签添加主机时：

必须与 URL 中的写法完全一致，因为会在 DNS 解析之前检查名称。例如：<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 发送超时时间。如果未显式设置，则继承默认 profile 中的 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 系统表的相关设置。

以下设置可以通过子标签进行配置：

Setting	Description	Default	Note
`database`	数据库名称。
`table`	系统表名称。
`engine`	系统表的 MergeTree 引擎定义。		如果已定义 `partition_by` 或 `order_by`，则不能使用该设置。如果未指定，则默认选择 `MergeTree`
`partition_by`	系统表的自定义分区键。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `partition_by` 参数
`ttl`	指定表的 TTL。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `ttl` 参数
`order_by`	系统表的自定义排序键。如果已定义 `engine`，则不能使用该设置。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `order_by` 参数
`storage_policy`	要用于该表的存储策略名称（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `storage_policy` 参数
`settings`	控制 MergeTree 行为的额外参数（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `settings` 参数
`flush_interval_milliseconds`	将内存缓冲区中的数据刷新到表的时间间隔。	`7500`
`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:

Key	Description
`enabled`	用于启用此功能的布尔标志，默认值为 `true`。将其设置为 `false` 将不会发送崩溃报告。
`send_logical_errors`	`LOGICAL_ERROR` 类似于 `assert`，表示 ClickHouse 中的一个缺陷。此布尔标志用于启用发送这些异常（默认值：`true`）。
`endpoint`	你可以自定义用于发送崩溃报告的 endpoint URL。

推荐用法

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

series_keeper_path

Keeper 中带有由 generateSerialID 函数生成的自增编号的路径。每个 series 都将作为该路径下的一个节点。

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 文件中。

主机密钥配置默认处于未启用状态。取消注释主机密钥配置，并提供对应 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 定义了以下设置：

Setting	Description
`<disk_name_N>`	磁盘名称，必须唯一。
`path`	用于存储服务器数据（`data` 和 `shadow` 目录）的路径，必须以 `/` 结尾。
`keep_free_space_bytes`	磁盘上预留空闲空间的大小。

注意

磁盘的定义顺序无关紧要。

策略配置

上面的子标签为 policies 定义了以下设置：

Setting	Description
`policy_name_N`	策略名称。策略名称必须唯一。
`volume_name_N`	volume 名称。volume 名称必须唯一。
`disk`	位于该 volume 中的 disk。
`max_data_part_size_bytes`	可存储在该 volume 任一 disk 上的数据分片的最大大小。如果合并结果产生的分片大小预计会大于 `max_data_part_size_bytes`，该分片将被写入下一个 volume。此功能基本上允许你将新的 / 较小的分片存储在热（SSD）volume 上，并在它们达到较大尺寸时将其移动到冷（HDD）volume。如果策略只有一个 volume，请不要使用此选项。
`move_factor`	volume 上可用空闲空间的占比。如果空间少于该值，数据将开始转移到下一个 volume（如果存在）。在进行转移时，分片会按大小从大到小（降序）排序，并选择总大小足以满足 `move_factor` 条件的分片；如果所有分片的总大小仍不足，则会移动所有分片。
`perform_ttl_move_on_insert`	禁用在插入时移动已过期 TTL 的数据。默认情况下（启用时），如果插入的数据根据“按 TTL 移动”规则已经过期，则会立刻被移动到该移动规则中指定的 volume / disk。如果目标 volume / disk 较慢（例如 S3），这会显著降低插入速度。如果禁用，则已过期的数据部分会先写入默认 volume，然后立即根据针对已过期 TTL 的规则移动到指定的 volume。
`load_balancing`	disk 负载均衡策略，`round_robin` 或 `least_used`。
`least_used_ttl_ms`	设置更新时间间隔（毫秒）以刷新所有 disk 上的可用空间（`0` - 总是更新，`-1` - 从不更新，默认值为 `60000`）。注意，如果该 disk 仅由 ClickHouse 使用，且不会在运行时执行文件系统在线调整大小，则可以使用 `-1` 值。在所有其他情况下不推荐这样做，因为最终会导致空间分配不正确。
`prefer_not_to_merge`	禁用在该 volume 上合并数据分片。注意：这可能有害并导致变慢。当启用该设置时（不要这样做），禁止在此 volume 上合并数据（这很糟糕）。这允许控制 ClickHouse 如何与慢 disk 交互。我们建议完全不要使用此选项。
`volume_priority`	定义填充 volume 的优先级（顺序）。值越小，优先级越高。该参数值必须为自然数，并且需要在 1 到 N 的范围内连续覆盖（N 为指定的最大参数值），中间不得有缺失。

关于 volume_priority：

如果所有 volume 都设置了该参数，则会按照指定顺序确定优先级。
如果只为_部分_ volume 设置了该参数，则未设置的 volume 具有最低优先级。已设置的 volume 按参数值确定优先级，其余 volume 的优先级由它们在配置文件中的描述顺序相互之间决定。
如果_没有_任何 volume 设置该参数，则它们的顺序由在配置文件中的描述顺序决定。
volume 的优先级可以不同，不必相同。

storage_connections_soft_limit

超过此限制的连接，其存活时间会显著缩短。该限制适用于存储连接。

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 TABLE ENGINE ON TinyLog to user。

注意

默认情况下，为了向后兼容，使用特定表引擎创建表时会忽略权限检查，不过你可以通过将此项设置为 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。

示例

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

文本索引字典块缓存的大小（按条目数计）。0 表示禁用。

text_index_dictionary_block_cache_policy

文本索引字典块缓存策略的名称。

text_index_dictionary_block_cache_size

文本索引字典块的缓存大小。0 表示禁用。

注意

此设置可在运行时修改，并会立即生效。

text_index_dictionary_block_cache_size_ratio

文本索引字典块缓存中受保护队列（在使用 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 系统表的设置。

以下设置可以通过子标签进行配置：

Setting	Description	Default	Note
`database`	数据库名称。
`table`	系统表名称。
`engine`	系统表的 MergeTree 引擎定义。		如果已定义 `partition_by` 或 `order_by`，则不能使用该设置。如果未指定，则默认选择 `MergeTree`
`partition_by`	系统表的自定义分区键。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `partition_by` 参数
`ttl`	指定表的 TTL。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `ttl` 参数
`order_by`	系统表的自定义排序键。如果已定义 `engine`，则不能使用该设置。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `order_by` 参数
`storage_policy`	要用于该表的存储策略名称（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `storage_policy` 参数
`settings`	控制 MergeTree 行为的额外参数（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `settings` 参数
`flush_interval_milliseconds`	将内存缓冲区中的数据刷新到表的时间间隔。	`7500`
`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

定义在查询设置了 'workload' 时访问未知 WORKLOAD 的行为。

如果为 true，则对于尝试访问未知 WORKLOAD 的查询会抛出 RESOURCE_ACCESS_DENIED 异常。在建立 WORKLOAD 层级结构且其中包含 WORKLOAD default 之后，这对于强制所有查询都进行资源调度非常有用。
如果为 false（默认），则对带有指向未知 WORKLOAD 的 'workload' 设置的查询，在不进行资源调度的情况下提供无限制访问。这在设置 WORKLOAD 层级结构且尚未添加 WORKLOAD default 之前非常重要。

示例

<throw_on_unknown_workload>true</throw_on_unknown_workload>

另请参阅

工作负载调度

timezone

服务器的时区。

指定为 UTC 时区或地理位置的 IANA 标识符（例如：Africa/Abidjan）。

在将 DateTime 字段输出为文本格式（打印到屏幕或写入文件）以及从字符串解析 DateTime 时，进行 String 与 DateTime 格式的相互转换需要用到该时区。此外，当时间和日期相关的函数在输入参数中未显式接收时区时，也会使用该时区。

示例

<timezone>Asia/Istanbul</timezone>

另请参阅

session_timezone

tmp_path

本地文件系统上的路径，用于存储处理大规模查询时的临时数据。

注意

仅能使用以下选项之一来配置临时数据存储：tmp_path、tmp_policy、temporary_data_in_cache。
路径结尾必须带斜杠。

示例

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

tmp_policy

用于存储临时数据的策略。所有带有 tmp 前缀的文件将在启动时被删除。

注意

将对象存储用作 tmp_policy 时的建议：

在每台服务器上使用单独的 bucket:path
使用 metadata_type=plain
还可以考虑为该 bucket 设置 TTL

注意

配置临时数据存储时只能选择以下选项之一：tmp_path、tmp_policy、temporary_data_in_cache。
move_factor、keep_free_space_bytes、max_data_part_size_bytes 等设置会被忽略。
策略必须且只能包含 一个 volume

更多信息请参阅 MergeTree Table Engine 文档。

示例

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

每当服务器内存使用量超过下一个以字节为单位的步长时，内存分析器会收集当前内存分配的调用栈信息。零表示禁用内存分析器。取值低于数兆字节会降低服务器性能。

total_memory_tracker_sample_probability

允许以指定概率收集随机的内存分配和释放操作，并将其写入 system.trace_log 系统表中，此时 trace_type 等于 MemorySample。该概率应用于每一次分配或释放操作，与分配大小无关。请注意，仅当未跟踪内存量超过未跟踪内存上限时（默认值为 4 MiB）才会进行采样。如果降低 total_memory_profiler_step，则可以相应降低该上限。可以将 total_memory_profiler_step 设置为 1，以获得更精细的采样粒度。

可能的取值：

正的双精度浮点数。
0 — 禁用将随机分配和释放操作写入 system.trace_log 系统表。

trace_log

trace_log 系统表操作的相关设置。

以下设置可以通过子标签进行配置：

Setting	Description	Default	Note
`database`	数据库名称。
`table`	系统表名称。
`engine`	系统表的 MergeTree 引擎定义。		如果已定义 `partition_by` 或 `order_by`，则不能使用该设置。如果未指定，则默认选择 `MergeTree`
`partition_by`	系统表的自定义分区键。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `partition_by` 参数
`ttl`	指定表的 TTL。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `ttl` 参数
`order_by`	系统表的自定义排序键。如果已定义 `engine`，则不能使用该设置。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `order_by` 参数
`storage_policy`	要用于该表的存储策略名称（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `storage_policy` 参数
`settings`	控制 MergeTree 行为的额外参数（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `settings` 参数
`flush_interval_milliseconds`	将内存缓冲区中的数据刷新到表的时间间隔。	`7500`
`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 系列表引擎使用的未压缩数据的最大容量（字节）。

服务器上只有一个共享缓存。内存在需要时按需分配。仅在启用了 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 会对服务器上的所有表使用该设置。可以随时更改此设置。现有表在设置变更后会改变其行为。

对每个表分别设置

在创建表时，指定相应的引擎设置。已有表在设置后的行为不会改变，即便全局设置发生变化。

可能的取值

0 — 关闭该功能。
1 — 启用该功能。

如果 use_minimalistic_part_header_in_zookeeper = 1，则复制表会使用单个 znode 以紧凑形式存储数据分片头部信息。如果表包含大量列，此存储方式可以显著减少在 Zookeeper 中存储的数据量。

注意

在应用 use_minimalistic_part_header_in_zookeeper = 1 之后，无法将 ClickHouse 服务器降级到不支持此设置的版本。在集群中的服务器上升级 ClickHouse 时要小心。不要一次性升级所有服务器。更安全的做法是在测试环境或集群中的少量服务器上先测试新的 ClickHouse 版本。

已经使用此设置存储的数据分片头部信息无法恢复为之前的（非紧凑）表示形式。

user_defined_executable_functions_config

用于可执行用户自定义函数的配置文件路径。

路径：

指定绝对路径，或相对于服务器配置文件的相对路径。
路径中可以包含通配符 * 和 ?。

另请参阅：

"Executable User Defined Functions."。

示例

<user_defined_executable_functions_config>*_function.xml</user_defined_executable_functions_config>

user_defined_path

存放用户自定义文件的目录。用于 SQL 用户自定义函数，参见 SQL 用户自定义函数。

示例

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

user_directories

配置文件中包含以下设置的部分：

预定义用户配置文件的路径。
用于存储通过 SQL 命令创建的用户的文件夹路径。
用于存储并在 ZooKeeper 中复制通过 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>

用户、角色、行级策略、配额和配置文件也可以存储在 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 部分——表示将信息存储在 LDAP 服务器上。

要将 LDAP 服务器添加为未在本地定义用户的远程用户目录，请定义一个 ldap 部分，并包含以下设置：

Setting	Description
`server`	在 `ldap_servers` 配置节中定义的 LDAP 服务器名称之一。此参数为必填项，且不能为空。
`roles`	包含本地定义角色列表的配置节，这些角色将分配给从 LDAP 服务器检索到的每个用户。如果未指定任何角色，则用户在完成身份验证后将无法执行任何操作。如果在身份验证时，列出的任一角色尚未在本地定义，则此次身份验证尝试将失败，其表现与提供错误密码时相同。

示例

<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 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，则服务器会在启动时开始加载所有字典，并在加载的同时开始接收连接。当某个字典第一次在查询中被使用时，如果该字典尚未加载完成，则该查询会等待字典加载完成。将 wait_dictionaries_load_at_startup 设为 false 可以让 ClickHouse 启动更快，但某些查询可能会执行得更慢（因为它们必须等待某些字典加载完成）。

如果 wait_dictionaries_load_at_startup 为 true，则服务器在启动时会等待所有字典完成加载（无论是否成功）之后，再开始接收任何连接。

示例

<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 定义都作为这个单一 znode 的值进行存储。默认情况下不会使用 ZooKeeper，定义会存储在磁盘上。

示例

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

另请参阅

zookeeper

包含允许 ClickHouse 与 ZooKeeper 集群交互的设置。ClickHouse 在使用复制表（replicated tables）时，会使用 ZooKeeper 存储副本元数据。如果不使用复制表，可以省略本节参数。

以下设置可以通过子标签进行配置：

Setting	Description
`node`	ZooKeeper 端点。可以设置多个端点。例如：`<node index="1"><host>example_host</host><port>2181</port></node>`。`index` 属性指定在尝试连接 ZooKeeper 集群时节点的顺序。
`session_timeout_ms`	客户端会话的最大超时时间（毫秒）。
`operation_timeout_ms`	单次操作的最大超时时间（毫秒）。
`root` (optional)	被 ClickHouse 服务器用作其所使用 znodes 根节点的 znode。
`fallback_session_lifetime.min` (optional)	当主节点不可用（负载均衡）时，与回退节点之间 ZooKeeper 会话生命周期的最小限制。以秒为单位。默认值：3 小时。
`fallback_session_lifetime.max` (optional)	当主节点不可用（负载均衡）时，与回退节点之间 ZooKeeper 会话生命周期的最大限制。以秒为单位。默认值：6 小时。
`identity` (optional)	ZooKeeper 访问所请求 znodes 所需的用户名和密码。
`use_compression` (optional)	如果设置为 true，则在 Keeper 协议中启用压缩。

此外，还有 zookeeper_load_balancing 设置（可选），用于选择 ZooKeeper 节点的选择算法：

Algorithm Name	Description
`random`	随机选择一个 ZooKeeper 节点。
`in_order`	选择第一个 ZooKeeper 节点，如果该节点不可用，则选择第二个，依此类推。
`nearest_hostname`	选择主机名与服务器主机名最相似的 ZooKeeper 节点，主机名通过名称前缀进行比较。
`hostname_levenshtein_distance`	与 `nearest_hostname` 类似，但通过 Levenshtein 距离方式比较主机名。
`first_or_random`	选择第一个 ZooKeeper 节点，如果该节点不可用，则从剩余的 ZooKeeper 节点中随机选择一个。
`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 系统表的设置。

可以通过子标签对以下设置进行配置：

以下设置可以通过子标签进行配置：

Setting	Description	Default	Note
`database`	数据库名称。
`table`	系统表名称。
`engine`	系统表的 MergeTree 引擎定义。		如果已定义 `partition_by` 或 `order_by`，则不能使用该设置。如果未指定，则默认选择 `MergeTree`
`partition_by`	系统表的自定义分区键。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `partition_by` 参数
`ttl`	指定表的 TTL。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `ttl` 参数
`order_by`	系统表的自定义排序键。如果已定义 `engine`，则不能使用该设置。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `order_by` 参数
`storage_policy`	要用于该表的存储策略名称（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `storage_policy` 参数
`settings`	控制 MergeTree 行为的额外参数（可选）。		如果为系统表指定了 `engine`，则应在 `engine` 内部直接指定 `settings` 参数
`flush_interval_milliseconds`	将内存缓冲区中的数据刷新到表的时间间隔。	`7500`
`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>

abort_on_logical_error
access_control_improvements
access_control_path
aggregate_function_group_array_action_when_limit_is_reached
aggregate_function_group_array_max_element_size
allow_feature_tier
allow_impersonate_user
allow_implicit_no_password
allow_no_password
allow_plaintext_password
allow_use_jemalloc_memory
allowed_disks_for_table_engines
async_insert_queue_flush_on_shutdown
async_insert_threads
async_load_databases
async_load_system_database
asynchronous_heavy_metrics_update_period_s
asynchronous_insert_log
asynchronous_metric_log
asynchronous_metrics_enable_heavy_metrics
asynchronous_metrics_keeper_metrics_only
asynchronous_metrics_update_period_s
auth_use_forwarded_address
background_buffer_flush_schedule_pool_size
background_common_pool_size
background_distributed_schedule_pool_size
background_fetches_pool_size
background_merges_mutations_concurrency_ratio
background_merges_mutations_scheduling_policy
background_message_broker_schedule_pool_size
background_move_pool_size
background_pool_size
background_schedule_pool_max_parallel_tasks_per_type_ratio
background_schedule_pool_size
backup_log
backup_threads
backups
backups_io_thread_pool_queue_size
bcrypt_workfactor
blob_storage_log
builtin_dictionaries_reload_interval
cache_size_to_ram_max_ratio
cannot_allocate_thread_fault_injection_probability
cgroups_memory_usage_observer_wait_time
compiled_expression_cache_elements_size
compiled_expression_cache_size
压缩
concurrent_threads_scheduler
concurrent_threads_soft_limit_num
concurrent_threads_soft_limit_ratio_to_cores
config_reload_interval_ms
core_dump
cpu_slot_preemption
cpu_slot_preemption_timeout_ms
cpu_slot_quantum_ns
crash_log
custom_cached_disks_base_directory
custom_settings_prefixes
database_atomic_delay_before_drop_table_sec
database_catalog_drop_error_cooldown_sec
database_catalog_drop_table_concurrency
database_catalog_unused_dir_cleanup_period_sec
database_catalog_unused_dir_hide_timeout_sec
database_catalog_unused_dir_rm_timeout_sec
database_replicated_allow_detach_permanently
database_replicated_drop_broken_tables
dead_letter_queue
default_database
default_password_type
default_profile
default_replica_name
default_replica_path
default_session_timeout
dictionaries_config
dictionaries_lazy_load
dictionary_background_reconnect_interval
disable_insertion_and_mutation
disable_internal_dns_cache
disable_tunneling_for_https_requests_over_http_proxy
disk_connections_soft_limit
disk_connections_store_limit
disk_connections_warn_limit
display_secrets_in_show_and_select
distributed_cache_apply_throttling_settings_from_client
distributed_cache_keep_up_free_connections_ratio
distributed_ddl
distributed_ddl_use_initial_user_and_roles
dns_allow_resolve_names_to_ipv4
dns_allow_resolve_names_to_ipv6
dns_cache_max_entries
dns_cache_update_period
dns_max_consecutive_failures
drop_distributed_cache_pool_size
drop_distributed_cache_queue_size
enable_azure_sdk_logging
encryption
error_log
format_parsing_thread_pool_queue_size
format_schema_path
global_profiler_cpu_time_period_ns
global_profiler_real_time_period_ns
google_protos_path
graphite
graphite_rollup
hsts_max_age
http_connections_soft_limit
http_connections_store_limit
http_connections_warn_limit
http_handlers
http_options_response
http_server_default_response
iceberg_catalog_threadpool_pool_size
iceberg_catalog_threadpool_queue_size
iceberg_metadata_files_cache_max_entries
iceberg_metadata_files_cache_policy
iceberg_metadata_files_cache_size
iceberg_metadata_files_cache_size_ratio
ignore_empty_sql_security_in_create_view_query
include_from
index_mark_cache_policy
index_mark_cache_size
index_mark_cache_size_ratio
index_uncompressed_cache_policy
index_uncompressed_cache_size
index_uncompressed_cache_size_ratio
interserver_http_credentials
interserver_http_host
interserver_http_port
interserver_https_host
interserver_https_port
interserver_listen_host
io_thread_pool_queue_size
jemalloc_collect_global_profile_samples_in_trace_log
jemalloc_enable_background_threads
jemalloc_enable_global_profiler
jemalloc_flush_profile_interval_bytes
jemalloc_flush_profile_on_memory_exceeded
jemalloc_max_background_threads_num
keep_alive_timeout
keeper_hosts
keeper_multiread_batch_size
ldap_servers
license_key
listen_backlog
listen_host
listen_reuse_port
listen_try
load_marks_threadpool_pool_size
load_marks_threadpool_queue_size
logger
macros
mark_cache_policy
mark_cache_prewarm_ratio
mark_cache_size
mark_cache_size_ratio
max_active_parts_loading_thread_pool_size
max_authentication_methods_per_user
max_backup_bandwidth_for_server
max_backups_io_thread_pool_free_size
max_backups_io_thread_pool_size
max_build_vector_similarity_index_thread_pool_size
max_concurrent_insert_queries
max_concurrent_queries
max_concurrent_select_queries
max_connections
max_database_num_to_throw
max_database_num_to_warn
max_database_replicated_create_table_thread_pool_size
max_dictionary_num_to_throw
max_dictionary_num_to_warn
max_distributed_cache_read_bandwidth_for_server
max_distributed_cache_write_bandwidth_for_server
max_entries_for_hash_table_stats
max_fetch_partition_thread_pool_size
max_format_parsing_thread_pool_free_size
max_format_parsing_thread_pool_size
max_io_thread_pool_free_size
max_io_thread_pool_size
max_keep_alive_requests
max_local_read_bandwidth_for_server
max_local_write_bandwidth_for_server
max_materialized_views_count_for_table
max_merges_bandwidth_for_server
max_mutations_bandwidth_for_server
max_named_collection_num_to_throw
max_named_collection_num_to_warn
max_open_files
max_os_cpu_wait_time_ratio_to_drop_connection
max_outdated_parts_loading_thread_pool_size
max_part_num_to_warn
max_partition_size_to_drop
max_parts_cleaning_thread_pool_size
max_pending_mutations_execution_time_to_warn
max_pending_mutations_to_warn
max_prefixes_deserialization_thread_pool_free_size
max_prefixes_deserialization_thread_pool_size
max_remote_read_network_bandwidth_for_server
max_remote_write_network_bandwidth_for_server
max_replicated_fetches_network_bandwidth_for_server
max_replicated_sends_network_bandwidth_for_server
max_replicated_table_num_to_throw
max_server_memory_usage
max_server_memory_usage_to_ram_ratio
max_session_timeout
max_table_num_to_throw
max_table_num_to_warn
max_table_size_to_drop
max_temporary_data_on_disk_size
max_thread_pool_free_size
max_thread_pool_size
max_unexpected_parts_loading_thread_pool_size
max_view_num_to_throw
max_view_num_to_warn
max_waiting_queries
memory_worker_correct_memory_tracker
memory_worker_period_ms
memory_worker_use_cgroup
merge_tree
merge_workload
merges_mutations_memory_usage_soft_limit
merges_mutations_memory_usage_to_ram_ratio
metric_log
min_os_cpu_wait_time_ratio_to_drop_connection
mlock_executable
mmap_cache_size
mutation_workload
mysql_port
mysql_require_secure_transport
openSSL
opentelemetry_span_log
os_cpu_busy_time_threshold
os_threads_nice_value_distributed_cache_tcp_handler
os_threads_nice_value_merge_mutate
os_threads_nice_value_zookeeper_client_send_receive
page_cache_free_memory_ratio
page_cache_history_window_ms
page_cache_max_size
page_cache_min_size
page_cache_policy
page_cache_shards
page_cache_size_ratio
part_log
parts_kill_delay_period
parts_kill_delay_period_random_add
parts_killer_pool_size
path
postgresql_port
postgresql_require_secure_transport
prefetch_threadpool_pool_size
prefetch_threadpool_queue_size
prefixes_deserialization_thread_pool_thread_pool_queue_size
prepare_system_log_tables_on_startup
primary_index_cache_policy
primary_index_cache_prewarm_ratio
primary_index_cache_size
primary_index_cache_size_ratio
process_query_plan_packet
processors_profile_log
prometheus
proxy
query_cache
query_condition_cache_policy
query_condition_cache_size
query_condition_cache_size_ratio
query_log
query_masking_rules
query_metric_log
query_thread_log
query_views_log
remap_executable
remote_servers
remote_url_allow_hosts
replica_group_name
replicated_fetches_http_connection_timeout
replicated_fetches_http_receive_timeout
replicated_fetches_http_send_timeout
replicated_merge_tree
restore_threads
s3_credentials_provider_max_cache_size
s3_max_redirects
s3_retry_attempts
s3queue_disable_streaming
s3queue_log
send_crash_reports
series_keeper_path
show_addresses_in_stack_traces
shutdown_wait_backups_and_restores
shutdown_wait_unfinished
shutdown_wait_unfinished_queries
skip_binary_checksum_checks
ssh_server
startup_mv_delay_ms
storage_configuration
- 磁盘配置
- 策略配置
storage_connections_soft_limit
storage_connections_store_limit
storage_connections_warn_limit
storage_metadata_write_full_object_key
storage_shared_set_join_use_inner_uuid
table_engines_require_grant
tables_loader_background_pool_size
tables_loader_foreground_pool_size
tcp_close_connection_after_queries_num
tcp_close_connection_after_queries_seconds
tcp_port
tcp_port_secure
tcp_ssh_port
temporary_data_in_cache
temporary_data_in_distributed_cache
text_index_dictionary_block_cache_max_entries
text_index_dictionary_block_cache_policy
text_index_dictionary_block_cache_size
text_index_dictionary_block_cache_size_ratio
text_index_header_cache_max_entries
text_index_header_cache_policy
text_index_header_cache_size
text_index_header_cache_size_ratio
text_index_postings_cache_max_entries
text_index_postings_cache_policy
text_index_postings_cache_size
text_index_postings_cache_size_ratio
text_log
thread_pool_queue_size
threadpool_local_fs_reader_pool_size
threadpool_local_fs_reader_queue_size
threadpool_remote_fs_reader_pool_size
threadpool_remote_fs_reader_queue_size
threadpool_writer_pool_size
threadpool_writer_queue_size
throw_on_unknown_workload
timezone
tmp_path
tmp_policy
top_level_domains_list
total_memory_profiler_sample_max_allocation_size
total_memory_profiler_sample_min_allocation_size
total_memory_profiler_step
total_memory_tracker_sample_probability
trace_log
uncompressed_cache_policy
uncompressed_cache_size
uncompressed_cache_size_ratio
url_scheme_mappers
use_minimalistic_part_header_in_zookeeper
user_defined_executable_functions_config
user_defined_path
user_directories
user_files_path
user_scripts_path
users_config
validate_tcp_client_information
vector_similarity_index_cache_max_entries
vector_similarity_index_cache_policy
vector_similarity_index_cache_size
vector_similarity_index_cache_size_ratio
wait_dictionaries_load_at_startup
workload_path
workload_zookeeper_path
zookeeper
zookeeper_log

Was this page helpful?

abort_on_logical_error​

access_control_improvements​

access_control_path​

aggregate_function_group_array_action_when_limit_is_reached​

aggregate_function_group_array_max_element_size​

allow_feature_tier​

allow_impersonate_user​

allow_implicit_no_password​

allow_no_password​

allow_plaintext_password​

allow_use_jemalloc_memory​

allowed_disks_for_table_engines​

async_insert_queue_flush_on_shutdown​

async_insert_threads​

async_load_databases​

async_load_system_database​

asynchronous_heavy_metrics_update_period_s​

asynchronous_insert_log​

asynchronous_metric_log​

asynchronous_metrics_enable_heavy_metrics​

asynchronous_metrics_keeper_metrics_only​

asynchronous_metrics_update_period_s​

auth_use_forwarded_address​

background_buffer_flush_schedule_pool_size​

background_common_pool_size​

background_distributed_schedule_pool_size​

background_fetches_pool_size​

background_merges_mutations_concurrency_ratio​

background_merges_mutations_scheduling_policy​

background_message_broker_schedule_pool_size​

background_move_pool_size​

background_pool_size​

background_schedule_pool_max_parallel_tasks_per_type_ratio​

background_schedule_pool_size​

backup_log​

backup_threads​

backups​

backups_io_thread_pool_queue_size​

bcrypt_workfactor​

blob_storage_log​

builtin_dictionaries_reload_interval​

cache_size_to_ram_max_ratio​

cannot_allocate_thread_fault_injection_probability​

cgroups_memory_usage_observer_wait_time​

compiled_expression_cache_elements_size​

compiled_expression_cache_size​

压缩​

concurrent_threads_scheduler​

concurrent_threads_soft_limit_num​

concurrent_threads_soft_limit_ratio_to_cores​

config_reload_interval_ms​

core_dump​

cpu_slot_preemption​

cpu_slot_preemption_timeout_ms​

cpu_slot_quantum_ns​

crash_log​

custom_cached_disks_base_directory​

custom_settings_prefixes​

database_atomic_delay_before_drop_table_sec​

database_catalog_drop_error_cooldown_sec​

database_catalog_drop_table_concurrency​

database_catalog_unused_dir_cleanup_period_sec​

database_catalog_unused_dir_hide_timeout_sec​

database_catalog_unused_dir_rm_timeout_sec​

database_replicated_allow_detach_permanently​

database_replicated_drop_broken_tables​

dead_letter_queue​

default_database​

default_password_type​

default_profile​

default_replica_name​

default_replica_path​

default_session_timeout​

dictionaries_config​

dictionaries_lazy_load​

dictionary_background_reconnect_interval​

disable_insertion_and_mutation​

disable_internal_dns_cache​

disable_tunneling_for_https_requests_over_http_proxy​

disk_connections_soft_limit​

abort_on_logical_error

access_control_improvements

access_control_path

aggregate_function_group_array_action_when_limit_is_reached

aggregate_function_group_array_max_element_size

allow_feature_tier

allow_impersonate_user

allow_implicit_no_password

allow_no_password

allow_plaintext_password

allow_use_jemalloc_memory

allowed_disks_for_table_engines

async_insert_queue_flush_on_shutdown

async_insert_threads

async_load_databases

async_load_system_database

asynchronous_heavy_metrics_update_period_s

asynchronous_insert_log

asynchronous_metric_log

asynchronous_metrics_enable_heavy_metrics

asynchronous_metrics_keeper_metrics_only

asynchronous_metrics_update_period_s

auth_use_forwarded_address

background_buffer_flush_schedule_pool_size

background_common_pool_size

background_distributed_schedule_pool_size

background_fetches_pool_size

background_merges_mutations_concurrency_ratio

background_merges_mutations_scheduling_policy

background_message_broker_schedule_pool_size

background_move_pool_size

background_pool_size

background_schedule_pool_max_parallel_tasks_per_type_ratio

background_schedule_pool_size

backup_log

backup_threads

backups

backups_io_thread_pool_queue_size

bcrypt_workfactor

blob_storage_log

builtin_dictionaries_reload_interval

cache_size_to_ram_max_ratio

cannot_allocate_thread_fault_injection_probability

cgroups_memory_usage_observer_wait_time

compiled_expression_cache_elements_size

compiled_expression_cache_size

压缩

concurrent_threads_scheduler

concurrent_threads_soft_limit_num

concurrent_threads_soft_limit_ratio_to_cores

config_reload_interval_ms

core_dump

cpu_slot_preemption

cpu_slot_preemption_timeout_ms

cpu_slot_quantum_ns

crash_log

custom_cached_disks_base_directory

custom_settings_prefixes

database_atomic_delay_before_drop_table_sec

database_catalog_drop_error_cooldown_sec

database_catalog_drop_table_concurrency

database_catalog_unused_dir_cleanup_period_sec

database_catalog_unused_dir_hide_timeout_sec

database_catalog_unused_dir_rm_timeout_sec

database_replicated_allow_detach_permanently

database_replicated_drop_broken_tables

dead_letter_queue

default_database

default_password_type

default_profile

default_replica_name

default_replica_path

default_session_timeout

dictionaries_config

dictionaries_lazy_load

dictionary_background_reconnect_interval

disable_insertion_and_mutation

disable_internal_dns_cache

disable_tunneling_for_https_requests_over_http_proxy

disk_connections_soft_limit