41.5. 例子

这是一个非常简单的 SPI 使用的例子。 过程 execq 在其第一个参数里接收一个 SQL 命令， 第二个参数接收一个行计数， 用 SPI_exec 执行这个查询并且返回查询执行过的记录个数。 你可以在 src/test/regress/regress.c 和 contrib/spi 里找更复杂的例子。

#include "executor/spi.h"   /* 使用 SPI 时需要的头文件 */

int execq(text *sql, int cnt);

int
execq(text *sql, int cnt)
{
    char *command;
    int ret;
    int proc;

    /* 把给出的 text 对象转换成 C 字串 */
    query = DatumGetCString(DirectFunctionCall1(textout,
                                                PointerGetDatum(sql)));

    SPI_connect();
    
    ret = SPI_exec(command, cnt);
    
    proc = SPI_processed;
    /*
     * 如果这是 SELECT 并且取出了一些元组 - 
     * 通过 elog (INFO) 向调用者 RETURNS 元组
     */
    if ( ret == SPI_OK_SELECT && SPI_processed > 0 )
    {
        TupleDesc tupdesc = SPI_tuptable->tupdesc;
        SPITupleTable *tuptable = SPI_tuptable;
        char buf[8192];
        int i,j;
        
        for (j = 0; j < proc; j++)
        {
            HeapTuple tuple = tuptable->vals[j];
            
            for (i = 1, buf[0] = 0; i <= tupdesc->natts; i++)
                spnrintf(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 的接口。）

下面是你在把函数编译成共享库之后声明它的方法：

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

下面是一个会话例子：

=> SELECT execq('CREATE TABLE a (x integer)', 0);
 execq
-------
     0
(1 row)

=> INSERT INTO a VALUES (execq('INSERT INTO a VALUES (0)', 0));
INSERT 167631 1
=> SELECT execq('SELECT * FROM a', 0);
INFO:  EXECQ:  0    -- execq 插入 0 行
INFO:  EXECQ:  1    -- execq 返回，被上层 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 167712 1
=> SELECT * FROM a;
 x
---
 1                  -- 在 (0) + 1 里面没有行
(1 row)

=> INSERT INTO a VALUES (execq('SELECT * FROM a', 0) + 1);
INFO:  EXECQ:  0
INSERT 167713 1
=> SELECT * FROM a;
 x
---
 1
 2                  -- 在 a + 1 里面有一行
(2 rows)

-- This demonstrates the data changes visibility rule:

=> 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 行   (2 + 1 刚刚插入的) * 2 (第二行里的 x)
(4 rows)               ^^^^^^
                       在不同的调用里 execq() 看到的东西不同