SPI_cursor_open_with

SPI_cursor_open_with_paramlist
Anterior	Acima	45.1. Funções de interface	Principal	Próxima

SPI_cursor_open_with_paramlist

SPI_cursor_open_with_paramlist — configura um cursor usando parâmetros

Sinopse

Portal SPI_cursor_open_with_paramlist(const char *name,
                                      SPIPlanPtr plan,
                                      ParamListInfo params,
                                      bool read_only)

Descrição

A função SPI_cursor_open_with_paramlist configura um cursor (internamente, um portal) que executa uma instrução preparada por SPI_prepare. Esta função é equivalente à função SPI_cursor_open, exceto que as informações sobre os valores dos parâmetros a serem passados para a consulta são apresentadas de forma diferente. A representação ParamListInfo pode ser conveniente para transmitir valores que já estão disponíveis neste formato. Esta função também dá suporte ao uso de conjuntos de parâmetros dinâmicos por meio de funções de gancho especificadas em ParamListInfo.

Os dados dos parâmetros passados são copiados para o portal do cursor, para poderem ser liberados enquanto o cursor ainda existir.

Argumentos

const char * name: nome para o portal, ou NULL para permitir que o sistema selecione o nome
SPIPlanPtr plan: instrução preparada (retornada por SPI_prepare)
ParamListInfo params: estrutura de dados contendo os tipos de dados e valores dos parâmetros; NULL se nenhum
bool read_only: true para execução de leitura-apenas

Valor retornado

Ponteiro para o portal que contém o cursor. Note não haver convenção de retorno de erro; qualquer erro será relatado via elog.