SYSTEM 语句
SYSTEM RELOAD EMBEDDED DICTIONARIES
重新加载所有内部字典。
默认情况下,内部字典处于禁用状态。
无论内部字典更新结果如何,此命令始终返回 Ok.。
SYSTEM RELOAD DICTIONARIES
SYSTEM RELOAD DICTIONARIES 查询会重新加载状态为 LOADED 的字典(参见 system.dictionaries 的 status 列),即此前已成功加载的字典。
默认情况下,字典采用延迟加载方式(参见 dictionaries_lazy_load),因此不会在启动时自动加载,而是在第一次访问时才初始化,例如通过调用 dictGet 函数,或在对 ENGINE = Dictionary 的表执行 SELECT 查询时加载。
语法
SYSTEM RELOAD DICTIONARY
无论字典 dictionary_name 当前状态(LOADED / NOT_LOADED / FAILED)如何,完全重新加载该字典。
无论字典更新结果如何,始终返回 Ok.。
可以通过查询 system.dictionaries 表来检查字典的状态。
SYSTEM RELOAD MODELS
此语句和 SYSTEM RELOAD MODEL 仅从 clickhouse-library-bridge 中卸载 CatBoost 模型。函数 catboostEvaluate() 在首次被调用且相应模型尚未加载时会加载该模型。
卸载所有 CatBoost 模型。
语法
SYSTEM RELOAD MODEL
重新加载位于 model_path 的 CatBoost 模型。
语法
SYSTEM RELOAD FUNCTIONS
从配置文件中重新加载所有已注册的可执行用户定义函数或其中任一函数。
语法
SYSTEM RELOAD ASYNCHRONOUS METRICS
重新计算所有异步指标。由于异步指标会基于配置项 asynchronous_metrics_update_period_s 定期更新,通常无需使用此语句手动更新。
SYSTEM DROP DNS CACHE
清除 ClickHouse 的内部 DNS 缓存。在更改基础设施时(例如更改另一个 ClickHouse 服务器的 IP 地址或字典所使用的服务器),有时需要使用此命令(适用于旧版本的 ClickHouse)。
要实现更便捷的(自动)缓存管理,请参阅 disable_internal_dns_cache、dns_cache_max_entries、dns_cache_update_period 参数。
SYSTEM DROP MARK CACHE
清空标记缓存。
SYSTEM DROP ICEBERG METADATA CACHE
清除 Iceberg 元数据缓存。
SYSTEM DROP TEXT INDEX DICTIONARY CACHE
清除文本索引字典缓存。
SYSTEM DROP TEXT INDEX HEADER CACHE
清空文本索引头缓存。
SYSTEM DROP TEXT INDEX POSTINGS CACHE
清除文本索引的倒排索引缓存。
SYSTEM DROP TEXT INDEX CACHES
清除文本索引头缓存、字典缓存和倒排索引缓存。
SYSTEM DROP REPLICA
可以使用以下语法删除 ReplicatedMergeTree 表的失效副本:
这些查询将在 ZooKeeper 中移除 ReplicatedMergeTree 副本路径。当某个副本已经失效且由于对应的表已经不存在而无法通过 DROP TABLE 从 ZooKeeper 中删除其元数据时,这非常有用。它只会删除非活跃/陈旧的副本,无法删除本地副本,如需删除本地副本请使用 DROP TABLE。DROP REPLICA 不会删除任何表,也不会从磁盘移除任何数据或元数据。
第一个查询会移除 database.table 表中 'replica_name' 副本的元数据。
第二个查询会对数据库中所有复制表执行相同的操作。
第三个查询会对本地服务器上的所有复制表执行相同的操作。
第四个查询用于在某个表的所有其他副本都已被删除后,移除失效副本的元数据。它要求显式指定表路径,该路径必须与创建表时传递给 ReplicatedMergeTree 引擎第一个参数的路径相同。
SYSTEM DROP DATABASE REPLICA
可以使用以下语法删除 Replicated 数据库的失效副本:
类似于 SYSTEM DROP REPLICA,但用于在无法运行 DROP DATABASE 时,从 ZooKeeper 中移除 Replicated 数据库副本路径。请注意,它不会移除 ReplicatedMergeTree 副本(因此可能还需要执行 SYSTEM DROP REPLICA)。分片名称和副本名称是创建数据库时在 Replicated 引擎参数中指定的名称。此外,这些名称也可以从 system.clusters 中的 database_shard_name 和 database_replica_name 列中获取。如果缺少 FROM SHARD 子句,则 replica_name 必须是 shard_name|replica_name 格式的完整副本名称。
SYSTEM DROP UNCOMPRESSED CACHE
清空未压缩数据缓存。
未压缩数据缓存可通过查询/用户/配置文件级别的设置 use_uncompressed_cache 启用或禁用。
可以使用服务器级别设置 uncompressed_cache_size 配置其大小。
SYSTEM DROP COMPILED EXPRESSION CACHE
清除编译表达式缓存。
可以通过查询、用户或配置文件级别的设置 compile_expressions 启用或禁用编译表达式缓存。
SYSTEM DROP QUERY CONDITION CACHE
清空查询条件缓存。
SYSTEM DROP QUERY CACHE
清空查询缓存。 如果指定了标签,则只删除具有该标签的查询缓存项。
SYSTEM DROP FORMAT SCHEMA CACHE
清空从 format_schema_path 加载的 schema 缓存。
支持的目标:
- Protobuf: 从内存中移除已导入的 Protobuf 消息定义。
- Files: 删除本地存储在
format_schema_path中的缓存 schema 文件,这些文件是在format_schema_source设置为query时生成的。 注意: 如果未指定目标,则会清空这两类缓存。
SYSTEM FLUSH LOGS
将缓冲的日志消息刷新到系统表中,例如 system.query_log。主要用于调试,因为大多数系统表的默认刷新间隔为 7.5 秒。 即使消息队列为空,此操作也会创建相应的系统表。
如果您不想刷新全部日志,可以通过传入日志名称或其目标表来刷新一个或多个单独的日志:
SYSTEM RELOAD CONFIG
重新加载 ClickHouse 配置。用于配置存储在 ZooKeeper 中的场景。请注意,SYSTEM RELOAD CONFIG 不会重新加载存储在 ZooKeeper 中的 USER 配置,它只会重新加载存储在 users.xml 中的 USER 配置。要重新加载所有 USER 配置,请使用 SYSTEM RELOAD USERS
SYSTEM RELOAD USERS
重新加载所有访问存储,包括 users.xml、本地磁盘访问存储以及基于 ZooKeeper 的复制访问存储。
SYSTEM SHUTDOWN
正常关闭 ClickHouse(类似于 service clickhouse-server stop / kill {$pid_clickhouse-server})
SYSTEM KILL
中止 ClickHouse 进程(类似于执行 kill -9 {$ pid_clickhouse-server})
SYSTEM INSTRUMENT
使用 ClickHouse 在构建时启用 ENABLE_XRAY=1 后可用的 LLVM XRay 功能来管理插桩点。
这使您能够在生产环境中进行调试和性能分析,而无需修改源代码,并且只带来极小的开销。
当未添加任何插桩点时,性能损耗可以忽略不计,因为它只是在长度超过 200 条指令的函数入口和出口处额外增加一次跳转到附近地址的指令。
SYSTEM INSTRUMENT ADD
添加一个新的检测点。已插桩的函数可以在 system.instrumentation 系统表中查看。可以为同一个函数添加多个处理器(handler),它们会按照添加检测点的顺序依次执行。
要插桩的函数可以从 system.symbols 系统表中收集。
可以为函数添加三种不同类型的处理器:
语法
其中 FUNCTION 可以是任意函数或其子字符串,例如 QueryMetricLog::startQuery,而处理器则是下列选项之一
LOG
在函数的 ENTRY 或 EXIT 处打印作为参数传入的文本和调用栈。
SLEEP
在 ENTRY 或 EXIT 时休眠指定的固定秒数:
或者指定一个在最小值和最大值之间均匀分布的随机秒数,这两个值以空格分隔:
PROFILE
测量函数从 ENTRY 到 EXIT 之间的耗时。
分析结果存储在 system.trace_log 中,并可转换为
Chrome Event Trace Format。
SYSTEM INSTRUMENT REMOVE
用于移除单个检测点:
它们都使用 ALL 参数:
或由子查询返回的一组 ID:
可以从 system.instrumentation 系统表中获取检测点 ID。
管理分布式表
ClickHouse 可以管理分布式表。当用户向这些表中插入数据时,ClickHouse 会先创建一个队列,用于存放需要发送到集群节点的数据,然后再异步发送。可以使用 STOP DISTRIBUTED SENDS、FLUSH DISTRIBUTED 和 START DISTRIBUTED SENDS 查询来管理队列处理。也可以通过 distributed_foreground_insert 设置以同步方式插入分布式数据。
SYSTEM STOP DISTRIBUTED SENDS
在向分布式表插入数据时禁用后台数据分发。
如果启用了 prefer_localhost_replica(默认设置),数据仍然会被插入到本地分片中。
SYSTEM FLUSH DISTRIBUTED
强制 ClickHouse 同步向集群节点发送数据。如果任一节点不可用,ClickHouse 会抛出异常并停止执行查询。您可以反复重试该查询,直到其成功执行,即所有节点重新上线时。
您还可以通过 SETTINGS 子句覆盖某些设置,这在需要绕过暂时性限制时很有用,例如 max_concurrent_queries_for_all_users 或 max_memory_usage。
每个待处理块都会按照初始 INSERT 查询中的设置存储到磁盘上,因此有时你可能需要覆盖这些设置。
SYSTEM START DISTRIBUTED SENDS
启用在向分布式表插入数据时的后台数据分发。
SYSTEM STOP LISTEN
关闭套接字,并在指定端口和指定协议上优雅地终止到服务器的现有连接。
但是,如果在 clickhouse-server 配置中未指定相应的协议设置,则此命令不会生效。
- 如果指定了
CUSTOM 'protocol'修饰符,将停止服务器配置的protocols部分中定义的具有该名称的自定义协议。 - 如果指定了
QUERIES ALL [EXCEPT .. [,..]]修饰符,则会停止所有协议,EXCEPT子句中指定的除外。 - 如果指定了
QUERIES DEFAULT [EXCEPT .. [,..]]修饰符,则会停止所有默认协议,EXCEPT子句中指定的除外。 - 如果指定了
QUERIES CUSTOM [EXCEPT .. [,..]]修饰符,则会停止所有自定义协议,EXCEPT子句中指定的除外。
SYSTEM START LISTEN
允许在指定协议上建立新连接。
但是,如果指定端口和协议上的服务器并不是通过 SYSTEM STOP LISTEN 命令停止的,则此命令不会产生任何效果。
管理 MergeTree 表
ClickHouse 可以管理 MergeTree 表中的后台进程。
SYSTEM STOP MERGES
用于停止 MergeTree 系列表的后台合并操作:
即使之前已为所有 MergeTree 表停止合并,执行 DETACH / ATTACH 表操作仍会为该表启动后台合并。
SYSTEM START MERGES
用于为 MergeTree 系列表启动后台合并操作:
SYSTEM STOP TTL MERGES
用于停止 MergeTree 系列表中根据 TTL expression 执行的后台旧数据删除操作:
即使表不存在或表不是 MergeTree 引擎表,也会返回 Ok.。如果数据库不存在则返回错误:
SYSTEM START TTL MERGES
为 MergeTree 系列表提供一种方式,可根据 TTL expression 启动后台任务以删除旧数据。
即使表不存在也返回 Ok.。当数据库不存在时返回错误。
SYSTEM STOP MOVES
用于停止 MergeTree 系列表中依据 带有 TO VOLUME 或 TO DISK 子句的表级生存时间 (TTL) 表达式 执行的后台数据移动:
即使表不存在也返回 Ok.。当数据库不存在时返回错误:
SYSTEM START MOVES
提供根据 带有 TO VOLUME 和 TO DISK 子句的表的生存时间 (TTL) 表达式,为 MergeTree 家族中的表启动后台数据移动的功能。
即使表不存在也会返回 Ok.。当数据库不存在时会返回错误:
SYSTEM SYSTEM UNFREEZE
从所有磁盘中清除具有指定名称的冻结备份。有关对单个分区片段解除冻结的更多信息,请参阅 ALTER TABLE table_name UNFREEZE WITH NAME
SYSTEM WAIT LOADING PARTS
等待表的所有异步加载数据分区(过时的数据分区)完成加载。
管理 ReplicatedMergeTree 表
ClickHouse 可以管理 ReplicatedMergeTree 表中与后台复制相关的进程。
SYSTEM STOP FETCHES
用于停止 ReplicatedMergeTree 系列表中已插入分区片段的后台拉取操作。
无论表引擎类型如何,即使表或数据库不存在,也始终返回 Ok.。
SYSTEM START FETCHES
提供一种机制,用于为 ReplicatedMergeTree 系列表中已插入的分区片段启动后台抓取操作:
无论表引擎类型如何,即使表或数据库不存在,该语句也始终返回 Ok.。
SYSTEM STOP REPLICATED SENDS
可用于停止在集群中,将 ReplicatedMergeTree 系列表中新插入的分区片段后台发送到其他副本的操作:
SYSTEM START REPLICATED SENDS
提供启动向集群中其他副本发送 ReplicatedMergeTree 系列表中新插入数据分片的后台发送功能:
SYSTEM STOP REPLICATION QUEUES
用于停止存储在 ZooKeeper 中、针对 ReplicatedMergeTree 家族表的复制队列中的后台拉取任务。可能的后台任务类型包括:合并、拉取、变更操作,以及带有 ON CLUSTER 子句的 DDL 语句:
SYSTEM START REPLICATION QUEUES
用于启动 ReplicatedMergeTree 系列表在 ZooKeeper 中复制队列里的后台任务。可启动的后台任务类型包括:合并、拉取、变更、带有 ON CLUSTER 子句的 DDL 语句:
SYSTEM STOP PULLING REPLICATION LOG
停止在 ReplicatedMergeTree 表中将复制日志中的新记录加载到复制队列中。
SYSTEM START PULLING REPLICATION LOG
取消 SYSTEM STOP PULLING REPLICATION LOG。
SYSTEM SYNC REPLICA
等待 ReplicatedMergeTree 表与集群中的其他副本同步,但不超过 receive_timeout 秒。
运行此语句后,[db.]replicated_merge_tree_family_table_name 会将通用复制日志中的命令拉取到自身的复制队列中,然后查询会一直等待,直到该副本处理完所有已拉取的命令。支持以下修饰符:
- 使用
IF EXISTS(自 25.6 起可用)时,如果表不存在,查询不会抛出错误。这在向集群中添加新副本时很有用:即使该副本已在集群配置中,但仍处于创建和同步表的过程中。 - 如果指定了
STRICT修饰符,则查询会等待复制队列变为空。如果复制队列中持续有新条目出现,STRICT版本可能永远不会成功完成。 - 如果指定了
LIGHTWEIGHT修饰符,则查询只会等待GET_PART、ATTACH_PART、DROP_RANGE、REPLACE_RANGE和DROP_PART条目被处理。 此外,LIGHTWEIGHT 修饰符支持可选的 FROM 'srcReplicas' 子句,其中 'srcReplicas' 是以逗号分隔的源副本名称列表。该扩展通过仅关注来自指定源副本的复制任务,实现更有针对性的同步。 - 如果指定了
PULL修饰符,则查询会从 ZooKeeper 中拉取新的复制队列条目,但不会等待这些条目被处理。
SYNC DATABASE REPLICA
等待直到指定的复制数据库将该数据库 DDL 队列中的所有模式变更全部应用完成。
语法
SYSTEM RESTART REPLICA
允许重新初始化 ReplicatedMergeTree 表的 ZooKeeper 会话状态,会将当前状态与作为真实数据源的 ZooKeeper 进行比较,并在需要时向 ZooKeeper 队列中添加任务。
基于 ZooKeeper 数据初始化复制队列的过程与执行 ATTACH TABLE 语句时相同。在短时间内,该表将无法执行任何操作。
SYSTEM RESTORE REPLICA
在数据[可能]仍然存在但 Zookeeper 元数据丢失的情况下恢复副本。
仅适用于只读的 ReplicatedMergeTree 表。
可以在以下情况之后执行该查询:
- ZooKeeper 根路径
/丢失。 - 副本路径
/replicas丢失。 - 单个副本路径
/replicas/replica_name/丢失。
副本会挂载本地找到的分区片段,并将其相关信息发送到 Zookeeper。 在元数据丢失前已存在于副本上的分区片段,如果尚未过期,则不会从其他副本重新获取(因此恢复副本并不意味着需要通过网络重新下载所有数据)。
所有状态的数据分片都会被移动到 detached/ 目录中。数据丢失前处于活动状态(已提交)的分区片段会被重新挂载。
SYSTEM RESTORE DATABASE REPLICA
当数据[可能]仍然存在但 ZooKeeper 元数据已丢失时,用于恢复数据库副本。
语法
示例
语法
替代语法:
示例
在多个服务器上创建一张表。当 ZooKeeper 中副本的元数据丢失时,由于缺少元数据,此时该表会被附加为只读表。最后一个查询需要在每个副本上执行。
另一种方式:
SYSTEM RESTART REPLICAS
可用于为所有 ReplicatedMergeTree 表重新初始化 ZooKeeper 会话状态,会将当前状态与作为权威来源的 ZooKeeper 状态进行比较,并在需要时向 ZooKeeper 队列中添加任务。
SYSTEM DROP FILESYSTEM CACHE
用于清除文件系统缓存。
SYSTEM SYNC FILE CACHE
此操作开销较大,存在被误用的风险。
将执行 sync 系统调用。
SYSTEM LOAD PRIMARY KEY
加载指定表或所有表的主键。
SYSTEM UNLOAD PRIMARY KEY
取消为指定表或所有表加载的主键。
管理可刷新 materialized view
用于控制可刷新 materialized view所执行后台任务的命令。
在使用过程中,请留意 system.view_refreshes。
SYSTEM REFRESH VIEW
触发一次对指定 VIEW 的计划外立即刷新。
SYSTEM WAIT VIEW
等待当前正在执行的刷新操作完成。如果刷新失败,将抛出异常。如果当前没有刷新在运行,则立即结束;如果上一次刷新失败,则抛出异常。
SYSTEM STOP [REPLICATED] VIEW, STOP VIEWS
禁用指定 VIEW 或所有支持刷新的 VIEW 的周期性刷新。如果刷新正在进行中,也会同时将其取消。
如果 VIEW 位于 Replicated 或 Shared 数据库中,STOP VIEW 只影响当前副本,而 STOP REPLICATED VIEW 会影响所有副本。
SYSTEM START [REPLICATED] VIEW, START VIEWS
为指定的 VIEW 或所有可刷新的 VIEW 启用周期性刷新,但不会触发立即刷新。
如果 VIEW 位于 Replicated 或 Shared 数据库中,START VIEW 会撤销 STOP VIEW 的效果,START REPLICATED VIEW 会撤销 STOP REPLICATED VIEW 的效果。
SYSTEM CANCEL VIEW
如果当前副本上的指定 VIEW 正在刷新,则中断并取消刷新操作;否则不执行任何操作。
SYSTEM WAIT VIEW
等待正在运行的刷新完成。如果没有刷新正在运行,则立即返回。如果最近一次刷新尝试失败,则报告错误。
可在创建新的可刷新materialized view(未使用 EMPTY 关键字)之后立即使用,以等待初始刷新完成。
如果该 VIEW 位于 Replicated 或 Shared 数据库中,并且刷新在另一副本上运行,则会等待该刷新完成。