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

43.3. 内置函数 #

43.3.1. 从 PL/Perl 访问数据库 #

可以通过以下函数从 Perl 函数访问数据库本身:

spi_exec_query(query [, limit])

spi_exec_query 执行 SQL 命令,并将整个行集作为哈希引用数组的引用返回。如果指定了 limit 且大于零,则 spi_exec_query 最多检索 limit 行,很像是查询包含了一个 LIMIT 子句。省略 limit 或将其指定为零表示不限制行数。

您应该只在此命令结果集相对较小时使用它。 以下是带有可选最大行数的查询(SELECT 命令)示例:

$rv = spi_exec_query('SELECT * FROM my_table', 5);

这会从 my_table 表返回最多 5 行。如果 my_table 有一个名为 my_column 的列,您可以像这样从结果的第 $i 行获取该值:

$foo = $rv->{rows}[$i]->{my_column};

可以这样访问 SELECT 查询返回的总行数:

$nrows = $rv->{processed}

以下是使用不同命令类型的示例:

$query = "INSERT INTO my_table VALUES (1, 'test')";
$rv = spi_exec_query($query);

您可以通过这种方式访问命令状态(例如,SPI_OK_INSERT):

$res = $rv->{status};

要获取受影响的行数,请执行:

$nrows = $rv->{processed};

这是一个完整的示例:

CREATE TABLE test (
    i int,
    v varchar
);

INSERT INTO test (i, v) VALUES (1, 'first line');
INSERT INTO test (i, v) VALUES (2, 'second line');
INSERT INTO test (i, v) VALUES (3, 'third line');
INSERT INTO test (i, v) VALUES (4, 'immortal');

CREATE OR REPLACE FUNCTION test_munge() RETURNS SETOF test AS $$
    my $rv = spi_exec_query('select i, v from test;');
    my $status = $rv->{status};
    my $nrows = $rv->{processed};
    foreach my $rn (0 .. $nrows - 1) {
        my $row = $rv->{rows}[$rn];
        $row->{i} += 200 if defined($row->{i});
        $row->{v} =~ tr/A-Za-z/a-zA-Z/ if (defined($row->{v}));
        return_next($row);
    }
    return undef;
$$ LANGUAGE plperl;

SELECT * FROM test_munge();
spi_query(command)
spi_fetchrow(cursor)
spi_cursor_close(cursor)

spi_queryspi_fetchrow 配对使用,适用于可能很大的行集,或者您希望在行到达时返回它们的情况。spi_fetchrow spi_query 一起使用。以下示例说明了如何将它们一起使用:

CREATE TYPE foo_type AS (the_num INTEGER, the_text TEXT);

CREATE OR REPLACE FUNCTION lotsa_md5 (INTEGER) RETURNS SETOF foo_type AS $$
    use Digest::MD5 qw(md5_hex);
    my $file = '/usr/share/dict/words';
    my $t = localtime;
    elog(NOTICE, "opening file $file at $t" );
    open my $fh, '<', $file # ooh, it's a file access!
        or elog(ERROR, "cannot open $file for reading: $!");
    my @words = <$fh>;
    close $fh;
    $t = localtime;
    elog(NOTICE, "closed file $file at $t");
    chomp(@words);
    my $row;
    my $sth = spi_query("SELECT * FROM generate_series(1,$_[0]) AS b(a)");
    while (defined ($row = spi_fetchrow($sth))) {
        return_next({
            the_num => $row->{a},
            the_text => md5_hex($words[rand @words])
        });
    }
    return;
$$ LANGUAGE plperlu;

SELECT * from lotsa_md5(500);

通常,应该重复调用 spi_fetchrow 直到它返回 undef,表示没有更多可读取的行。spi_query 返回的光标在 spi_fetchrow 返回 undef 时会自动释放。如果您不想读取所有行,请调用 spi_cursor_close 来释放光标。否则将导致内存泄漏。

spi_prepare(command, argument types)
spi_query_prepared(plan, arguments)
spi_exec_prepared(plan [, attributes], arguments)
spi_freeplan(plan)

spi_preparespi_query_preparedspi_exec_preparedspi_freeplan 实现相同的功能,但用于预准备查询。spi_prepare 接受一个带有编号参数占位符($1、$2 等)的查询字符串和一个参数类型的字符串列表:

$plan = spi_prepare('SELECT * FROM test WHERE id > $1 AND name = $2',
                                                     'INTEGER', 'TEXT');

通过调用 spi_prepare 准备好查询计划后,该计划可以代替字符串查询,无论是用于 spi_exec_prepared(结果与 spi_exec_query 返回的结果相同),还是用于 spi_query_prepared(它返回一个与 spi_query 完全相同的游标,该游标稍后可以传递给 spi_fetchrow)。spi_exec_prepared 的可选第二个参数是一个属性的哈希引用;当前支持的唯一属性是 limit,它设置从查询返回的最大行数。省略 limit 或将其指定为零表示不限制行数。

预准备查询的优势在于可以为一个以上的查询执行使用一个预准备计划。在不再需要该计划后,可以使用 spi_freeplan 来释放它。

CREATE OR REPLACE FUNCTION init() RETURNS VOID AS $$
        $_SHARED{my_plan} = spi_prepare('SELECT (now() + $1)::date AS now',
                                        'INTERVAL');
$$ LANGUAGE plperl;

CREATE OR REPLACE FUNCTION add_time( INTERVAL ) RETURNS TEXT AS $$
        return spi_exec_prepared(
                $_SHARED{my_plan},
                $_[0]
        )->{rows}->[0]->{now};
$$ LANGUAGE plperl;

CREATE OR REPLACE FUNCTION done() RETURNS VOID AS $$
        spi_freeplan( $_SHARED{my_plan});
        undef $_SHARED{my_plan};
$$ LANGUAGE plperl;

SELECT init();
SELECT add_time('1 day'), add_time('2 days'), add_time('3 days');
SELECT done();

  add_time  |  add_time  |  add_time
------------+------------+------------
 2005-12-10 | 2005-12-11 | 2005-12-12

请注意,spi_prepare 中的参数下标是通过 $1、$2、$3 等定义的,因此请避免在双引号中声明查询字符串,这很容易导致难以发现的 bug。

另一个示例说明了 spi_exec_prepared 中可选参数的用法:

CREATE TABLE hosts AS SELECT id, ('192.168.1.'||id)::inet AS address
                      FROM generate_series(1,3) AS id;

CREATE OR REPLACE FUNCTION init_hosts_query() RETURNS VOID AS $$
        $_SHARED{plan} = spi_prepare('SELECT * FROM hosts
                                      WHERE address << $1', 'inet');
$$ LANGUAGE plperl;

CREATE OR REPLACE FUNCTION query_hosts(inet) RETURNS SETOF hosts AS $$
        return spi_exec_prepared(
                $_SHARED{plan},
                {limit => 2},
                $_[0]
        )->{rows};
$$ LANGUAGE plperl;

CREATE OR REPLACE FUNCTION release_hosts_query() RETURNS VOID AS $$
        spi_freeplan($_SHARED{plan});
        undef $_SHARED{plan};
$$ LANGUAGE plperl;

SELECT init_hosts_query();
SELECT query_hosts('192.168.1.0/30');
SELECT release_hosts_query();

    query_hosts
-----------------
 (1,192.168.1.1)
 (2,192.168.1.2)
(2 rows)
spi_commit()
spi_rollback()

提交或回滚当前事务。这只能在从顶层调用的过程中或匿名代码块(DO 命令)中调用。(请注意,无法通过 spi_exec_query 或类似方法运行 COMMITROLLBACK SQL 命令。必须使用这些函数来完成。)事务结束后,会自动启动一个新事务,因此没有单独的函数来处理。

以下是一个例子

CREATE PROCEDURE transaction_test1()
LANGUAGE plperl
AS $$
foreach my $i (0..9) {
    spi_exec_query("INSERT INTO test1 (a) VALUES ($i)");
    if ($i % 2 == 0) {
        spi_commit();
    } else {
        spi_rollback();
    }
}
$$;

CALL transaction_test1();

43.3.2. PL/Perl 中的实用函数 #

elog(level, msg)

发出日志或错误消息。可能的级别有 DEBUGLOGINFONOTICEWARNINGERRORERROR 会引发错误条件;如果它未被周围的 Perl 代码捕获,该错误将传播到调用查询,导致当前事务或子事务被中止。这实际上与 Perl 的 die 命令相同。其他级别只会生成不同优先级的消息。是否将特定优先级的消息报告给客户端、写入服务器日志或两者兼有,由 log_min_messagesclient_min_messages 配置变量控制。有关更多信息,请参阅 第 19 章

quote_literal(string)

返回给定字符串的适当引用,以便在 SQL 语句字符串中用作字符串字面量。嵌入的单引号和反斜杠会被正确地加倍。请注意,quote_literalundef 输入返回 undef;如果参数可能为 undef,则 quote_nullable 通常更合适。

quote_nullable(string)

返回给定字符串的适当引用,以便在 SQL 语句字符串中用作字符串字面量;或者,如果参数是 undef,则返回未引用的字符串 "NULL"。嵌入的单引号和反斜杠会被正确地加倍。

quote_ident(string)

返回给定字符串的适当引用,以便在 SQL 语句字符串中用作标识符。只有在必要时(即,如果字符串包含非标识符字符或会被折叠大小写)才会添加引号。嵌入的引号会被正确地加倍。

decode_bytea(string)

返回给定字符串内容所表示的未转义的二进制数据,该字符串应为 bytea 编码。

encode_bytea(string)

返回给定字符串内容的 bytea 编码格式的二进制数据。

encode_array_literal(array)
encode_array_literal(array, delimiter)

将引用数组的内容作为字符串返回,格式为数组字面量(参见 8.15.2. 数组值输入)。如果参数不是数组引用,则原样返回参数值。数组字面量元素之间的分隔符默认为 ", ",如果未指定分隔符或分隔符为 undef

encode_typed_literal(value, typename)

将 Perl 变量转换为第二个参数指定的类型的值,并返回该值的字符串表示。正确处理嵌套数组和复合类型的值。

encode_array_constructor(array)

将引用数组的内容作为字符串返回,格式为数组构造函数(参见 4.2.12. 数组构造函数)。单个值使用 quote_nullable 进行引用。如果参数不是数组引用,则返回该参数值,并使用 quote_nullable 进行引用。

looks_like_number(string)

如果给定字符串的内容看起来像数字(根据 Perl 的判断),则返回 true 值,否则返回 false。如果参数为 undef,则返回 undef。忽略前导和尾随空格。InfInfinity 被视为数字。

is_array_ref(argument)

如果给定参数可以被视为数组引用,则返回 true 值,即参数的 refARRAYPostgreSQL::InServer::ARRAY。否则返回 false。

提交更正

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