预处理查询（PREPARED STATEMENT）的用途是用于高效地重复执行相同（或相似）SQL 语句，避免重复解析和构建计划。

• ByteHouse 企业版 2.5 及以上版本支持此特性。
• 功能需要在开启优化器（set enable_optimizer=1;）时才会生效。
• 预处理查询功能暂时只适用于Select查询语句。

PREPARED STATEMENT的基本语法包括下面四个 SQL 语句：

1. 创建预处理查询：CREATE [PERMANENT] PREPARED STATEMENT

   说明

   • 在创建时使用持久化关键字 PERMANENT，可以将 PREPARED STATEMENT 以文件的形式保存在磁盘中，在服务器重新启动后仍然会自动将 PREPARED STATEMENT构建的计划保存到内存中。
   • 如果在创建预处理查询时包含临时表（System 中有些表是临时表，StorageID 会改变），在服务器重新启动时，将无法对持久化的文件重新解析成计划。
2. 执行预处理查询：EXECUTE PREPARED STATEMENT
3. 查询已创建的预处理查询：SHOW PREPARED STATEMENT
4. 删除指定预处理查询：DROP PREPARED STATEMENT

   说明

   在执行删除时，如果目标是使用持久化关键字 PERMANENT 的预处理查询，则会将持久化的文件删除掉。

创建预处理查询 #

语法 #

-- 使用 PREPARE 语句定义查询模版
-- 强烈建议使用 PERMANENT
CREATE [PERMANENT] PREPARED STATEMENT [IF NOT EXISTS | OR REPLACE] name [ON CLUSTER cluster_name]
AS
select query with prepared_parameters;

示例 #

CREATE PERMANENT PREPARED STATEMENT prep1 ON CLUSTER sample_cluster
AS
SELECT count() 
FROM (SELECT number FROM system.numbers LIMIT 10)
WHERE number < [literal_name: DataType]; 
-- literal_name，常量名
-- DataType，常量参数类型

-- 具体示例
CREATE PERMANENT PREPARED STATEMENT prep1 AS
SELECT count()
FROM (SELECT number FROM system.numbers LIMIT 10)
WHERE number < [i: UInt32];

查询预处理查询 #

查看所有预处理查询 #

--查看所有 PREPARED STATEMENT
SHOW PREPARED STATEMENTS;

查看某个预处理查询的执行计划 #

--查看指定 PREPARED STATEMENT
EXPLAIN PREPARED STATEMENT prepared_name;

查看某个预处理查询的创建语句 #

--查看置顶 PREPARED STATEMENT 的创建语句
SHOW CREATE PREPARED STATEMENT prepared_name;

执行预处理查询 #

语法 #

使用 EXECUTE 语句执行查询模版，通过 USING 绑定 prepared params。

EXECUTE PREPARED STATEMENT fooplan USING literal1 = value1, literal2 = value2, ...

示例 #

CREATE PERMANENT PREPARED STATEMENT prep1 AS
SELECT count()
FROM (SELECT number FROM system.numbers LIMIT 10)
WHERE number < [i: UInt32];

-- 执行预处理查询
EXECUTE PREPARED STATEMENT prep1 USING i = 1;
EXECUTE PREPARED STATEMENT prep1 USING i = 5;
EXECUTE PREPARED STATEMENT prep1 USING foo = 'bar'; -- { serverError 4080 }
-- 类型不准确时，系统会报错。

设置项优先级 #

在执行 EXECUTE PREPARED STATEMENT 语句时，生效的 settings 包括以下几个来源（根据优先级从高到低）：

1. EXECUTE 语句的 setting；
2. 对应的 PREPARE 语句的 setting；
3. 当前 Session 中的 setting（通过命令行参数或 SET 语句设置，以及全局默认配置）；

下面这个例子说明了上述的优先级关系。

SET iterative_optimizer_timeout=111111;

CREATE PERMANENT PREPARED STATEMENT prep2 AS
SELECT value FROM system.settings WHERE name = 'iterative_optimizer_timeout';

CREATE PERMANENT PREPARED STATEMENT prep3 AS
SELECT value FROM system.settings WHERE name = 'iterative_optimizer_timeout'
SETTINGS iterative_optimizer_timeout=333333;

SET iterative_optimizer_timeout=222222;

EXECUTE PREPARED STATEMENT prep2; -- 执行结果为 222222
EXECUTE PREPARED STATEMENT prep3; -- 执行结果为 333333
EXECUTE PREPARED STATEMENT prep3 SETTINGS iterative_optimizer_timeout=444444; -- 执行结果为 444444

删除预处理查询 #

语法 #

-- 删除指定 PREPARED STATEMENT
DROP PREPARED STATEMENT [IF EXISTS] name [ON CLUSTER cluster_name];

示例 #