21.5. 例

このSPIを使った例は可視性規則を説明しています。src/test/regress/regress.cとcontrib/spiに、さらに複雑な例があります。

これは非常に簡単なSPIを使った例です。execqプロシージャは1つ目の引数としてSQL問い合わせを、2つ目の引数としてtcountをとり、SPI_execを使って問い合わせを実行し、問い合わせの対象となったタプルの数を返します。

#include "executor/spi.h" /* SPI を使うためにはこれが必要です */

int execq(text *sql, int cnt);

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

    /* 与えられた TEXT オブジェクトを C の文字列に変換します */
    query = DatumGetCString(DirectFunctionCall1(textout,
                                                PointerGetDatum(sql)));

    SPI_connect();
    
    ret = SPI_exec(query, cnt);
    
    proc = SPI_processed;
     /*
     * SELECT 問い合わせで、複数のタプルが取得された場合、
     * elog(NOTICE) を使って、タプルを呼び出し元に返します。
     */
    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++)
                sprintf(buf + strlen (buf), " %s%s",
                        SPI_getvalue(tuple, tupdesc, i),
                        (i == tupdesc->natts) ? " " : " |");
            elog (NOTICE, "EXECQ: %s", buf);
        }
    }

    SPI_finish();

    pfree(query);

    return (proc);
}

ここでコンパイルを行い、関数を作成します。

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

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

vac=> INSERT INTO a VALUES (execq('INSERT INTO a VALUES (0)',0));
INSERT 167631 1
vac=> SELECT execq('SELECT * FROM a',0);
NOTICE:EXECQ:  0 <<< execq によって挿入されたもの

NOTICE:EXECQ:  1 <<< execq によって返されたものと上の INSERT によって挿入
                     されたもの

execq
-----
    2
(1 row)

vac=> SELECT execq('INSERT INTO a SELECT x + 2 FROM a',1);
execq
-----
    1
(1 row)

vac=> SELECT execq('SELECT * FROM a', 10);
NOTICE:EXECQ:  0 

NOTICE:EXECQ:  1 

NOTICE:EXECQ:  2 <<< 指定された 0 + 2という値の 1 つのタプルのみが挿入
                     されます。

execq
-----
    3            <<<  10 は最大値を示すだけです。実際のタプル数は 3 となります。
(1 row)

vac=> DELETE FROM a;
DELETE 3
vac=> INSERT INTO a VALUES (execq('SELECT * FROM a', 0) + 1);
INSERT 167712 1
vac=> SELECT * FROM a;
x
-
1                <<<  a テーブルにタプルが存在しない状態(0) + 1 を行った結果
(1 row)

vac=> INSERT INTO a VALUES (execq('SELECT * FROM a', 0) + 1);
NOTICE:EXECQ:  0 
INSERT 167713 1
vac=> SELECT * FROM a;
x
-
1
2                <<< a テーブルに既存の 1 つのタプル + 1
(2 rows)

--   これはデータ変更に関する可視性規則を説明します。

vac=> INSERT INTO a SELECT execq('SELECT * FROM a', 0) * x FROM a;
NOTICE:EXECQ:  1 
NOTICE:EXECQ:  2 
NOTICE:EXECQ:  1 
NOTICE:EXECQ:  2 
NOTICE:EXECQ:  2 
INSERT 0 2
vac=> SELECT * FROM a;
x
-
1
2
2                <<< タプル数 2 * 1（2 * 1 番目のタプルの x の値）
6                <<< タプル数 3 * 2（2 + 挿入された 1 * 2 番目のタプルの値）
(4 rows)             ^^^^^^^^^^ 
                     execq()の異なる呼び出しで見ることができるタプル