Esta seção contém um exemplo muito simples de uso da
SPI.
A função execq escrita na linguagem
C recebe um comando SQL como
primeiro argumento, e uma contagem de linhas como segundo argumento,
executa o comando usando SPI_exec, e retorna o
número de linhas processadas pelo comando.
Podem ser encontrados exemplos mais complexos para SPI
na árvore de distribuição do código-fonte em
src/test/regress/regress.c, e no módulo
spi
[132].
#include "postgres.h"
#include "executor/spi.h"
#include "utils/builtins.h"
PG_MODULE_MAGIC;
PG_FUNCTION_INFO_V1(execq);
Datum
execq(PG_FUNCTION_ARGS)
{
char *command;
int cnt;
int ret;
uint64 proc;
/*
* Converter o objeto de texto fornecido em uma
* cadeia de caracteres C
*/
command = text_to_cstring(PG_GETARG_TEXT_PP(0));
cnt = PG_GETARG_INT32(1);
SPI_connect();
ret = SPI_exec(command, cnt);
proc = SPI_processed;
/*
* Se foram trazidas algumas linhas, mostrar via elog(INFO).
*/
if (ret > 0 && SPI_tuptable != NULL)
{
SPITupleTable *tuptable = SPI_tuptable;
TupleDesc tupdesc = tuptable->tupdesc;
char buf[8192];
uint64 j;
for (j = 0; j < tuptable->numvals; 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);
PG_RETURN_INT64(proc);
}
É assim que se declara a função depois de compilá-la em uma biblioteca compartilhada (os detalhes estão em Compilação e ligação de funções carregadas dinamicamente.):
CREATE FUNCTION execq(text, integer) RETURNS int8
AS 'filename'
LANGUAGE C STRICT;
A seguir está um exemplo de sessão:
SELECT execq('CREATE TABLE a (x integer)', 0);
execq
-------
0
(1 linha)
INSERT INTO a VALUES (execq('INSERT INTO a VALUES (0)', 0));
INSERT 0 1
SELECT execq('SELECT * FROM a', 0);
INFO: EXECQ: 0 -- inserido por execq INFO: EXECQ: 1 -- retornado por execq e inserido pelo INSERT anterior execq ------- 2 (1 linha)
SELECT execq('INSERT INTO a SELECT x + 2 FROM a RETURNING *', 1);
INFO: EXECQ: 2 -- 0 + 2, então a execução foi interrompida pela contagem
execq
-------
1
(1 linha)
SELECT execq('SELECT * FROM a', 10);
INFO: EXECQ: 0
INFO: EXECQ: 1
INFO: EXECQ: 2
execq
-------
3 -- 10 é o valor máximo apenas, 3 é o número real de linhas
(1 linha)
SELECT execq('INSERT INTO a SELECT x + 10 FROM a', 1);
execq
-------
3 -- todas as linhas processadas; a contagem não interrompe o processo, porque nada é retornado.
(1 linha)
SELECT * FROM a;
x ---- 0 1 2 10 11 12 (6 linhas)
DELETE FROM a; DELETE 6 INSERT INTO a VALUES (execq('SELECT * FROM a', 0) + 1); INSERT 0 1 SELECT * FROM a;
x
---
1 -- 0 (nenhuma linha em a) + 1
(1 linha)
INSERT INTO a VALUES (execq('SELECT * FROM a', 0) + 1);
INFO: EXECQ: 1
INSERT 0 1
SELECT * FROM a;
x
---
1
2 -- 1 (existia uma linha em a) + 1
(2 linhas)
-- Isto demonstra a regra de visibilidade das alterações de dados. -- execq é chamada duas vezes e recebe um número diferente de linhas em cada chamada: INSERT INTO a SELECT execq('SELECT * FROM a', 0) * x FROM a;
INFO: EXECQ: 1 -- resultado da primeira execq INFO: EXECQ: 2 INFO: EXECQ: 1 -- resultado da segunda execq INFO: EXECQ: 2 INFO: EXECQ: 2 INSERT 0 2
SELECT * FROM a;
x --- 1 2 2 -- 2 linhas * 1 (x na primeira linha) 6 -- 3 linhas (2 + 1 recém-inserido) * 2 (x na segunda linha) (4 linhas)
[132]
O código-fonte da função, o arquivo Makefile
e o comando CREATE FUNCTION, que vincula a função
C à função SQL, podem ser
vistos em
Exemplo de uso da SPI (Interface de programação servidor)
no GitLab. (N. T.)