SPI_is_cursor_plan

SPI_is_cursor_plan — retorna verdade se a instrução preparada por SPI_prepare puder ser usada por SPI_cursor_open

Sinopse

bool SPI_is_cursor_plan(SPIPlanPtr plan)

Descrição

A função SPI_is_cursor_plan retorna true se a instrução preparada por SPI_prepare puder ser passada como argumento para a função SPI_cursor_open, ou false se este não for o caso. Os critérios são que plan represente um único comando, e que este comando retorne tuplas para o chamador; por exemplo, SELECT é permitido, a menos que contenha uma cláusula INTO, e UPDATE é permitido somente se contiver uma cláusula RETURNING.

Argumentos

SPIPlanPtr plan

instrução preparada (retornada por SPI_prepare)

Valor retornado

true ou false para indicar se plan pode produzir um cursor ou não, com SPI_result definido como zero. Se não for possível determinar a resposta (por exemplo, se plan for NULL ou inválido, ou se for chamada quando não estiver conectada à SPI), então SPI_result será definido com um código de erro adequado, e retornado false.