pgsql.cc 提供对 postgresql.org 官网内容的中文翻译,由 Pigsty 团队维护。
在一个块中使用的所有变量,都必须在该块的声明部分声明。(唯一的例外是:在整数范围上迭代的 FOR 循环变量会被自动声明为整数变量;同样,在游标结果上迭代的 FOR 循环变量会被自动声明为记录变量。)
PL/pgSQL 变量可以是任意 SQL 数据类型,例如 integer、varchar 和 char。
这里是变量声明的一些示例:
user_id integer; quantity numeric(5); url varchar; myrow tablename%ROWTYPE; myfield tablename.columnname%TYPE; arow RECORD;
一个变量声明的一般语法是:
name[ CONSTANT ]type[ COLLATEcollation_name] [ NOT NULL ] [ { DEFAULT | := }expression];
如果给定 DEFAULT 子句,它会指定进入该块时赋给该变量的初始值。如果没有给出 DEFAULT 子句,则变量会被初始化为 SQL 空值。CONSTANT 选项会阻止该变量在初始化之后再次被赋值,因此其值在整个块的持续期间保持不变。COLLATE 选项指定该变量使用的排序规则(见 第 39.3.6 节)。如果指定了 NOT NULL,给该变量赋空值将导致运行时错误。所有声明为 NOT NULL 的变量都必须指定非空默认值。
变量的默认值会在每次进入该块时重新计算并赋给该变量,而不是每次函数调用只计算一次。因此,例如把 now() 赋给一个 timestamp 类型变量,会使该变量得到当前函数调用时的时间,而不是函数预编译时的时间。
例如:
quantity integer DEFAULT 32; url varchar := 'http://mysite.com'; user_id CONSTANT integer := 10;
传递给函数的参数使用标识符 $1、$2 等命名。也可以为这些 $ 形式的参数名声明别名,以提高可读性。之后既可以使用别名,也可以使用数字标识符来引用参数值。n
有两种方式可以创建别名。推荐的方式是在 CREATE FUNCTION 命令中直接为参数命名。例如:
CREATE FUNCTION sales_tax(subtotal real) RETURNS real AS $$
BEGIN
RETURN subtotal * 0.06;
END;
$$ LANGUAGE plpgsql;
另一种方式——这也是 PostgreSQL 8.0 之前唯一可用的方式——是使用声明语法显式声明别名。
nameALIAS 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
-- 这里是一些使用 v_string 和 index 的计算
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 函数声明了输出参数时,输出参数也会像普通输入参数一样获得 $ 名称和可选别名。输出参数本质上是一个初始值为 NULL 的变量,应在函数执行期间给它赋值。该参数的最终值就是返回值。例如,销售税的示例也可以这样写:n
CREATE FUNCTION sales_tax(subtotal real, OUT tax real) AS $$
BEGIN
tax := subtotal * 0.06;
END;
$$ LANGUAGE plpgsql;
注意这里省略了 RETURNS real — 当然也可以写上,但那只是冗余。
当需要返回多个值时,输出参数尤其有用。下面是一个简单示例:
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;
如 第 35.4.4 节 所述,这实际上会为函数结果创建一个匿名记录类型。如果写了 RETURNS 子句,它必须是 RETURNS record。
声明 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 函数的返回类型被声明为 多态类型(anyelement、anyarray、 anynonarray 或 anyenum)时,会创建一个 特殊参数 $0。它的数据类型就是该函数的实际 返回类型,由实际输入类型推导而来(见 第 35.2.5 节)。这样,函数就能像 第 39.3.3 节 所示的那样访问自己的 实际返回类型。$0 被初始化为空值,并且可以 由函数修改,因此如果需要,可以用它来保存返回值,不过这并不是 必须的。$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;
ALIAS #newnameALIAS FORoldname;
ALIAS 语法比上一节所展示的更一般化:你可以为任何变量声明别名,而不只是函数参数。它最主要的实际用途,是为那些名称预先固定的变量指定另一个名字,例如触发器函数中的 NEW 或 OLD。
示例:
DECLARE prior ALIAS FOR old; updated ALIAS FOR new;
由于 ALIAS 为同一个对象提供了两种命名方式,滥用它会让代码变得混乱。最好只把它用于改写那些预先固定的名称。
variable%TYPE
%TYPE提供变量或表列的数据类型。可以用它声明将保存数据库值的变量。例如,假设有一个名为user_id的列,位于users表中。要声明一个数据类型与users.user_id相同的变量,可以写:
user_id users.user_id%TYPE;
使用 %TYPE 的好处是,你不必知道所引用结构的实际数据类型;更重要的是,如果被引用项的数据类型将来发生变化(例如把 user_id 的类型从 integer 改成 real),你可能就不需要修改函数定义。
%TYPE 在多态函数中特别有价值,因为内部变量所需的数据类型可能在不同调用之间变化。可以把 %TYPE 应用到函数参数或结果占位符上,以创建合适的变量。
nametable_name%ROWTYPE;namecomposite_type_name;
复合类型的变量称为行变量(或行类型变量)。只要查询的列集合与该变量声明的类型相匹配,这种变量就可以保存 SELECT 或 FOR 查询结果中的整行。行值的各个字段可以使用通常的点号记法访问,例如 rowvar.field。
行变量既可以通过 table_name%ROWTYPE 记法声明为与现有表或视图的行具有相同类型,也可以通过给出某个复合类型的名称来声明。(由于每个表都有一个同名的关联复合类型,所以在 PostgreSQL 中实际上写不写 %ROWTYPE 并无区别;不过带 %ROWTYPE 的形式可移植性更好。)
函数参数也可以是复合类型(完整的表行)。在这种情况下,相应的标识符 $ 就是一个行变量,并且可以从中选取字段,例如 n$1.user_id。
在行类型变量中,只能访问表行中用户定义的列,不能访问 OID 或其他系统列(因为该行可能来自视图)。对于char(这样的数据类型,行类型中的字段会继承表字段的大小或精度。n)
下面是一个使用复合类型的示例。table1 和 table2 是已经存在的表,它们至少包含下面提到的字段:
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 ... ;
name RECORD;
记录变量与行类型变量类似,但没有预定义结构。它会在 SELECT 或 FOR 命令为其赋值时采用相应行的实际结构。记录变量的内部结构在每次被赋值时都可能变化。其后果是:在记录变量第一次被赋值之前,它没有任何子结构,任何试图访问其中字段的行为都会引发运行时错误。
注意,RECORD 并不是真正的数据类型,它只是一个占位符。还需要认识到,PL/pgSQL 函数被声明为返回 record,与记录变量并不是完全相同的概念,尽管这样的函数可能会用记录变量保存结果。这两种情况下,在编写函数时都不知道实际的行结构;但对于返回 record 的函数,实际结构会在解析调用查询时确定,而记录变量的行结构则可以在运行过程中随时变化。
当 PL/pgSQL 函数具有一个或多个支持排序规则的数据类型参数时,每次函数调用都会根据分配给实际参数的排序规则确定出一个排序规则,如 第 22.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_1 与 text_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 命令中一样。
译文有误、术语不当或页面显示问题,请到译文仓库 pgsty/pgdoc 报告译文问题。 英文原文本身的问题,请在当前版本的对应页面向上游反馈;上游不再修订已结束维护的版本。