45.5. 例子

这一节包含了 SPI 用法的一个非常简单的例子。过程 execq用一个 SQL 命令作为其第一个参数 并且用一个行计数作为第二个参数,使用 SPI_exec执行该命令并且返回被该该命令 处理过的行的数量。你可以在源代码树的 src/test/regress/regress.c和 spi模块中找到 SPI 的更复杂的例子。

#include "postgres.h"
#include "executor/spi.h"
#include "utils/builtins.h"
#ifdef PG_MODULE_MAGIC
PG_MODULE_MAGIC;
#endif
int64 execq(text *sql, int cnt);
int64
execq(text *sql, int cnt)
{
 char *command;
 int ret;
 uint64 proc;
 /* 把给定的文本对象转换成一个 C 字符串 */
 command = text_to_cstring(sql);
 SPI_connect();
 ret = SPI_exec(command, cnt);
 proc = SPI_processed;
 /*
 * 如果取出了一些行,通过 elog(INFO) 打印它们。
 */
 if (ret > 0 && SPI_tuptable != NULL)
 {
 TupleDesc tupdesc = SPI_tuptable->tupdesc;
 SPITupleTable *tuptable = SPI_tuptable;
 char buf[8192];
 uint64 j;
 for (j = 0; j < proc; j++)
 {
 HeapTuple tuple = tuptable->vals[j];
 int i;
 for (i = 1, buf[0] = 0; i <= tupdesc->natts; i++)
 snprintf(buf + strlen (buf), sizeof(buf) - strlen(buf), " %s%s",
 SPI_getvalue(tuple, tupdesc, i),
 (i == tupdesc->natts) ? " " : " |");
 elog(INFO, "EXECQ: %s", buf);
 }
 }
 SPI_finish();
 pfree(command);
 return (proc);
}

(为了便于理解,这个函数使用了调用习惯版本 0。在实际的应用中, 你应该使用新的版本 1 接口)。

在把该函数编译到一个共享库中(详见第 36.9.6 节)之 后,这样声明该函数:

CREATE FUNCTION execq(text, integer) RETURNS int8
 AS 'filename'
 LANGUAGE C STRICT;

下面是一个会话实例:

=> SELECT execq('CREATE TABLE a (x integer)', 0);
 execq
-------
 0
(1 row)
=> INSERT INTO a VALUES (execq('INSERT INTO a VALUES (0)', 0));
INSERT 0 1
=> SELECT execq('SELECT * FROM a', 0);
INFO: EXECQ: 0 -- inserted by execq
INFO: EXECQ: 1 -- returned by execq and inserted by upper INSERT
 execq
-------
 2
(1 row)
=> SELECT execq('INSERT INTO a SELECT x + 2 FROM a', 1);
 execq
-------
 1
(1 row)
=> SELECT execq('SELECT * FROM a', 10);
INFO: EXECQ: 0
INFO: EXECQ: 1
INFO: EXECQ: 2 -- 0 + 2,按照所指定的,只有一行被插入
 execq
-------
 3 -- 10 只是最大值,3 是实际的行数
(1 row)
=> DELETE FROM a;
DELETE 3
=> INSERT INTO a VALUES (execq('SELECT * FROM a', 0) + 1);
INSERT 0 1
=> SELECT * FROM a;
 x
---
 1 -- 没有行在 a (0) + 1
(1 row)
=> INSERT INTO a VALUES (execq('SELECT * FROM a', 0) + 1);
INFO: EXECQ: 1
INSERT 0 1
=> SELECT * FROM a;
 x
---
 1
 2 -- 有一行在 in a + 1
(2 rows)
-- 这证明了数据改变可见性规则:
=> INSERT INTO a SELECT execq('SELECT * FROM a', 0) * x FROM a;
INFO: EXECQ: 1
INFO: EXECQ: 2
INFO: EXECQ: 1
INFO: EXECQ: 2
INFO: EXECQ: 2
INSERT 0 2
=> SELECT * FROM a;
 x
---
 1
 2
 2 -- 2 行 * 1 (第一行中的 x)
 6 -- 3 rows (2 + 1 被插入) * 2 (第二行中的 x)
(4 rows) ^^^^^^
 不同调用中 execq() 的行可见性