Redrock Postgres 搜索 英文
版本: 9.3 / 9.4 / 9.5 / 9.6 / 10 / 11 / 12 / 13 / 14 / 15 / 16

45.3. 内置函数 #

45.3.1. 从 PL/Perl 访问数据库
45.3.2. PL/Perl 中的实用函数

45.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_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_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 等定义,因此避免在双引号中声明查询字符串,这可能很容易导致难以发现的错误。

另一个示例说明了在 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();

45.3.2. PL/Perl 中的实用程序函数 #

elog(level, msg)

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

quote_literal(string)

返回给定字符串,该字符串经过适当引用,可作为 SQL 语句字符串中的字符串文字使用。嵌入的单引号和反斜杠已正确加倍。请注意,quote_literal 在 undef 输入时返回 undef;如果参数可能是 undef,quote_nullable 通常更合适。

quote_nullable(string)

返回给定字符串,该字符串经过适当引用,可作为 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 变量转换为作为第二个参数传递的数据类型的值,并返回此值的字符串表示形式。正确处理嵌套数组和复合类型的值。

encode_array_constructor(数组)

以数组构造函数格式返回引用的数组的内容(参见 第 4.2.12 节)。使用 quote_nullable 对各个值进行引用。如果它不是对数组的引用,则返回使用 quote_nullable 引用的参数值。

looks_like_number(字符串)

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

is_array_ref(argument)

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