Postgres Pro Enterprise
1817161514
Postgres Pro Standard
1817161514
PostgreSQL
1817161514
RUENRU EN
SPI_prepare_extended
Пред. Наверх46.1. Интерфейсные функцииНачало След.

SPI_prepare_extended

SPI_prepare_extended — подготовить оператор, но пока не выполнять его

Синтаксис

SPIPlanPtr SPI_prepare_extended(const char * command,
                                const SPIPrepareOptions * options)

Описание

SPI_prepare_extended создаёт и возвращает подготовленный оператор для заданной команды, но не выполняет саму команду. Эта функция равнозначна SPI_prepare, но позволяет вызывающему управлять разбором ссылок на внешние параметры, а также другими аспектами разбора и планирования запросов.

Аргументы

const char * command

строка команды

const SPIPrepareOptions * options

структура, содержащая необязательные аргументы

Структуру options всегда следует сначала полностью заполнять нулями, а затем уже задавать необходимые значения. Это гарантирует совместимость с будущими изменениями в коде: при добавлении в эту структуру любых новых полей нулевое значение будет определять старое поведение. Сейчас в options есть такие поля:

ParserSetupHook parserSetup

Функция настройки обработчиков разбора

void * parserSetupArg

аргумент для сквозной передачи в parserSetup

RawParseMode parseMode

режим для простого разбора; RAW_PARSE_DEFAULT (ноль) выбирает поведение по умолчанию

int cursorOptions

битовая маска параметров курсора; 0 выбирает поведение по умолчанию

Возвращаемое значение

SPI_prepare_extended возвращает результат по тем же соглашениям, что и SPI_prepare.

Пред. Наверх След.
SPI_prepare_cursor Начало SPI_prepare_params
SPI_prepare_extended
Prev Up46.1. Interface FunctionsHome Next

SPI_prepare_extended

SPI_prepare_extended — prepare a statement, without executing it yet

Synopsis

SPIPlanPtr SPI_prepare_extended(const char * command,
                                const SPIPrepareOptions * options)

Description

SPI_prepare_extended creates and returns a prepared statement for the specified command, but doesn't execute the command. This function is equivalent to SPI_prepare, with the addition that the caller can specify options to control the parsing of external parameter references, as well as other facets of query parsing and planning.

Arguments

const char * command

command string

const SPIPrepareOptions * options

struct containing optional arguments

Callers should always zero out the entire options struct, then fill whichever fields they want to set. This ensures forward compatibility of code, since any fields that are added to the struct in future will be defined to behave backwards-compatibly if they are zero. The currently available options fields are:

ParserSetupHook parserSetup

Parser hook setup function

void * parserSetupArg

pass-through argument for parserSetup

RawParseMode parseMode

mode for raw parsing; RAW_PARSE_DEFAULT (zero) produces default behavior

int cursorOptions

integer bit mask of cursor options; zero produces default behavior

Return Value

SPI_prepare_extended has the same return conventions as SPI_prepare.

Prev Up Next
SPI_prepare_cursor Home SPI_prepare_params
FAQ