存储过程（Stored Procedure）与 SQL 脚本

Databend 中的存储过程（Stored Procedure）允许您将 SQL 逻辑打包在服务器上运行，并支持控制流（Control Flow）、变量（Variable）、游标（Cursor）和动态语句（Dynamic Statement）。本页面介绍如何创建存储过程以及编写驱动它们的内联脚本。

定义存储过程

CREATE [OR REPLACE] PROCEDURE <name>(<param_name> <data_type>, ...)
RETURNS <return_type> [NOT NULL]
LANGUAGE SQL
[COMMENT = '<text>']
AS $$
BEGIN
    -- 声明和语句
    RETURN <scalar_value>;
    -- 或返回查询结果
    -- RETURN TABLE(<select_query>);
END;
$$;

组件	描述
`<name>`	存储过程的标识符。模式限定是可选的。
`<param_name> <data_type>`	使用 Databend 标量类型定义的输入参数（Parameter）。参数按值传递。
`RETURNS <return_type> [NOT NULL]`	声明逻辑返回类型。`NOT NULL` 强制返回非空响应。
`LANGUAGE SQL`	Databend 目前仅接受 `SQL`。
`RETURN` / `RETURN TABLE`	结束执行并提供标量或表格结果。

使用 CREATE PROCEDURE 持久化定义，使用 CALL 运行它，使用 DROP PROCEDURE 删除它。

最小示例

CREATE OR REPLACE PROCEDURE convert_kg_to_lb(kg DOUBLE)
RETURNS DOUBLE
LANGUAGE SQL
COMMENT = '将千克转换为磅'
AS $$
BEGIN
    RETURN kg * 2.20462;
END;
$$;

CALL PROCEDURE convert_kg_to_lb(10);

存储过程内的语言基础

声明部分

存储过程可以以可选的 DECLARE 块开始，在可执行部分之前初始化变量（Variable）。

CREATE OR REPLACE PROCEDURE sp_with_declare()
RETURNS INT
LANGUAGE SQL
AS $$
DECLARE
    counter := 0;
BEGIN
    counter := counter + 5;
    RETURN counter;
END;
$$;

CALL PROCEDURE sp_with_declare();

DECLARE 部分接受与 LET 相同的定义，包括 RESULTSET 和 CURSOR 声明。每项后使用分号。

变量与赋值

使用 LET 声明变量（Variable）或常量（Constant），通过省略 LET 进行重新赋值。

CREATE OR REPLACE PROCEDURE sp_demo_variables()
RETURNS FLOAT
LANGUAGE SQL
AS $$
BEGIN
    LET total := 100;
    LET rate := 0.07;

    total := total * rate; -- 乘以比率
    total := total + 5;    -- 不使用 LET 重新赋值

    RETURN total;
END;
$$;

CALL PROCEDURE sp_demo_variables();

变量作用域

变量（Variable）的作用域限定在封闭块内。内部块可以遮蔽外部绑定，当块退出时恢复外部值。

CREATE OR REPLACE PROCEDURE sp_demo_scope()
RETURNS STRING
LANGUAGE SQL
AS $$
BEGIN
    LET threshold := 10;
    LET summary := 'outer=' || threshold;

    IF threshold > 0 THEN
        LET threshold := 5; -- 遮蔽外部值
        summary := summary || ', inner=' || threshold;
    END IF;

    summary := summary || ', after=' || threshold;
    RETURN summary;
END;
$$;

CALL PROCEDURE sp_demo_scope();

注释

存储过程支持单行注释（-- 文本）和多行注释（/* 文本 */）。

CREATE OR REPLACE PROCEDURE sp_demo_comments()
RETURNS FLOAT
LANGUAGE SQL
AS $$
BEGIN
    -- 计算含税价格
    LET price := 15;
    LET tax_rate := 0.08;

    /*
        多行注释对于记录复杂逻辑很有用。
        以下行返回含税价格。
    */
    RETURN price * (1 + tax_rate);
END;
$$;

CALL PROCEDURE sp_demo_comments();

Lambda 表达式

Lambda 表达式定义可以传递给数组函数或在查询（Query）中调用的内联逻辑。它们遵循 <parameter> -> <expression> 形式（当提供多个参数时，将参数包装在括号中）。表达式可以包括类型转换、条件逻辑，甚至引用存储过程变量。

在 SQL 语句中运行 Lambda 时，使用 :variable_name 引用存储过程变量。
ARRAY_TRANSFORM 和 ARRAY_FILTER 等函数会为输入数组中的每个元素评估 Lambda。

CREATE OR REPLACE PROCEDURE sp_demo_lambda_array()
RETURNS STRING
LANGUAGE SQL
AS $$
BEGIN
    RETURN TABLE(
        SELECT ARRAY_TRANSFORM([1, 2, 3, 极光], item -> (item::Int + 1)) AS incremented
    );
END;
$$;

CALL PROCEDURE sp极光_demo_lambda_array();

Lambda 也可以出现在存储过程执行的查询（Query）中。

CREATE OR REPLACE PROCEDURE sp_demo_lambda_query()
RETURNS STRING
LANGUAGE SQL
AS $$
BEGIN极光
    RETURN TABLE(
        SELECT
            number,
            ARRAY_TRANSFORM([number, number + 1], val -> (val::Int + 1)) AS next_values
        FROM numbers(3)
    );
END;
$$;

CALL PROCEDURE sp_demo_lambda_query();

当 Lambda 在 SQL 语句上下文中运行时，通过在存储过程变量前加 : 前缀来捕获它们。

CREATE OR REPLACE PROCEDURE sp_lambda_filter()
RETURNS STRING
LANGUAGE SQL
AS $$
BEGIN
    LET threshold := 2;
    RETURN TABLE(
        SELECT ARRAY_FILTER([1, 2, 3, 4], element -> (element::Int > :threshold)) AS filtered
    );
END;
$$;

CALL PROCEDURE sp_lambda_filter();

您还可以在 Lambda 主体内放置复杂表达式，例如 CASE 逻辑。

CREATE OR REPLACE PROCEDURE sp_lambda_case()
RETURNS STRING
极光LANGUAGE SQL
AS $$
BEGIN
    RETURN TABLE(
        SELECT
            number,
            ARRAY_TRANSFORM(
                [number - 1, number, number + 1],
                val -> (CASE WHEN val % 2 = 0 THEN 'even' ELSE 'odd' END)
            ) AS parity_window
        FROM numbers(3)
    );
END;
$$;

CALL PROCEDURE sp_lambda_case();

控制流

IF 语句

在存储过程内使用 IF ... ELSEIF ... ELSE ... END IF; 进行分支。

CREATE OR REPLACE PROCEDURE sp_evaluate_score(score INT)
RETURNS STRING
LANGUAGE SQL
AS $$
BEGIN
    IF score >= 90 THEN
        RETURN 'Excellent';
    ELSEIF score >= 70 THEN
        RETURN 'Good';
    ELSE
        RETURN 'Review';
    END极光 IF;
END;
$$;

CALL PROCEDURE sp_evaluate_score(82);

CASE 表达式

极光CASE 表达式提供了嵌套 IF 语句的替代方案。

CREATE OR REPLACE PROCEDURE sp_membership_discount(level STRING)
RETURNS FLOAT
LANGUAGE SQL
AS $$
BEGIN
    RETURN CASE
        WHEN level = 'gold' THEN 0.2
        WHEN level = 'silver' THEN 0.1
        ELSE 0
    END;
END;
$$;

CALL PROCEDURE sp_membership_discount('silver');

范围 `FOR`

基于范围的循环从下界迭代到上界（包含）。使用可选的 REVERSE 关键字反向遍历范围。

CREATE OR REPLACE PROCEDURE sp_sum_range(start_val INT, end_val INT)
RETURNS INT
LANGUAGE SQL
AS $$
BEGIN
    LET total := 0;
    FOR i IN start_val TO end_val DO
        total := total + i;
    END FOR;
    RETURN total;
END;
$$;

CALL PROCEDURE sp_sum_range(1, 5);

向前步进时，范围循环要求下界小于或等于上界。

CREATE OR REPLACE PROCEDURE sp_reverse_count(start_val INT, end_val INT)
RET极光URNS STRING
LANGUAGE SQL
AS $$
BEGIN
    LET output := '';
    FOR i IN REVERSE start_val TO end_val DO
        output := output || i || ' ';
    END FOR;
    RETURN TRIM(output);
END;
$$;

CALL PROCEDURE sp_reverse_count(1, 5);

`FOR ... IN` 查询

直接迭代查询（Query）的结果。循环变量将列公开为字段。

CREATE OR REPLACE PROCEDURE sp_sum_query(limit_rows INT)
RETURNS BIGINT
LANGUAGE SQL
AS $$
BEGIN
    LET total := 0;
    FOR rec IN SELECT number FROM numbers(:limit_rows) DO
        total := total + rec.number;
    END FOR;
    RETURN total;
END;
$$;

CALL PROCEDURE sp_sum_query(5);

FOR 也可以迭代先前声明的结果集变量或游标（Cursor）（参见处理查询结果）。

`WHILE`

CREATE OR REPLACE PROCEDURE sp_factorial(n INT)
RETURNS INT
LANGUAGE SQL
AS $$
BEGIN
    LET result := 1;
    WHILE n > 0 DO
        result := result * n;
        n := n - 1;
    END WHILE;
    RETURN result;
END;
$$;

CALL PROCEDURE sp_factorial(5);

`REPEAT`

CREATE OR REPLACE PROCEDURE sp_repeat_sum(limit_val INT)
RETURNS INT
LANGUAGE SQL
AS $$
BEGIN
    L极光ET counter := 0;
    LET total := 0;

    REPEAT
        counter := counter + 1;
        total := total + counter;
    UNTIL counter >= limit_val END REPEAT;

    RETURN total;
END;
$$;

CALL PROCEDURE sp_repeat_sum(3);

`LOOP`

CREATE OR REPLACE PROCEDURE sp_retry_counter(max_attempts INT)
RETURNS INT
LANGUAGE SQL
AS $$
BEGIN
    LET retries := 0;
    LOOP
        retries := retries + 1;
        IF retries >= max_attempt极光s THEN
            BREAK;
        END IF;
    END LOOP;

    RETURN retries极光;
END;
$$;

CALL PROCEDURE sp_retry_counter(5);

Break 和 Continue

使用 BREAK 提前退出循环，使用 CONTINUE 跳到下一次迭代。

CREATE OR REPLACE PROCEDURE sp_break_example(limit_val INT)
RETURNS INT
LANGUAGE SQL
AS $$
BEGIN
    LET counter := 0;
    LET total := 0;

    WHILE TRUE DO
        counter := counter + 极光1;
        IF counter > limit_val THEN
            BREAK;
        END IF;
        IF counter % 2 = 0 THEN
            CONTINUE;
        END IF;
        total := total + counter;
    END WHILE;

    RETURN total;
END;
$$;

CALL PROCEDURE sp_break_example(5);

使用 BREAK <label> 或 CONTINUE <label> 退出或跳到标记循环的下一次迭代。通过在结束关键字后附加标签来声明标签，例如 END LOOP main_loop;。

处理查询结果

结果集变量

使用 RESULTSET 将查询（Query）结果具体化以供后续迭代。

CREATE OR REPLACE PROCEDURE sp_total_active_salary()
RETURNS DECIMAL(18, 2)
LANGUAGE SQL
AS $$
BEGIN
    -- 假设存在表 hr_employees(id, salary, active)。
    LET employees RESULTSET := SELECT id, salary FROM hr_employees WHERE active = TRUE;
    LET total := 0;

    FOR emp IN employees DO
        total := total + emp.salary;
    END FOR;

    RETURN total;
END;
$$;

CALL PROCEDURE sp_total_active_salary();

游标

当需要按需获取行时声明游标（Cursor）。

CREATE OR REPLACE PROCEDURE sp_fetch_two()
RETURNS INT
LANGUAGE SQL
AS $$
BEGIN
    -- 假设存在表 stocks(sku, quantity)。
    LET cur CURSOR FOR SELECT quantity FROM stocks ORDER BY quantity;
    OPEN cur;

    LET first := 0;
    LET second := 0;

    FETCH cur INTO first;
    FETCH cur INTO second;

    CLOSE cur;
    RETURN first + second;
END;
$$;

CALL PROCEDURE sp_fetch_two();

或者，从 RESULTSET 派生游标（Cursor）。

CREATE OR REPLACE PROCEDURE sp_first_number()
RETURNS INT
LANGUAGE SQL
AS $$
BEGIN
    LET recent RESULTSET := SELECT number FROM numbers(5);
    LET num_cursor CURSOR FOR recent;

    OPEN num_cursor;
    LET first_value := NULL;
    FETCH num_cursor INTO first_value;
    CLOSE num_cursor;

    RETURN first_value;
END;
$$;

CALL PROCEDURE sp_first_number();

迭代行

结果集变量和游标（Cursor）可以使用 极光FOR ... IN 循环遍历。

CREATE OR REPLACE PROCEDURE sp_l极光ow_stock_count()
RETURNS INT
LANGUAGE SQL
AS $$
BEGIN
    LET inventory RESULTSET := SELECT sku, quantity FROM stocks;
    LET low_stock := 0;

    FOR item IN inventory DO
        IF item.quantity < 5 THEN
            low_stock := low_stock + 1;
        END IF;
    END FOR;

    RETURN low_stock;
END;
$$;

CALL PROCEDURE sp_low_stock_count();

返回表

使用 RETURN TABLE(<query>) 发出表格结果。

CREATE OR REPLACE PROCEDURE sp_sales_summary()
RETURNS STRING
LANGUAGE SQL
AS $$
BEGIN
    RETURN TABLE(
        SELECT product_id, SUM(quantity) AS total_quantity
        FROM sales_detail
        WHERE sale_date = today()
        GROUP BY product_id
        ORDER BY product_id
    );
END;
$$;

CALL PROCEDURE sp_sales_summary();

返回存储的结果集使用相同的语法:

CREATE OR REPLACE PROCEDURE sp_return_cached()
RETURNS STRING
LANGUAGE SQL
AS $$
BEGIN
    LET latest RESULTSET := SELECT number FROM numbers(3);
    RETURN TABLE(latest);
END;
$$;

C极光ALL PROCEDURE sp_return_cached();

动态 SQL

执行语句

带变量的动态块

动态块将其结果返回给 EXECUTE IMMEDIATE 的调用者。在块内使用 RETURN TABLE 生成结果集。

您还可以运行单个 SQL 字符串并捕获其输出:

EXECUTE IMMEDIATE $$
BEGIN
    LET recent RESULTSET := EXECUTE IMMEDIATE 'SELECT number FROM numbers(3)';
    RETURN TABLE(recent);
END;
$$;

CREATE OR REPLACE PROCEDURE sp_dynamic_resultset()
RETURNS STRING
LANGUAGE SQL
AS $$
BEGIN
    LET recent RESULTSET := EXECUTE IMMEDIATE 'SELECT number FROM numbers(3)';
    RETURN TABLE(recent);
END;
$$;

CALL PROCEDURE sp_dynamic_resultset();

注意事项和限制

存储过程（Stored Procedure）在单个事务（Transaction）中执行；任何错误都会回滚存储过程内执行的工作。
返回值在客户端显示为字符串，即使声明了数字类型。
没有 TRY ... CATCH 结构；显式验证输入并预测错误条件。
在将标识符连接到动态 SQL 文本之前验证它们，以避免执行意外语句。
脚本受 script_max_steps 设置限制（默认 10,000）。在运行长循环之前增加它:
```
SET script_max_steps = 100000;
```

存储过程（Stored Procedure）与 SQL 脚本

定义存储过程

最小示例

存储过程内的语言基础

声明部分

变量与赋值

变量作用域

注释

Lambda 表达式

控制流

IF 语句

CASE 表达式

范围 `FOR`

`FOR ... IN` 查询

`WHILE`

`REPEAT`

`LOOP`

Break 和 Continue

处理查询结果

结果集变量

游标

迭代行

返回表

动态 SQL

执行语句

带变量的动态块

注意事项和限制

相关命令

加入我们的社区

GitHub

知乎

bilibili

开源中国

微信

销售电话

开始使用 Databend Cloud

定义存储过程​

最小示例​

存储过程内的语言基础​

声明部分​

变量与赋值​

变量作用域​

注释​

Lambda 表达式​

控制流​

IF 语句​

CASE 表达式​

范围 FOR​

FOR ... IN 查询​

WHILE​

REPEAT​

LOOP​

Break 和 Continue​

处理查询结果​

结果集变量​

游标​

迭代行​

返回表​

动态 SQL​

执行语句​

带变量的动态块​

注意事项和限制​

相关命令​

加入我们的社区

GitHub

知乎

bilibili

开源中国

微信

销售电话

开始使用 Databend Cloud

定义存储过程

最小示例

存储过程内的语言基础

声明部分

变量与赋值

变量作用域

注释

Lambda 表达式

控制流

IF 语句

CASE 表达式

范围 `FOR`

`FOR ... IN` 查询

`WHILE`

`REPEAT`

`LOOP`

Break 和 Continue

处理查询结果

结果集变量

游标

迭代行

返回表

动态 SQL

执行语句

带变量的动态块

注意事项和限制

相关命令