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

43.1. PL/Perl 函数和参数 #

要创建 PL/Perl 语言中的函数,请使用标准的 CREATE FUNCTION 语法

CREATE FUNCTION funcname (argument-types)
RETURNS return-type
-- function attributes can go here
AS $$
    # PL/Perl function body goes here
$$ LANGUAGE plperl;

函数体是普通的 Perl 代码。事实上,PL/Perl 粘合代码将其包装在一个 Perl 子程序中。PL/Perl 函数在标量上下文中调用,因此它不能返回列表。您可以通过返回引用来返回非标量值(数组、记录和集合),如下所述。

在 PL/Perl 过程中,忽略来自 Perl 代码的任何返回值。

PL/Perl 还支持使用 DO 语句调用的匿名代码块

DO $$
    # PL/Perl code
$$ LANGUAGE plperl;

匿名代码块不接收任何参数,并且它可能返回的任何值都将被丢弃。否则,它的行为就像一个函数。

注意

在 Perl 中使用命名嵌套子程序是危险的,尤其是在它们引用封闭作用域中的词法变量时。由于 PL/Perl 函数被包装在一个子程序中,因此您在其中放置的任何命名子程序都将嵌套。通常,创建您通过代码引用调用的匿名子程序要安全得多。有关更多信息,请参阅 perldiag 手册页中 Variable "%s" will not stay sharedVariable "%s" is not available 的条目,或在互联网上搜索 perl nested named subroutine

CREATE FUNCTION 命令的语法要求将函数体写为字符串常量。通常使用美元引用(请参阅 第 4.1.2.4 节)来编写字符串常量最为方便。如果选择使用转义字符串语法 E'',则必须在函数体中将任何单引号 (') 和反斜杠 (\) 加倍(请参阅 第 4.1.2.1 节)。

参数和结果的处理方式与任何其他 Perl 子程序相同:参数传递到 @_ 中,结果值使用 return 返回或作为函数中最后计算的表达式返回。

例如,返回两个整数值中较大值的函数可以定义为

CREATE FUNCTION perl_max (integer, integer) RETURNS integer AS $$
    if ($_[0] > $_[1]) { return $_[0]; }
    return $_[1];
$$ LANGUAGE plperl;

注意

参数将从数据库的编码转换为 UTF-8 以在 PL/Perl 内部使用,然后在返回时从 UTF-8 转换回数据库编码。

如果将 SQL 空值 传递给函数,则参数值将在 Perl 中显示为 undefined。上述函数定义在空输入方面不会表现得很好(实际上,它会将其视为零)。我们可以向函数定义中添加 STRICT 以使 PostgreSQL 执行更合理的操作:如果传递了空值,则根本不会调用该函数,而是会自动返回空结果。或者,我们可以在函数体中检查未定义的输入。例如,假设我们希望 perl_max 带有一个空值和一个非空值参数返回非空值参数,而不是空值

CREATE FUNCTION perl_max (integer, integer) RETURNS integer AS $$
    my ($x, $y) = @_;
    if (not defined $x) {
        return undef if not defined $y;
        return $y;
    }
    return $x if not defined $y;
    return $x if $x > $y;
    return $y;
$$ LANGUAGE plperl;

如上所示,要从 PL/Perl 函数返回 SQL 空值,请返回未定义的值。无论函数是否严格,都可以这样做。

函数参数中任何不是引用的内容都是字符串,它是相关数据类型的标准 PostgreSQL 外部文本表示形式。对于普通数字或文本类型,Perl 将执行正确的操作,程序员通常不必担心它。但是,在其他情况下,需要将参数转换为在 Perl 中更易用的形式。例如,decode_bytea 函数可用于将类型为 bytea 的参数转换为未转义的二进制数据。

类似地,传递回 PostgreSQL 的值必须采用外部文本表示格式。例如,encode_bytea 函数可用于转义二进制数据以用于类型为 bytea 的返回值。

一个特别重要的案例是布尔值。正如刚才所说,bool 值的默认行为是将其作为文本传递给 Perl,因此是 't''f'。这是有问题的,因为 Perl 不会将 'f' 视为 false!可以通过使用 transform(请参阅 CREATE TRANSFORM)来改进情况。bool_plperl 扩展提供了合适的转换。要使用它,请安装扩展

CREATE EXTENSION bool_plperl;  -- or bool_plperlu for PL/PerlU

然后,对于接受或返回 bool 的 PL/Perl 函数,使用 TRANSFORM 函数属性,例如

CREATE FUNCTION perl_and(bool, bool) RETURNS bool
TRANSFORM FOR TYPE bool
AS $$
  my ($a, $b) = @_;
  return $a && $b;
$$ LANGUAGE plperl;

应用此转换后,Perl 将看到 bool 参数为 1 或空,因此正确地为 true 或 false。如果函数结果类型为 bool,则根据 Perl 是否将返回值评估为 true 来确定其为 true 或 false。对布尔查询参数和在函数内部执行的 SPI 查询的结果 (第 43.3.1 节) 也执行类似的转换。

Perl 可以将 PostgreSQL 数组返回为对 Perl 数组的引用。这是一个示例

CREATE OR REPLACE function returns_array()
RETURNS text[][] AS $$
    return [['a"b','c,d'],['e\\f','g']];
$$ LANGUAGE plperl;

select returns_array();

Perl 将 PostgreSQL 数组作为受祝福的 PostgreSQL::InServer::ARRAY 对象传递。此对象可以被视为数组引用或字符串,允许与为低于 9.1 的 PostgreSQL 版本编写的 Perl 代码向后兼容。例如

CREATE OR REPLACE FUNCTION concat_array_elements(text[]) RETURNS TEXT AS $$
    my $arg = shift;
    my $result = "";
    return undef if (!defined $arg);

    # as an array reference
    for (@$arg) {
        $result .= $_;
    }

    # also works as a string
    $result .= $arg;

    return $result;
$$ LANGUAGE plperl;

SELECT concat_array_elements(ARRAY['PL','/','Perl']);

注意

多维数组以对 Perl 程序员常见的方式表示为对较低维数组的引用的引用。

复合类型参数作为对哈希的引用传递给函数。哈希的键是复合类型的属性名称。这是一个示例

CREATE TABLE employee (
    name text,
    basesalary integer,
    bonus integer
);

CREATE FUNCTION empcomp(employee) RETURNS integer AS $$
    my ($emp) = @_;
    return $emp->{basesalary} + $emp->{bonus};
$$ LANGUAGE plperl;

SELECT name, empcomp(employee.*) FROM employee;

PL/Perl 函数可以使用相同的方法返回复合类型结果:返回对具有所需属性的哈希的引用。例如

CREATE TYPE testrowperl AS (f1 integer, f2 text, f3 text);

CREATE OR REPLACE FUNCTION perl_row() RETURNS testrowperl AS $$
    return {f2 => 'hello', f1 => 1, f3 => 'world'};
$$ LANGUAGE plperl;

SELECT * FROM perl_row();

声明的结果数据类型中不存在于哈希中的任何列都将返回为空值。

类似地,过程的输出参数可以作为哈希引用返回

CREATE PROCEDURE perl_triple(INOUT a integer, INOUT b integer) AS $$
    my ($a, $b) = @_;
    return {a => $a * 3, b => $b * 3};
$$ LANGUAGE plperl;

CALL perl_triple(5, 10);

PL/Perl 函数还可以返回标量或复合类型的集合。通常,您希望一次返回一行,这既可以加快启动时间,又可以避免在内存中排队整个结果集。您可以使用 return_next 来实现这一点,如下所示。请注意,在最后一个 return_next 之后,必须放置 return 或(更好)return undef

CREATE OR REPLACE FUNCTION perl_set_int(int)
RETURNS SETOF INTEGER AS $$
    foreach (0..$_[0]) {
        return_next($_);
    }
    return undef;
$$ LANGUAGE plperl;

SELECT * FROM perl_set_int(5);

CREATE OR REPLACE FUNCTION perl_set()
RETURNS SETOF testrowperl AS $$
    return_next({ f1 => 1, f2 => 'Hello', f3 => 'World' });
    return_next({ f1 => 2, f2 => 'Hello', f3 => 'PostgreSQL' });
    return_next({ f1 => 3, f2 => 'Hello', f3 => 'PL/Perl' });
    return undef;
$$ LANGUAGE plperl;

对于小型结果集,您可以返回对包含标量、对数组的引用或对哈希的引用的数组的引用,分别用于简单类型、数组类型和复合类型。以下是一些返回整个结果集作为数组引用的简单示例

CREATE OR REPLACE FUNCTION perl_set_int(int) RETURNS SETOF INTEGER AS $$
    return [0..$_[0]];
$$ LANGUAGE plperl;

SELECT * FROM perl_set_int(5);

CREATE OR REPLACE FUNCTION perl_set() RETURNS SETOF testrowperl AS $$
    return [
        { f1 => 1, f2 => 'Hello', f3 => 'World' },
        { f1 => 2, f2 => 'Hello', f3 => 'PostgreSQL' },
        { f1 => 3, f2 => 'Hello', f3 => 'PL/Perl' }
    ];
$$ LANGUAGE plperl;

SELECT * FROM perl_set();

如果您希望在代码中使用 strict pragma,则有一些选择。对于临时的全局使用,您可以将 plperl.use_strict 设置为 true。这将影响随后编译的 PL/Perl 函数,但不影响当前会话中已编译的函数。对于永久的全局使用,可以在 postgresql.conf 文件中将 plperl.use_strict 设置为 true。

对于特定函数的永久使用,您可以简单地放置

use strict;

在函数体的顶部。

如果您的 Perl 版本为 5.10.0 或更高版本,则还可以使用 feature pragma。

提交更正

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