SPI_execute_plan_extended
SPI_execute_plan_extended — выполнить оператор, подготовленный функцией SPI_prepare
Синтаксис
int SPI_execute_plan_extended(SPIPlanPtrplan, const SPIExecuteOptions *options)
Описание
SPI_execute_plan_extended выполняет оператор, подготовленный функцией SPI_prepare или родственными ей. Данная функция равнозначна SPI_execute_plan, не считая того, что по-другому представляется информация о значениях параметров, передаваемых запросу. Также ей могут передаваться дополнительные параметры для управления выполнением запроса.
Значения параметров запроса передаются в структуре ParamListInfo; это удобно, когда имеющиеся значения уже представлены в этом формате. Через функции-обработчики, устанавливаемые в ParamListInfo, можно также передавать динамические наборы параметров.
Кроме того, кортежи результата могут не только накапливаться в структуре SPI_tuptable, но и передаваться заданному вызывающим кодом объекту DestReceiver по мере формирования очередного кортежа исполнителем. Особенно полезно использовать этот объект в запросах, которые могут выдать множество кортежей, поскольку данные будут обрабатываться «на лету», а не накапливаться в памяти.
Аргументы
SPIPlanPtrplanподготовленный оператор (возвращаемый функцией
SPI_prepare)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_execute_planResourceOwnerownerВладелец ресурса, который будет содержать счётчик ссылок на план во время его выполнения. Если NULL, используется текущий владелец ресурса. Параметр игнорируется для несохранённых планов, поскольку SPI не получает счётчики ссылок на них.
Возвращаемое значение
Возвращаемые значения те же, что и у SPI_execute_plan.
Если options->dest имеет значение NULL, SPI_processed и SPI_tuptable устанавливаются как при выполнении SPI_execute_plan. Если options->dest — не NULL, то SPI_processed принимает нулевое значение, а SPI_tuptable — NULL. Если необходимо подсчитать число кортежей, это нужно сделать в коде объекта DestReceiver.
SPI_execute_plan_extended
SPI_execute_plan_extended — execute a statement prepared by SPI_prepare
Synopsis
int SPI_execute_plan_extended(SPIPlanPtrplan, const SPIExecuteOptions *options)
Description
SPI_execute_plan_extended executes a statement prepared by SPI_prepare or one of its siblings. This function is equivalent to SPI_execute_plan, except that information about the parameter values to be passed to the query is presented differently, and additional execution-controlling options can be passed.
Query parameter values are represented by a ParamListInfo struct, which is convenient for passing down values that are already available in that format. Dynamic parameter sets can also be used, via hook functions specified in ParamListInfo.
Also, instead of always accumulating the result tuples into a SPI_tuptable structure, tuples can be passed to a caller-supplied DestReceiver object as they are generated by the executor. This 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
SPIPlanPtrplanprepared statement (returned by
SPI_prepare)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_execute_planResourceOwnerownerThe resource owner that will hold a reference count on the plan while it is executed. If NULL, CurrentResourceOwner is used. Ignored for non-saved plans, as SPI does not acquire reference counts on those.
Return Value
The return value is the same as for SPI_execute_plan.
When options->dest is NULL, SPI_processed and SPI_tuptable are set as in SPI_execute_plan. 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.
