Analyzer

在 ClickHouse 24.3 版本中，analyzer 默认处于启用状态。你可以在此处了解有关其工作原理的更多详情。自 26.9 版本起，analyzer 为强制启用：enable_analyzer 设置已废弃，将其设置为 0 的尝试会被拒绝，并且 ClickHouse 在 24.3 之前所使用的查询分析不再受支持。下面列出的不兼容项说明了旧版分析在行为上的差异，以便你更新为其编写的查询；若要观察旧版行为，请在低于 26.9 的 ClickHouse 版本上运行该查询。

已知不兼容项

尽管修复了大量 bug 并引入了新的优化，这也给 ClickHouse 的行为带来了一些破坏性变更。请阅读以下变更，了解如何为 analyzer 改写你的查询。

无效查询不再被优化

此前的查询规划基础设施会在查询验证之前先进行 AST 层级的优化。这些优化可能会将初始查询重写为有效且可执行的查询。在 analyzer 中，查询验证发生在优化之前。这意味着，过去原本还能执行的无效查询现在已不再受支持。在这种情况下，必须手动修复查询。

示例 1

以下查询在投影列表中使用了列 number，但聚合后只有 toString(number) 可用。在旧版 analyzer 中，GROUP BY toString(number) 会被优化为 GROUP BY number,，从而使该查询成为合法查询。

SELECT number
FROM numbers(1)
GROUP BY toString(number)

示例 2

这个查询也存在同样的问题。列 number 在聚合后又与另一个键一起使用。此前的查询分析器会将 number > 5 这个过滤条件从 HAVING 子句移到 WHERE 子句，从而修正这个查询。

SELECT
    number % 2 AS n,
    sum(number)
FROM numbers(10)
GROUP BY n
HAVING number > 5

要修正该查询，你应将所有针对非聚合列的条件移到 WHERE 子句中，以符合标准 SQL 语法：

SELECT
    number % 2 AS n,
    sum(number)
FROM numbers(10)
WHERE number > 5
GROUP BY n

作为迁移辅助，analyzer 可以对非聚合的 AND 合取项沿用旧版将 HAVING 重写到 WHERE 的方式。启用 analyzer_compatibility_allow_non_aggregate_in_having = 1 即可使用此行为。该设置自 ClickHouse 26.7 起可用。对于 WITH CUBE、WITH ROLLUP、WITH TOTALS 和 GROUPING SETS，该设置会被忽略。包含聚合、grouping 或非确定性函数的合取项会保留在 HAVING 中；如果任一合取项包含窗口函数或有状态函数 (例如 rowNumberInBlock) ，则整个 HAVING 的重写都会被禁用，这与旧版行为一致。

使用无效查询的 `CREATE VIEW`

analyzer 始终会执行类型检查。此前，可以使用无效的 SELECT 查询创建 VIEW。但这样会在首次执行 SELECT 或 INSERT 时失败 (对于 MATERIALIZED VIEW 而言) 。现在已无法再通过这种方式创建 VIEW。

示例

CREATE TABLE source (data String)
ENGINE=MergeTree
ORDER BY tuple();

CREATE VIEW some_view
AS SELECT JSONExtract(data, 'test', 'DateTime64(3)')
FROM source;

`JOIN` 子句的已知兼容性问题

在 `JOIN` 中使用投影中的列

默认情况下，SELECT 列表中的别名不能用作 JOIN USING 键。启用新设置 analyzer_compatibility_join_using_top_level_identifier 后，JOIN USING 的行为会改变：它会优先根据 SELECT 查询的投影列表中的表达式来解析标识符，而不是直接使用左侧表中的列。例如：

SELECT a + 1 AS b, t2.s
FROM VALUES('a UInt64, b UInt64', (1, 1)) AS t1
JOIN VALUES('b UInt64, s String', (1, 'one'), (2, 'two')) t2
USING (b);

当 analyzer_compatibility_join_using_top_level_identifier 设置为 true 时，join 条件会被解释为 t1.a + 1 = t2.b，与早期版本的行为一致。结果将为 2, 'two'。当该设置为 false 时，join 条件默认变为 t1.b = t2.b，查询将返回 2, 'one'。如果 b 在 t1 中不存在，查询将报错并失败。

`JOIN USING` 与 `ALIAS`/`MATERIALIZED` 列的行为变化

在 analyzer 中，对于涉及 ALIAS 或 MATERIALIZED 列的 JOIN USING 查询，若使用 *，默认会将这些列包含在结果集中。例如：

CREATE TABLE t1 (id UInt64, payload ALIAS sipHash64(id)) ENGINE = MergeTree ORDER BY id;
INSERT INTO t1 VALUES (1), (2);

CREATE TABLE t2 (id UInt64, payload ALIAS sipHash64(id)) ENGINE = MergeTree ORDER BY id;
INSERT INTO t2 VALUES (2), (3);

SELECT * FROM t1
FULL JOIN t2 USING (payload);

在 analyzer 中，此查询的结果将包含 payload 列，以及两个表中的 id。相比之下，旧版 analyzer 只有在启用特定设置 (asterisk_include_alias_columns 或 asterisk_include_materialized_columns) 时，才会包含这些 ALIAS 列，而且这些列的顺序可能不同。为确保结果一致且符合预期，尤其是在将旧查询迁移到 analyzer 时，建议在 SELECT 子句中显式指定列，而不是使用 *。

`USING` clause 中列的类型修饰符处理

在 analyzer 中，用于确定 USING clause 中指定列共同超类型的规则已统一，从而带来更可预测的结果，尤其是在处理 LowCardinality 和 Nullable 等类型修饰符时。

LowCardinality(T) 和 T：当类型为 LowCardinality(T) 的列与类型为 T 的列进行 join 时，最终得到的共同超类型将是 T，也就是说 LowCardinality 修饰符会被丢弃。
Nullable(T) 和 T：当类型为 Nullable(T) 的列与类型为 T 的列进行 join 时，最终得到的共同超类型将是 Nullable(T)，从而确保可空属性得以保留。

例如：

SELECT id, toTypeName(id)
FROM VALUES('id LowCardinality(String)', ('a')) AS t1
FULL OUTER JOIN VALUES('id String', ('b')) AS t2
USING (id);

在此查询中，id 的共同超类型被确定为 String，并且会忽略 t1 的 LowCardinality 修饰符。

投影列名变更

在计算投影列名时，不会展开别名。

SELECT
    1 + 1 AS x,
    x + 1
FORMAT PrettyCompact

在 24.3 之前，第二列以展开后的别名命名：

   ┌─x─┬─plus(plus(1, 1), 1)─┐
1. │ 2 │                   3 │
   └───┴─────────────────────┘

analyzer 会在列名中保留别名：

   ┌─x─┬─plus(x, 1)─┐
1. │ 2 │          3 │
   └───┴────────────┘

不兼容的函数参数类型

在 analyzer 中，类型推断发生在初始查询分析阶段。这一变更意味着，类型检查会在短路求值之前执行；因此，if 函数的参数必须始终具有共同超类型。例如，以下查询会失败，并报错：There is no supertype for types Array(UInt8), String because some of them are Array and some of them are not：

SELECT toTypeName(if(0, [2, 3, 4], 'String'))

异构集群

analyzer 显著改变了集群中服务器之间的通信协议。因此，无法在对是否使用 analyzer 未达成一致的服务器之间运行分布式查询——对于版本早于 26.9 的服务器集群而言，这意味着 enable_analyzer 设置值不同的服务器。版本为 26.10 或更新的服务器已不再保留其他查询分析方式，因此它会忽略较旧的发起服务器发送的值，一律使用 analyzer 来分析查询。两种分析方式对结果列的命名并不相同，而发起服务器是按列名来匹配 shard 返回的块的，因此此类查询可能在发起服务器上以 NOT_FOUND_COLUMN_IN_BLOCK 失败——例如查询中选择了以非规范大小写书写的函数 (hostname()) ，而 analyzer 会将其解析为规范名称 (hostName()) 。因此，仍在使用旧查询分析方式运行的集群，必须在其中任何一台服务器升级到 26.10 之前，在每台服务器上设置 enable_analyzer = 1。

不支持的功能

下面列出了 analyzer 当前不支持的功能：

Annoy 索引。
Hypothesis 索引。相关工作仍在进行中，见此处。

Cloud 迁移

我们正在所有当前禁用了 analyzer 的实例上启用该功能，以支持新的功能和性能优化。此变更会实施更严格的 SQL 作用域规则，因此客户需要手动更新不符合要求的查询。

迁移流程

使用 normalized_query_hash 过滤 system.query_log，以识别该查询：

SELECT query 
FROM clusterAllReplicas(default, system.query_log)
WHERE normalized_query_hash='{hash}' 
LIMIT 1 
SETTINGS skip_unavailable_shards=1

使用 analyzer 运行该查询，并在查询依赖旧解析行为时，添加可恢复旧版分析中标识符解析行为的兼容性设置。

SETTINGS
    analyzer_compatibility_join_using_top_level_identifier=1

重构并验证查询结果，确保其与该查询在迁移前生成的输出一致。

请参阅内部测试中最常见的不兼容问题。

未知的表达式标识符

错误：Unknown expression identifier ... in scope ... (UNKNOWN_IDENTIFIER)。异常代码：47 原因：依赖非标准、宽松旧版行为的查询 (例如在过滤器中引用计算出的别名、使用有歧义的子查询投影，或“动态” CTE 作用域) 现在会被正确识别为无效，并立即拒绝。解决方案：请按如下方式调整您的 SQL 写法：

过滤逻辑：如果是按结果过滤，请将逻辑从 WHERE 移到 HAVING；如果是按源数据过滤，请在 WHERE 中重复该表达式。
子查询作用域：显式选择外层查询所需的所有列。
JOIN 连接键：如果连接键是别名，请使用包含完整表达式的 ON，而不要使用 USING。
在外层查询中，请引用子查询/CTE 本身的别名，而不是其内部的表。

GROUP BY 中的非聚合列

错误：Column ... is not under aggregate function and not in GROUP BY keys (NOT_AN_AGGREGATE)。异常代码：215 原因：旧版 analyzer 允许选择未出现在 GROUP BY 子句中的列 (通常会任意取一个值) 。analyzer 遵循标准 SQL：每个选中的列都必须是聚合结果或分组键。解决方案：将该列包裹在 any()、argMax() 中，或将其添加到 GROUP BY 中。

/* 原始查询 */
-- device_id 存在歧义
SELECT user_id, device_id FROM table GROUP BY user_id

/* 修复后的查询 */
SELECT user_id, any(device_id) FROM table GROUP BY user_id
-- 或
SELECT user_id, device_id FROM table GROUP BY user_id, device_id

HAVING 中的非聚合列

错误：Column ... is not under aggregate function and not in GROUP BY keys (NOT_AN_AGGREGATE)。Exception code：215 原因：旧版 analyzer 会静默地将 HAVING 中不含聚合的 AND 合取项移到 WHERE，并将其视为聚合前过滤器。analyzer 遵循标准 SQL：HAVING 只能引用聚合键和聚合函数。解决方案：手动将谓词从 HAVING 移到 WHERE，或启用 analyzer_compatibility_allow_non_aggregate_in_having = 1 (自 ClickHouse 26.7 起可用) 以恢复旧版 Rewrite，作为迁移期间的辅助措施。对于 WITH CUBE、WITH ROLLUP、WITH TOTALS 和 GROUPING SETS，此兼容性设置会被忽略。包含聚合、grouping 或非确定性函数的连接条件会保留在 HAVING 中；如果任一连接条件包含窗口函数或有状态函数 (例如 rowNumberInBlock) ，则会禁用整个 HAVING 的重写，这与旧版行为一致。

/* ORIGINAL QUERY */
SELECT category, sum(value) FROM t GROUP BY category HAVING service = 'svc1';

/* FIXED QUERY */
SELECT category, sum(value) FROM t WHERE service = 'svc1' GROUP BY category;

重复的 CTE 名称

错误：CTE with name ... already exists (MULTIPLE_EXPRESSIONS_FOR_ALIAS)。异常代码：179 原因：旧版 analyzer 允许定义多个同名的公用表表达式 (WITH …) ，后定义的会遮蔽先定义的。新版 analyzer 默认拒绝这种有歧义的写法。解决方案：重命名重复的 CTE，确保名称唯一。作为迁移过渡手段，可以启用 analyzer_compatibility_allow_cte_redefinition = 1 (自 ClickHouse 26.10 起可用) 来恢复旧版行为：引用会绑定到该名称下当前未在解析中的最新定义，因此重新定义时可以读取前一个定义，而查询主体读取的是最后一个定义。限制：即使启用该设置，声明为 MATERIALIZED 的 CTE 以及 WITH RECURSIVE 子句中的 CTE 仍无法重新定义。另有一种形态与旧版 analyzer 的行为不同：在同一名称的两个定义之间声明的 CTE 也会绑定到最后一个定义，而旧版 analyzer 会将其绑定到其声明处可见的定义。

/* ORIGINAL QUERY */
WITH
  data AS (SELECT 1 AS id),
  data AS (SELECT id + 1 AS id FROM data) -- Redefined, reads the previous definition
SELECT * FROM data;

/* FIXED QUERY */
WITH
  raw_data AS (SELECT 1 AS id),
  processed_data AS (SELECT id + 1 AS id FROM raw_data)
SELECT * FROM processed_data;

/* LEGACY BEHAVIOR AS A MIGRATION AID */
WITH
  data AS (SELECT 1 AS id),
  data AS (SELECT id + 1 AS id FROM data)
SELECT * FROM data
SETTINGS analyzer_compatibility_allow_cte_redefinition = 1;

歧义列标识符

错误：JOIN [JOIN TYPE] ambiguous identifier ... (AMBIGUOUS_IDENTIFIER) Exception code: 207 原因：查询在 JOIN 中引用了多个表都包含的列名，但未指定来源表。旧版 analyzer 往往会根据内部逻辑猜测该列，而 analyzer 要求明确指定名称。解决方案：使用 table_alias.column_name 对该列进行完全限定。

/* 原始查询 */
SELECT table1.ID AS ID FROM table1, table2 WHERE ID...

/* 修复后的查询 */
SELECT table1.ID AS ID_RENAMED FROM table1, table2 WHERE ID_RENAMED...

FINAL 的错误用法

错误：Table expression modifiers FINAL are not supported for subquery... 或 Storage ... doesn't support FINAL (UNSUPPORTED_METHOD) 。Exception 代码：1、181 原因：FINAL 是用于表存储的 modifier (具体来说是 [Shared]ReplacingMergeTree) 。在以下情况下，analyzer 会拒绝 FINAL：

子查询或派生表 (例如，FROM (SELECT …) FINAL) 。
不支持 FINAL 的表引擎 (例如，SharedMergeTree) 。

解决方案：仅将 FINAL 应用于子查询内部的源表；如果该引擎不支持 FINAL，则将其移除。

/* 原始查询 */
SELECT * FROM (SELECT * FROM my_table) AS subquery FINAL ...

/* 修正后的查询 */
SELECT * FROM (SELECT * FROM my_table FINAL) AS subquery ...

`countDistinct()` 函数的大小写敏感性

错误：Function with name countdistinct does not exist (UNKNOWN_FUNCTION)。Exception code：46 原因：函数名区分大小写，或者在 analyzer 中会被严格映射。countdistinct (全小写) 不再会被自动解析。解决方案：请使用标准的 countDistinct (驼峰命名) 或 ClickHouse 特有的 uniq。

ClickHouse 指南

用例指南

已知不兼容项

无效查询不再被优化

示例 1

示例 2

使用无效查询的 `CREATE VIEW`

示例

`JOIN` 子句的已知兼容性问题

在 `JOIN` 中使用投影中的列

`JOIN USING` 与 `ALIAS`/`MATERIALIZED` 列的行为变化

`USING` clause 中列的类型修饰符处理

投影列名变更

不兼容的函数参数类型

异构集群

不支持的功能

Cloud 迁移

迁移流程

未知的表达式标识符

GROUP BY 中的非聚合列

HAVING 中的非聚合列

重复的 CTE 名称

歧义列标识符

FINAL 的错误用法

`countDistinct()` 函数的大小写敏感性

​已知不兼容项

​无效查询不再被优化

​示例 1

​示例 2

​使用无效查询的 CREATE VIEW

​示例

​JOIN 子句的已知兼容性问题

​在 JOIN 中使用投影中的列

​JOIN USING 与 ALIAS/MATERIALIZED 列的行为变化

​USING clause 中列的类型修饰符处理

​投影列名变更

​不兼容的函数参数类型

​异构集群

​不支持的功能

​Cloud 迁移

​迁移流程

​未知的表达式标识符

​GROUP BY 中的非聚合列

​HAVING 中的非聚合列

​重复的 CTE 名称

​歧义列标识符

​FINAL 的错误用法

​countDistinct() 函数的大小写敏感性

已知不兼容项

无效查询不再被优化

示例 1

示例 2

使用无效查询的 `CREATE VIEW`

示例

`JOIN` 子句的已知兼容性问题

在 `JOIN` 中使用投影中的列

`JOIN USING` 与 `ALIAS`/`MATERIALIZED` 列的行为变化

`USING` clause 中列的类型修饰符处理

投影列名变更

不兼容的函数参数类型

异构集群

不支持的功能

Cloud 迁移

迁移流程

未知的表达式标识符

GROUP BY 中的非聚合列

HAVING 中的非聚合列

重复的 CTE 名称

歧义列标识符

FINAL 的错误用法

`countDistinct()` 函数的大小写敏感性