43.3. 内置函数 #
43.3.1. 从 PL/Perl 访问数据库 #
可以通过下列函数在 Perl 函数中访问数据库本身:
-
#spi_exec_query(query[,limit]) spi_exec_query执行 SQL 命令,并把整个行集作为 hash 引用数组的引用返回。如果指定了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_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_fetchrow,直到它返回undef,这表示已经没有更多行可读。当spi_fetchrow返回undef时,spi_query返回的游标会被自动释放。如果不打算读取所有行,则应调用spi_cursor_close释放游标。否则会导致内存泄漏。-
spi_prepare(command,argument types)
spi_query_prepared(plan,arguments)
spi_exec_prepared(plan[,attributes],arguments)
#spi_freeplan(plan) spi_prepare、spi_query_prepared、spi_exec_prepared和spi_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的可选第二个参数是属性 hash 引用;目前唯一支持的属性是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或类似函数执行COMMIT或ROLLBACK这类 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) 发出日志消息或错误信息。可用级别包括
DEBUG、LOG、INFO、NOTICE、WARNING以及ERROR。ERROR会引发错误条件;如果周围的 Perl 代码没有捕获它,错误就会传播到调用查询,导致当前事务或子事务被中止。这实质上等同于 Perl 的die命令。其他级别只会生成不同优先级的消息。某一优先级的消息是报告给客户端、写入服务器日志,还是两者兼有,由配置变量 log_min_messages 和 client_min_messages 控制。详见第 19 章。-
#quote_literal(string) 返回给定字符串适当加引号后的形式,以便把它用作 SQL 语句字符串中的字符串字面量。嵌入的单引号和反斜线会被正确地双写。注意,对于 undef 输入,
quote_literal会返回 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 的规则看,给定字符串的内容像数字,则返回真值,否则返回假值。如果参数为 undef,则返回 undef。前导和尾随空格会被忽略。
Inf和Infinity被视为数字。-
#is_array_ref(argument) 如果给定参数可被视为数组引用,则返回真值;也就是该参数的
ref值为ARRAY或PostgreSQL::InServer::ARRAY。否则返回假值。