↑↓ 选择 ↵ 打开 ⌫ 改范围 完整检索页

pgsql.cc 提供对 postgresql.org 官网内容的中文翻译,由 Pigsty 团队维护。

不受支持的版本: 8.4 / 8.3 / 8.2 / 8.1 / 8.0 / 7.4 / 7.3
历史版本PostgreSQL 8.2 已于 2011 年 12 月结束社区维护,本页译文保留供仍在使用旧版本的读者参考。新系统请看当前版本手册首页。

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

在 Perl 函数中访问数据库本身,可以通过下面描述的spi_exec_query函数,也可以通过一个实验性模块 DBD::PgSPI (也可以从 CPAN 镜像站点获取)。该模块提供一个符合DBI规范的数据库句柄,名为$pg_dbh,可以用普通的DBI语法执行查询。

PL/Perl 提供下列额外的 Perl 命令:

spi_exec_query(query [, max-rows])
spi_query(command)
spi_fetchrow(cursor)
spi_prepare(command, argument types)
spi_exec_prepared(plan)
spi_query_prepared(plan [, attributes], arguments)
spi_cursor_close(cursor)
spi_freeplan(plan)

spi_exec_query 执行 SQL 命令,并返回整个行集;返回值是对一个数组的引用,数组元素为哈希引用。只有在确定结果集会比较小时,才应使用此命令。下面是一个查询(SELECT 命令)的示例,指定了可选的最大行数:

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

这会返回最多 5 行,来自表 my_table。如果 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_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 # 注意,这里访问了文件!
        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_prepare, spi_query_prepared, spi_exec_prepared,以及 spi_freeplan 实现相同的功能,但用于预备查询。一旦通过调用spi_prepare预备好查询计划,就可以用该计划代替查询字符串:既可以在spi_exec_prepared中使用,其结果与spi_exec_query返回的相同;也可以在spi_query_prepared中使用,它像spi_query一样返回游标,之后可以把该游标传给spi_fetchrow。

预备查询的优点在于,一个准备好的计划可以用于多次查询执行。当计划 不再需要时,可以用 spi_freeplan 将其释放:

CREATE OR REPLACE FUNCTION init() RETURNS INTEGER 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 INTEGER 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_fetchrow,直到它返回 undef,这表示已经没有更多行可读。当 spi_fetchrow 返回 undef 时, 游标会被自动释放。如果不打算读取 所有行,则应调用 spi_cursor_close 释放游标。 否则会导致内存泄漏。

elog(level, msg)

发出日志消息或错误信息。可用级别包括 DEBUG、LOG、INFO、 NOTICE、WARNING以及ERROR。 ERROR 会引发错误条件;如果周围的 Perl 代码没有 捕获它,错误就会传播到调用查询,导致当前事务或子事务被中止。这实质上 等同于 Perl 的 die 命令。其他级别只会生成不同优先级 的消息。某一优先级的消息是报告给客户端、写入服务器日志,还是两者兼有, 由配置变量 log_min_messages 和 client_min_messages 控制。详见 第 17 章。

提交更正

译文有误、术语不当或页面显示问题,请到译文仓库 pgsty/pgdoc 报告译文问题。 英文原文本身的问题,请在当前版本的对应页面向上游反馈;上游不再修订已结束维护的版本。