2025年9月25日: PostgreSQL 18 发布!
支持版本: 当前 (18) / 17 / 16 / 15 / 14 / 13
开发版本: devel
不支持的版本: 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

41.12. PL/pgSQL 开发技巧 #

开发 PL/pgSQL 的一个好方法是使用您选择的文本编辑器来创建函数,并在另一个窗口中使用 psql 来加载和测试这些函数。如果您这样做,最好使用 CREATE OR REPLACE FUNCTION 来编写函数。这样您就可以简单地重新加载文件来更新函数定义。例如:

CREATE OR REPLACE FUNCTION testfunc(integer) RETURNS integer AS $$
          ....
$$ LANGUAGE plpgsql;

在运行 psql 时,您可以使用以下命令加载或重新加载此类函数定义文件:

\i filename.sql

然后立即发出 SQL 命令来测试该函数。

使用支持过程语言开发的 GUI 数据库访问工具是开发 PL/pgSQL 的另一种好方法。pgAdmin 就是这类工具的一个例子,尽管还有其他工具。这些工具通常提供方便的功能,例如转义单引号,以及更轻松地重新创建和调试函数。

41.12.1. 引号的处理 #

PL/pgSQL 函数的代码在 CREATE FUNCTION 中被指定为字符串字面量。如果您以普通方式编写带周围单引号的字符串字面量,那么函数体内的任何单引号都必须加倍;同样,任何反斜杠都必须加倍(假设使用了转义字符串语法)。加倍引号至少是乏味的,在更复杂的情况下,代码会变得难以理解,因为您很容易发现需要半打或更多的相邻引号。建议您改用“美元定界字符串”(dollar-quoted)字面量来编写函数体(参见 4.1.2.4 节)。在美元定界的方法中,您永远不需要加倍任何引号,而是注意为所需的每个嵌套级别选择不同的美元定界字符串分隔符。例如,您可以将 CREATE FUNCTION 命令写成:

CREATE OR REPLACE FUNCTION testfunc(integer) RETURNS integer AS $PROC$
          ....
$PROC$ LANGUAGE plpgsql;

在此之中,您可以使用引号来表示 SQL 命令中的简单字面字符串,并使用 $$ 来分隔您正在组装为字符串的 SQL 命令片段。如果您需要引用包含 $$ 的文本,您可以使用 $Q$,依此类推。

以下图表显示了在不使用美元定界字符串时编写引号所需执行的操作。当将旧的(非美元定界)代码转换为更易读的内容时,它可能会很有用。

1 个引号 #

例如,用于开始和结束函数体

CREATE FUNCTION foo() RETURNS integer AS '
          ....
' LANGUAGE plpgsql;

在单引号包围的函数体内,任何地方的引号必须成对出现。

2 个引号 #

例如,用于函数体内的字符串字面量

a_output := ''Blah'';
SELECT * FROM users WHERE f_name=''foobar'';

在美元定界的方法中,您只需写:

a_output := 'Blah';
SELECT * FROM users WHERE f_name='foobar';

无论哪种情况,PL/pgSQL 解析器实际看到的都是这样。

4 个引号 #

当您在函数体内的字符串常量中需要一个单引号时,例如

a_output := a_output || '' AND name LIKE ''''foobar'''' AND xyz''

实际附加到 a_output 的值将是:AND name LIKE 'foobar' AND xyz

在美元定界的方法中,您将写:

a_output := a_output || $$ AND name LIKE 'foobar' AND xyz$$

确保此处的任何美元定界字符串分隔符不是 $$

6 个引号 #

当函数体内的字符串中的单引号紧邻该字符串常量末尾时,例如

a_output := a_output || '' AND name LIKE ''''foobar''''''

然后附加到 a_output 的值将是:AND name LIKE 'foobar'

在美元定界的方法中,这将变成:

a_output := a_output || $$ AND name LIKE 'foobar'$$
10 个引号 #

当您想在字符串常量中放置两个单引号(这占用了 8 个引号),并且这又紧邻该字符串常量末尾(另外 2 个)。您可能只需要在编写生成其他函数的函数时才需要,如 示例 41.10 所示。例如:

a_output := a_output || '' if v_'' ||
    referrer_keys.kind || '' like ''''''''''
    || referrer_keys.key_string || ''''''''''
    then return ''''''  || referrer_keys.referrer_type
    || ''''''; end if;'';

然后 a_output 的值将是:

if v_... like ''...'' then return ''...''; end if;

在美元定界的方法中,这将变成:

a_output := a_output || $$ if v_$$ || referrer_keys.kind || $$ like '$$
    || referrer_keys.key_string || $$'
    then return '$$  || referrer_keys.referrer_type
    || $$'; end if;$$;

假设我们只需要将单引号放入 a_output 中,因为在使用前它将被重新引用。

41.12.2. 额外的编译时和运行时检查 #

为了帮助用户在出现简单但常见的问题之前发现它们,PL/pgSQL 提供了额外的检查。启用后,根据配置,它们可以用于在函数编译期间发出 WARNINGERROR。收到 WARNING 的函数可以执行而不会产生进一步的消息,因此建议您在一个单独的开发环境中进行测试。

建议在开发和/或测试环境中将 plpgsql.extra_warningsplpgsql.extra_errors(根据需要)设置为 "all"

这些额外的检查通过配置变量 plpgsql.extra_warnings(用于警告)和 plpgsql.extra_errors(用于错误)来启用。两者都可以设置为逗号分隔的检查列表、"none""all"。默认值为 "none"。目前可用的检查列表包括:

shadowed_variables #

检查声明是否覆盖了先前定义的变量。

strict_multi_assignment #

PL/pgSQL 中的某些命令允许一次将值赋给多个变量,例如 SELECT INTO。通常,目标变量的数量和源变量的数量应匹配,尽管 PL/pgSQL 会为缺失的值使用 NULL,并忽略多余的变量。启用此检查将导致 PL/pgSQL 在目标变量和源变量的数量不同时引发 WARNINGERROR

too_many_rows #

启用此检查将导致 PL/pgSQL 检查在使用 INTO 子句时,给定查询是否返回了多于一行。由于 INTO 语句只会使用一行,因此查询返回多行通常效率低下和/或不确定,因此很可能是一个错误。

以下示例显示了将 plpgsql.extra_warnings 设置为 shadowed_variables 的效果:

SET plpgsql.extra_warnings TO 'shadowed_variables';

CREATE FUNCTION foo(f1 int) RETURNS int AS $$
DECLARE
f1 int;
BEGIN
RETURN f1;
END;
$$ LANGUAGE plpgsql;
WARNING:  variable "f1" shadows a previously defined variable
LINE 3: f1 int;
        ^
CREATE FUNCTION

以下示例显示了将 plpgsql.extra_warnings 设置为 strict_multi_assignment 的效果:

SET plpgsql.extra_warnings TO 'strict_multi_assignment';

CREATE OR REPLACE FUNCTION public.foo()
 RETURNS void
 LANGUAGE plpgsql
AS $$
DECLARE
  x int;
  y int;
BEGIN
  SELECT 1 INTO x, y;
  SELECT 1, 2 INTO x, y;
  SELECT 1, 2, 3 INTO x, y;
END;
$$;

SELECT foo();
WARNING:  number of source and target fields in assignment does not match
DETAIL:  strict_multi_assignment check of extra_warnings is active.
HINT:  Make sure the query returns the exact list of columns.
WARNING:  number of source and target fields in assignment does not match
DETAIL:  strict_multi_assignment check of extra_warnings is active.
HINT:  Make sure the query returns the exact list of columns.

 foo
-----

(1 row)

提交更正

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