2024年9月26日: PostgreSQL 17 发布!
支持的版本:当前 (17) / 16 / 15 / 14 / 13 / 12
开发版本:开发版
不支持的版本:11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3 / 8.2 / 8.1 / 8.0 / 7.4 / 7.3 / 7.2

41.3. 声明 #

块中使用的所有变量都必须在块的声明部分声明。(唯一的例外是,遍历整数范围的 FOR 循环的循环变量会自动声明为整数变量,同样,遍历游标结果的 FOR 循环的循环变量会自动声明为记录变量。)

PL/pgSQL 变量可以具有任何 SQL 数据类型,例如 integervarcharchar

以下是一些变量声明示例

user_id integer;
quantity numeric(5);
url varchar;
myrow tablename%ROWTYPE;
myfield tablename.columnname%TYPE;
arow RECORD;

变量声明的通用语法为

name [ CONSTANT ] type [ COLLATE collation_name ] [ NOT NULL ] [ { DEFAULT | := | = } expression ];

如果给出 DEFAULT 子句,则指定进入块时分配给变量的初始值。如果没有给出 DEFAULT 子句,则变量将初始化为SQL空值。 CONSTANT 选项阻止在初始化后分配给变量,以便其值在块的持续时间内保持不变。 COLLATE 选项指定要用于变量的排序规则(参见 第 41.3.6 节)。如果指定了 NOT NULL,则分配空值会导致运行时错误。所有声明为 NOT NULL 的变量都必须指定非空默认值。可以使用等号 (=) 代替符合 PL/SQL 的 :=

每次进入块时都会计算变量的默认值并将其分配给变量(而不仅仅是每个函数调用一次)。因此,例如,将 now() 分配给类型为 timestamp 的变量会导致变量具有当前函数调用的时间,而不是函数预编译时的时间。

示例

quantity integer DEFAULT 32;
url varchar := 'http://mysite.com';
transaction_time CONSTANT timestamp with time zone := now();

声明后,可以在同一块中的后续初始化表达式中使用变量的值,例如

DECLARE
  x integer := 1;
  y integer := x + 1;

41.3.1. 声明函数参数 #

传递给函数的参数使用标识符 $1$2 等命名。可以选择为 $n 参数名称声明别名以提高可读性。然后可以使用别名或数字标识符来引用参数值。

有两种方法可以创建别名。首选方法是在 CREATE FUNCTION 命令中为参数指定名称,例如

CREATE FUNCTION sales_tax(subtotal real) RETURNS real AS $$
BEGIN
    RETURN subtotal * 0.06;
END;
$$ LANGUAGE plpgsql;

另一种方法是使用声明语法显式声明别名

name ALIAS FOR $n;

此样式中的相同示例如下所示

CREATE FUNCTION sales_tax(real) RETURNS real AS $$
DECLARE
    subtotal ALIAS FOR $1;
BEGIN
    RETURN subtotal * 0.06;
END;
$$ LANGUAGE plpgsql;

注意

这两个示例并不完全等效。在第一种情况下,可以将 subtotal 引用为 sales_tax.subtotal,但在第二种情况下则不能。(如果我们为内部块附加了一个标签,则可以使用该标签限定 subtotal,而不是。)

更多示例

CREATE FUNCTION instr(varchar, integer) RETURNS integer AS $$
DECLARE
    v_string ALIAS FOR $1;
    index ALIAS FOR $2;
BEGIN
    -- some computations using v_string and index here
END;
$$ LANGUAGE plpgsql;


CREATE FUNCTION concat_selected_fields(in_t sometablename) RETURNS text AS $$
BEGIN
    RETURN in_t.f1 || in_t.f3 || in_t.f5 || in_t.f7;
END;
$$ LANGUAGE plpgsql;

PL/pgSQL 函数声明为具有输出参数时,输出参数将以与普通输入参数相同的方式获得 $n 名称和可选别名。输出参数实际上是一个最初为 NULL 的变量;它应该在函数执行期间分配给它。参数的最终值是返回的值。例如,销售税示例也可以通过这种方式完成

CREATE FUNCTION sales_tax(subtotal real, OUT tax real) AS $$
BEGIN
    tax := subtotal * 0.06;
END;
$$ LANGUAGE plpgsql;

请注意,我们省略了 RETURNS real - 我们可以包含它,但它将是冗余的。

要调用具有 OUT 参数的函数,请在函数调用中省略输出参数。

SELECT sales_tax(100.00);

当返回多个值时,输出参数最有用。一个简单的示例是

CREATE FUNCTION sum_n_product(x int, y int, OUT sum int, OUT prod int) AS $$
BEGIN
    sum := x + y;
    prod := x * y;
END;
$$ LANGUAGE plpgsql;

SELECT * FROM sum_n_product(2, 4);
 sum | prod
-----+------
   6 |    8

第 36.5.4 节 中所述,这实际上为函数的结果创建了一个匿名记录类型。如果给出了 RETURNS 子句,则它必须说 RETURNS record

这也适用于过程,例如

CREATE PROCEDURE sum_n_product(x int, y int, OUT sum int, OUT prod int) AS $$
BEGIN
    sum := x + y;
    prod := x * y;
END;
$$ LANGUAGE plpgsql;

在对过程的调用中,必须指定所有参数。对于输出参数,在从纯 SQL 调用过程时可以指定 NULL

CALL sum_n_product(2, 4, NULL, NULL);
 sum | prod
-----+------
   6 |    8

但是,当从 PL/pgSQL 调用过程时,您应该为任何输出参数编写一个变量;该变量将接收调用的结果。有关详细信息,请参见 第 41.6.3 节

声明 PL/pgSQL 函数的另一种方法是使用 RETURNS TABLE,例如

CREATE FUNCTION extended_sales(p_itemno int)
RETURNS TABLE(quantity int, total numeric) AS $$
BEGIN
    RETURN QUERY SELECT s.quantity, s.quantity * s.price FROM sales AS s
                 WHERE s.itemno = p_itemno;
END;
$$ LANGUAGE plpgsql;

这与声明一个或多个 OUT 参数并指定 RETURNS SETOF sometype 完全等效。

PL/pgSQL 函数的返回类型声明为多态类型(参见 第 36.2.5 节)时,会创建一个特殊参数 $0。其数据类型是函数的实际返回类型,根据实际输入类型推断得出。这允许函数访问其实际返回类型,如 第 41.3.3 节 中所示。 $0 初始化为 null 并可以由函数修改,因此如果需要,它可以用于保存返回值,尽管这不是必需的。 $0 也可以被赋予别名。例如,此函数适用于任何具有 + 运算符的数据类型

CREATE FUNCTION add_three_values(v1 anyelement, v2 anyelement, v3 anyelement)
RETURNS anyelement AS $$
DECLARE
    result ALIAS FOR $0;
BEGIN
    result := v1 + v2 + v3;
    RETURN result;
END;
$$ LANGUAGE plpgsql;

可以通过将一个或多个输出参数声明为多态类型来获得相同的效果。在这种情况下,不会使用特殊参数 $0;输出参数本身具有相同的用途。例如

CREATE FUNCTION add_three_values(v1 anyelement, v2 anyelement, v3 anyelement,
                                 OUT sum anyelement)
AS $$
BEGIN
    sum := v1 + v2 + v3;
END;
$$ LANGUAGE plpgsql;

在实践中,使用 anycompatible 类型族声明多态函数可能更有用,以便自动将输入参数提升到通用类型。例如

CREATE FUNCTION add_three_values(v1 anycompatible, v2 anycompatible, v3 anycompatible)
RETURNS anycompatible AS $$
BEGIN
    RETURN v1 + v2 + v3;
END;
$$ LANGUAGE plpgsql;

在此示例中,诸如

SELECT add_three_values(1, 2, 4.7);

之类的调用将起作用,自动将整数输入提升为数值。使用 anyelement 的函数将要求您手动将三个输入转换为相同的类型。

41.3.2. ALIAS #

newname ALIAS FOR oldname;

ALIAS 语法比上一节中建议的更通用:您可以为任何变量声明别名,而不仅仅是函数参数。这主要用于为具有预定名称的变量(例如触发器函数中的 NEWOLD)分配不同的名称。

示例

DECLARE
  prior ALIAS FOR old;
  updated ALIAS FOR new;

由于 ALIAS 创建了两种命名同一对象的不同方法,因此不受限制的使用可能会令人困惑。最好仅将其用于覆盖预定名称的目的。

41.3.3. 复制类型 #

name table.column%TYPE
name variable%TYPE

%TYPE 提供表列或先前声明的 PL/pgSQL 变量的数据类型。您可以使用它来声明将保存数据库值的变量。例如,假设您的 users 表中有一个名为 user_id 的列。要声明与 users.user_id 具有相同数据类型的变量,您可以编写

user_id users.user_id%TYPE;

也可以在 %TYPE 后编写数组修饰,从而创建一个保存引用类型数组的变量

user_ids users.user_id%TYPE[];
user_ids users.user_id%TYPE ARRAY[4];  -- equivalent to the above

就像声明作为数组的表列一样,编写多个括号对或特定的数组维度都没有关系:PostgreSQL 将所有给定元素类型的数组视为相同的类型,无论其维度如何。(参见 第 8.15.1 节。)

通过使用 %TYPE,您无需了解正在引用的结构的数据类型,最重要的是,如果引用的项的数据类型将来发生更改(例如:您将 user_id 的类型从 integer 更改为 real),您可能无需更改函数定义。

%TYPE 在多态函数中特别有价值,因为内部变量所需的类型可能从一次调用更改到下一次调用。可以通过将 %TYPE 应用于函数的参数或结果占位符来创建合适的变量。

41.3.4. 行类型 #

name table_name%ROWTYPE;
name composite_type_name;

复合类型的变量称为变量(或行类型变量)。此类变量可以保存SELECTFOR查询结果的整行,只要该查询的列集与变量的声明类型匹配即可。可以使用通常的点表示法访问行值的各个字段,例如rowvar.field

可以使用table_name%ROWTYPE表示法将行变量声明为与现有表或视图的行具有相同类型;或者可以通过提供复合类型的名称来声明它。(由于每个表都具有一个同名的关联复合类型,因此在PostgreSQL中实际上写不写%ROWTYPE都没有关系。但使用%ROWTYPE的形式更具可移植性。)

%TYPE一样,%ROWTYPE后面可以加上数组修饰符来声明一个保存引用的复合类型数组的变量。

函数的参数可以是复合类型(完整的表行)。在这种情况下,相应的标识符$n将是一个行变量,并且可以从中选择字段,例如$1.user_id

以下是用复合类型的示例。table1table2是现有表,至少包含提到的字段

CREATE FUNCTION merge_fields(t_row table1) RETURNS text AS $$
DECLARE
    t2_row table2%ROWTYPE;
BEGIN
    SELECT * INTO t2_row FROM table2 WHERE ... ;
    RETURN t_row.f1 || t2_row.f3 || t_row.f5 || t2_row.f7;
END;
$$ LANGUAGE plpgsql;

SELECT merge_fields(t.*) FROM table1 t WHERE ... ;

41.3.5. 记录类型 #

name RECORD;

记录变量类似于行类型变量,但它们没有预定义的结构。它们采用在SELECTFOR命令期间分配给它们的行的实际行结构。记录变量的子结构可以在每次分配时发生变化。其结果是,在第一次分配给记录变量之前,它没有子结构,并且尝试访问其中的任何字段都会导致运行时错误。

请注意,RECORD不是真正的數據類型,只是一个占位符。还应该意识到,当一个PL/pgSQL函数被声明为返回类型record时,这与记录变量的概念并不完全相同,即使这样的函数可能使用记录变量来保存其结果。在这两种情况下,函数编写时实际的行结构都是未知的,但对于返回record的函数,实际的结构是在调用查询被解析时确定的,而记录变量可以动态地改变其行结构。

41.3.6. PL/pgSQL变量的排序规则 #

当一个PL/pgSQL函数有一个或多个可排序数据类型的参数时,根据分配给实际参数的排序规则(如第 23.2 节中所述)为每个函数调用识别一个排序规则。如果成功识别出排序规则(即,参数之间没有隐式排序规则冲突),则所有可排序参数都隐式地视为具有该排序规则。这将影响函数中排序规则敏感操作的行为。例如,考虑

CREATE FUNCTION less_than(a text, b text) RETURNS boolean AS $$
BEGIN
    RETURN a < b;
END;
$$ LANGUAGE plpgsql;

SELECT less_than(text_field_1, text_field_2) FROM table1;
SELECT less_than(text_field_1, text_field_2 COLLATE "C") FROM table1;

less_than的第一次使用将使用text_field_1text_field_2的公共排序规则进行比较,而第二次使用将使用C排序规则。

此外,识别出的排序规则也假定为任何可排序类型局部变量的排序规则。因此,如果将此函数写成如下形式,则其行为不会有任何不同

CREATE FUNCTION less_than(a text, b text) RETURNS boolean AS $$
DECLARE
    local_a text := a;
    local_b text := b;
BEGIN
    RETURN local_a < local_b;
END;
$$ LANGUAGE plpgsql;

如果没有可排序数据类型的参数,或者无法为它们识别出公共排序规则,则参数和局部变量将使用其数据类型的默认排序规则(通常是数据库的默认排序规则,但对于域类型变量可能不同)。

可以通过在可排序数据类型的局部变量声明中包含COLLATE选项来为其关联不同的排序规则,例如

DECLARE
    local_a text COLLATE "en_US";

此选项将覆盖根据上述规则赋予变量的排序规则。

当然,如果希望强制在特定操作中使用特定排序规则,也可以在函数内部编写显式的COLLATE子句。例如,

CREATE FUNCTION less_than_c(a text, b text) RETURNS boolean AS $$
BEGIN
    RETURN a < b COLLATE "C";
END;
$$ LANGUAGE plpgsql;

这将覆盖与表达式中使用的表列、参数或局部变量关联的排序规则,就像在普通 SQL 命令中一样。

提交更正

如果您在文档中看到任何不正确的内容、与您对特定功能的体验不符的内容或需要进一步说明的内容,请使用此表单报告文档问题。