SPI_prepare_cursor

SPI_prepare_cursor — prepara uma instrução, sem executá-la ainda

Sinopse

SPIPlanPtr SPI_prepare_cursor(const char * command, int nargs,
                              Oid * argtypes, int cursorOptions)

Descrição

A função SPI_prepare_cursor é idêntica à função SPI_prepare, exceto por também permitir a especificação do parâmetro cursorOptions do planejador. Este parâmetro é uma máscara de bits com os valores mostrados no arquivo nodes/parsenodes.h para o campo options da estrutura DeclareCursorStmt. A função SPI_prepare sempre considera as opções do cursor como zero.

Esta função está agora em obsolescência em favor da função SPI_prepare_extended.

Argumentos

const char * command

cadeia de caracteres de comando

int nargs

número de parâmetros de entrada ($1, $2, etc.)

Oid * argtypes

ponteiro para uma matriz contendo os OIDs dos tipos de dados dos parâmetros

int cursorOptions

número inteiro, máscara de bits das opções do cursor; zero produz o comportamento padrão

Valor retornado

A função SPI_prepare_cursor tem as mesmas convenções de retorno que a função SPI_prepare.

Notas

Os bits úteis para definir em cursorOptions incluem CURSOR_OPT_SCROLL, CURSOR_OPT_NO_SCROLL, CURSOR_OPT_FAST_PLAN, CURSOR_OPT_GENERIC_PLAN, e CURSOR_OPT_CUSTOM_PLAN. Note em particular que CURSOR_OPT_HOLD é ignorado.