SPI_execute_extended
SPI_execute_extended — выполнить команду с выделенными параметрами
Синтаксис
int SPI_execute_extended(const char *command, const SPIExecuteOptions *options)
Описание
SPI_execute_extended выполняет команду, которая может включать ссылки на параметры, передаваемые извне. В тексте команды параметры обозначаются символами $; тип и значение каждого такого параметра предоставляются в объекте noptions->params (если он передаётся). В options также могут передаваться различные параметры выполнения.
Как правило, в объекте options->params все параметры должны иметь пометку PARAM_FLAG_CONST, поскольку для запроса всегда используется одноразовый план.
Если значение options->dest не NULL, то результирующие кортежи передаются в этот объект по мере их формирования исполнителем, а не накапливаются в SPI_tuptable. Подготовить и использовать объект DestReceiver особенно полезно для запросов, при выполнении которых можно получить множество кортежей, так как этот объект позволяет обрабатывать данные «на лету», не дожидаясь их накопления в памяти.
Аргументы
const char *commandстрока команды
const SPIExecuteOptions *optionsструктура, содержащая необязательные аргументы
Структуру options всегда следует сначала полностью заполнять нулями, а затем уже задавать необходимые значения. Это гарантирует совместимость с будущими изменениями в коде: при добавлении в эту структуру любых новых полей нулевое значение будет определять старое поведение. Сейчас в options есть такие поля:
ParamListInfoparamsструктура данных, содержащая типы и значения параметров запроса; NULL, если их нет
boolread_onlytrueдля режима выполнения «только чтение»boolallow_nonatomictrueдля неатомарного выполнения операторов CALL и DO (но это поле игнорируется, если функцииSPI_connect_extне был передан флагSPI_OPT_NONATOMIC)boolmust_return_tuplesесли
true, вызывает ошибку для типов запросов, не возвращающих кортежи (за исключением случая, когда возвращаются нулевые кортежи)uint64tcountмаксимальное число строк, которое должно быть возвращено; с
0ограничения нетDestReceiver *destобъект
DestReceiver, получающий все кортежи, которые выдаёт запрос; если NULL, результирующие кортежи накапливаются вSPI_tuptable, как при выполненииSPI_executeResourceOwnerownerЭто поле присутствует для согласованности с
SPI_execute_plan_extended, но игнорируется, поскольку используемыйSPI_execute_extendedплан никогда не сохраняется.
Возвращаемое значение
Возвращаемые значения те же, что и у SPI_execute.
Если options->dest имеет значение NULL, то SPI_processed и SPI_tuptable устанавливаются как при выполнении SPI_execute. Если options->dest — не NULL, то SPI_processed принимает нулевое значение, а SPI_tuptable — NULL. Если необходимо подсчитать число кортежей, это нужно сделать в коде объекта DestReceiver.
SPI_execute_extended
SPI_execute_extended — execute a command with out-of-line parameters
Synopsis
int SPI_execute_extended(const char *command, const SPIExecuteOptions *options)
Description
SPI_execute_extended executes a command that might include references to externally supplied parameters. The command text refers to a parameter as $, and the noptions->params object (if supplied) provides values and type information for each such symbol. Various execution options can be specified in the options struct, too.
The options->params object should normally mark each parameter with the PARAM_FLAG_CONST flag, since a one-shot plan is always used for the query.
If options->dest is not NULL, then result tuples are passed to that object as they are generated by the executor, instead of being accumulated in SPI_tuptable. Using a caller-supplied DestReceiver object is particularly helpful for queries that might generate many tuples, since the data can be processed on-the-fly instead of being accumulated in memory.
Arguments
const char *commandcommand string
const SPIExecuteOptions *optionsstruct 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:
ParamListInfoparamsdata structure containing query parameter types and values; NULL if none
boolread_onlytruefor read-only executionboolallow_nonatomictrueallows non-atomic execution of CALL and DO statements (but this field is ignored unless theSPI_OPT_NONATOMICflag was passed toSPI_connect_ext)boolmust_return_tuplesif
true, raise error if the query is not of a kind that returns tuples (this does not forbid the case where it happens to return zero tuples)uint64tcountmaximum number of rows to return, or
0for no limitDestReceiver *destDestReceiverobject that will receive any tuples emitted by the query; if NULL, result tuples are accumulated into aSPI_tuptablestructure, as inSPI_executeResourceOwnerownerThis field is present for consistency with
SPI_execute_plan_extended, but it is ignored, since the plan used bySPI_execute_extendedis never saved.
Return Value
The return value is the same as for SPI_execute.
When options->dest is NULL, SPI_processed and SPI_tuptable are set as in SPI_execute. When options->dest is not NULL, SPI_processed is set to zero and SPI_tuptable is set to NULL. If a tuple count is required, the caller's DestReceiver object must calculate it.
