从你的 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_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 # 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(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
的可选第二个参数是一个属性的哈希引用;当前唯一支持的属性是 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 命令 COMMIT
或 ROLLBACK
。必须使用这些函数来完成。)在事务结束后,会自动启动新事务,因此没有单独的函数来完成此操作。
以下是一个示例
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();
elog(level
, msg
)
发出日志或错误消息。可能的级别为 DEBUG
、LOG
、INFO
、NOTICE
、WARNING
和 ERROR
。ERROR
引起错误情况;如果周围的 Perl 代码未捕获此错误,则错误会传播到调用查询,导致当前事务或子事务中止。这实际上与 Perl die
命令相同。其他级别仅生成不同优先级的消息。是否将特定优先级的消息报告给客户端、写入服务器日志,或者两者都写入,由 log_min_messages 和 client_min_messages 配置变量控制。有关详细信息,请参见 第 19 章。
quote_literal(string
)
返回给定的字符串,适当地用引号引起来,以便在 SQL 语句字符串中用作字符串字面量。嵌入的单引号和反斜杠会被正确地加倍。请注意,quote_literal
在 undef 输入时返回 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。忽略前导和尾随空格。Inf
和 Infinity
被视为数字。
is_array_ref(argument
)
如果给定参数可以被视为数组引用,也就是说,如果参数的 ref 是 ARRAY
或 PostgreSQL::InServer::ARRAY
,则返回真值。否则返回假值。
如果您发现文档中的任何内容不正确,与您在使用特定功能时的体验不符,或需要进一步澄清,请使用此表单来报告文档问题。