45.3. 内建函数
45.3.1. 从 PL/Perl 访问数据库
可以通过下列函数从 Perl 函数中访问数据库本身：
spi_exec_query(query [, max-rows]) : spi_exec_query执行一个 SQL 命令并且以哈希引用数组 的引用的形式返回整个行集。**只有在知道结果集相对较小时才 应该使用这个命令。**这里是一个带有可选最大行数的查询（ SELECT命令）的例子：
```programlisting
$rv = spi_exec_query('SELECT * FROM my_table', 5);
```
这会从表`my_table`.返回最多 5 行。如果
`my_table`有一个列`my_column`，
可以从结果的`$i`行得到值：
```programlisting
$foo = $rv->{rows}[$i]->{my_column};
```
可以这样访问从一个`SELECT`查询返回
的总行数：
```programlisting
$nrows = $rv->{processed}
```
这里是使用不同命令类型的一个例子：
```programlisting
$query = "INSERT INTO my_table VALUES (1, 'test')";
$rv = spi_exec_query($query);
```
你可以这样访问命令状态（例如`SPI_OK_INSERT`）：
```programlisting
$res = $rv->{status};
```
要得到受影响的行数：
```programlisting
$nrows = $rv->{processed};
```
这里是一个完整的例子：
```programlisting
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一起工作。下面的例子展示了如何使用 它们：
```programlisting
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 等）以及参数类型的字符串 列表：
```programlisting
$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`，它限定了一个查询返回的最大
行数。
预备查询的有点是可以把一个准备好的计划用于多次查询执行。不再需要该计划后，
可以用`spi_freeplan`释放它：
```programlisting
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`中可选参数用法的例子：
```programlisting
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。这样的工作只能使用这些函数完成）。在一个事务结束后，一个新的事务会自动开始，因此没有单独的函数来开始新事务。
这里是一个例子：
```programlisting
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) : 发出一个日志或者错误消息。可用的级别有 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) : 如果给定参数可以被当作一个数组引用对待则返回真值，即该参数的定义为 ARRAY或者PostgreSQL::InServer::ARRAY时返回 真。否则返回假。