第 43 章 PL/Perl - Perl 过程语言
目录
PL/Perl 是一种可加载的过程语言,可以用 Perl 编程语言编写 PostgreSQL 函数。
使用 PL/Perl 的主要好处,是可以在存储函数中使用 Perl 提供的多种“字符串处理”操作符和函数。与使用 PL/pgSQL 提供的字符串函数和控制结构相比,用 Perl 解析复杂字符串可能更容易。
要在特定数据库中安装 PL/Perl,可使用
CREATE EXTENSION plperl,或者从 shell 命令行使用
createlang plperl 。
dbname
提示
如果把某种语言安装到template1中,之后创建的所有数据库都会自动安装该语言。
注意
使用源码包的用户必须在安装过程中专门启用 PL/Perl 的构建(更多信息见第 16 章)。使用二进制包的用户可能会在单独的子包中找到 PL/Perl。
43.1. PL/Perl 函数和参数 #
要用 PL/Perl 语言创建一个函数,可使用标准的CREATE FUNCTION语法:
CREATE FUNCTIONfuncname(argument-types) RETURNSreturn-typeAS $$ # PL/Perl 函数体 $$ LANGUAGE plperl;
函数的主体就是普通的 Perl 代码。事实上,PL/Perl 的粘合代码会把它包裹在一个 Perl 子程序中。PL/Perl 函数在标量上下文中被调用,因此不能返回列表。如下文所述,可以通过返回引用来返回非标量值(数组、记录和集合)。
PL/Perl 也支持用DO语句调用的匿名代码块:
DO $$
# PL/Perl 代码
$$ LANGUAGE plperl;匿名代码块不接收参数,它可能返回的任何值都会被丢弃。除此之外,它的行为与函数完全相同。
注意
在 Perl 中使用命名嵌套子程序是有危险的,特别是当它们引用外层作用域中的词法变量时。因为 PL/Perl 函数被包装成一个子程序,任何放在其中的命名子程序都会成为嵌套子程序。一般来说,创建通过代码引用(coderef)调用的匿名子程序会安全得多。更多信息可见
perldiag手册页中的Variable "%s" will not stay shared以及
Variable "%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;
注意
参数会从数据库编码转换为 PL/Perl 中使用的 UTF-8,返回时再从 UTF-8 转回数据库编码。
如果一个 SQL 空值被传给一个函数,在
Perl 中该参数值将呈现为“未定义”。上述函数定义对于空值输入的行为并不理想(实际上,它会把它们当作零)。我们可以在函数定义中添加 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 类型返回值的形式。
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 数组作为一个经 bless 的
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);
# 作为数组引用
for (@$arg) {
$result .= $_;
}
# 也可以作为字符串使用
$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();在声明的结果数据类型中,凡是哈希中未出现的列都将作为空值返回。
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 编译指示,可以有几种选择。对于临时的全局用法,可以 SET
plperl.use_strict 为真。这会影响后续编译的
PL/Perl 函数,但不会影响当前会话中已经编译的函数。对于永久的全局用法,可以在
postgresql.conf 文件中将
plperl.use_strict 设为真。
如果要在特定函数中永久启用它,可以简单地把
use strict;
放在函数体顶部。
如果 Perl 版本为 5.10.0 或更高,也可以通过 use
使用 feature 编译指示。