Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

system.dictionaries

View as MarkdownEdit this pageReport an issueSet up docs MCP

描述

包含字典的相关信息。

列

  • database (String) — 包含通过 DDL 查询创建的字典的数据库名称。其他字典为空字符串。
  • name (String) — 字典名称。
  • uuid (UUID) — 字典 UUID。
  • status (Enum8('NOT_LOADED' = 0, 'LOADED' = 1, 'FAILED' = 2, 'LOADING' = 3, 'FAILED_AND_RELOADING' = 4, 'LOADED_AND_RELOADING' = 5, 'NOT_EXIST' = 6)) — 字典状态。可能的值：NOT_LOADED — 字典当前未加载到内存中；LOADED — 字典已成功加载；FAILED — 因错误无法加载字典；LOADING — 字典正在加载；LOADED_AND_RELOADING — 字典已成功加载，当前正在重新加载 (常见原因：SYSTEM RELOAD DICTIONARY 查询、超时或字典配置发生变更) ；FAILED_AND_RELOADING — 因错误无法加载字典，当前正在加载。
  • origin (String) — 描述字典的配置文件路径。
  • type (String) — 字典分配类型。在内存中存储字典。
  • key.names (Array(String)) — 字典提供的键名称数组。
  • key.types (Array(String)) — 字典提供的对应键类型数组。
  • attribute.names (Array(String)) — 字典提供的属性名称数组。
  • attribute.types (Array(String)) — 字典提供的对应属性类型数组。
  • bytes_allocated (UInt64) — 为字典分配的 RAM 容量。
  • hierarchical_index_bytes_allocated (UInt64) — 为层级索引分配的 RAM 容量。
  • query_count (UInt64) — 自字典加载以来或自上次成功重启以来的查询数量。
  • hit_rate (Float64) — 对于缓存字典，命中缓存的使用次数百分比。
  • found_rate (Float64) — 找到值的使用次数百分比。
  • element_count (UInt64) — 字典中存储的元素数量。
  • load_factor (Float64) — 字典的填充率 (对于 hashed 字典，则为哈希表的填充率) 。
  • source (String) — 描述字典数据源的文本。
  • lifetime_min (UInt64) — 字典在内存中的最短存活时间，超过该时间后 ClickHouse 会尝试重新加载字典 (如果设置了 invalidate_query，则仅在字典发生变更时重新加载) 。单位为秒。
  • lifetime_max (UInt64) — 字典在内存中的最长存活时间，超过该时间后 ClickHouse 会尝试重新加载字典 (如果设置了 invalidate_query，则仅在字典发生变更时重新加载) 。单位为秒。
  • loading_start_time (DateTime) — 开始加载字典的时间。
  • last_successful_update_time (DateTime) — 字典加载或更新完成的时间。有助于监控字典源问题并排查原因。
  • error_count (UInt64) — 自上次成功加载以来的错误数量。有助于监控字典源问题并排查原因。
  • loading_duration (Float32) — 字典加载耗时。
  • last_exception (String) — 无法创建字典时，创建或重新加载字典过程中发生的错误文本。
  • comment (String) — 字典的注释文本。

示例

配置字典：

CREATE DICTIONARY dictionary_with_comment
(
    id UInt64,
    value String
)
PRIMARY KEY id
SOURCE(CLICKHOUSE(HOST 'localhost' PORT tcpPort() TABLE 'source_table'))
LAYOUT(FLAT())
LIFETIME(MIN 0 MAX 1000)
COMMENT 'The temporary dictionary';

确保字典已加载。

SELECT * FROM system.dictionaries LIMIT 1 FORMAT Vertical;
Row 1:
──────
database:                    default
name:                        dictionary_with_comment
uuid:                        4654d460-0d03-433a-8654-d4600d03d33a
status:                      NOT_LOADED
origin:                      4654d460-0d03-433a-8654-d4600d03d33a
type:
key.names:                   ['id']
key.types:                   ['UInt64']
attribute.names:             ['value']
attribute.types:             ['String']
bytes_allocated:             0
query_count:                 0
hit_rate:                    0
found_rate:                  0
element_count:               0
load_factor:                 0
source:
lifetime_min:                0
lifetime_max:                0
loading_start_time:          1970-01-01 00:00:00
last_successful_update_time: 1970-01-01 00:00:00
loading_duration:            0
last_exception:
comment:                     The temporary dictionary
Navigation