2024 年 9 月 26 日: PostgreSQL 17 发布!
支持版本:当前 (17) / 16 / 15 / 14 / 13 / 12
开发版本:devel
不支持的版本: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(查询 [, 限制])

spi_exec_query 执行 SQL 命令并将整个行集返回为对哈希引用数组的引用。如果指定了 限制 并且大于零,则 spi_exec_query 最多检索 限制 行,就像查询包含 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(命令)
spi_fetchrow(游标)
spi_cursor_close(游标)

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_fetchrow 返回 undef 时,spi_query 返回的游标会自动释放。如果您不希望读取所有行,请改用 spi_cursor_close 释放游标。如果这样做会导致内存泄漏。

spi_prepare(命令, 参数类型)
spi_query_prepared(计划, 参数)
spi_exec_prepared(计划 [, 属性], 参数)
spi_freeplan(计划)

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_fetchrowspi_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 等定义的,因此避免在双引号中声明查询字符串,因为这很容易导致难以捕获的错误。

另一个示例说明了 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 或类似命令运行 SQL 命令 COMMITROLLBACK。必须使用这些函数。)在事务结束之后,会自动启动新事务,因此没有专门的函数用于此操作。

以下是一个示例

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(级别, 消息)

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

quote_literal(字符串)

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

quote_nullable(字符串)

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

quote_ident(字符串)

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

decode_bytea(字符串)

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

encode_bytea(字符串)

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

encode_array_literal(数组)
encode_array_literal(数组, 分隔符)

将引用数组的内容作为字符串返回,以数组文字格式(请参阅 第 8.15.2 节)。如果它不是对数组的引用,则返回未改变的参数值。如果未指定分隔符或分隔符为 undef,则数组文字中元素之间使用的分隔符默认为“,”。

encode_typed_literal(, 类型名)

将 Perl 变量转换为作为第二个参数传递的数据类型的 value,并返回此 value 的字符串表示形式。正确处理嵌套数组和复合类型的 value。

encode_array_constructor(数组)

将引用数组的内容作为字符串返回,以数组构造器格式(请参阅 第 4.2.12 节)。使用 quote_nullable 对各个 value 加引号。如果它不是对数组的引用,则返回使用 quote_nullable 加引号的参数值。

looks_like_number(string)

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

is_array_ref(argument)

如果给定参数可以被视为数组引用,即参数的 ref 为 ARRAYPostgreSQL::InServer::ARRAY,则返回真值。否则返回假值。

提交更正

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