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 thenoptions->params object (if supplied) provides values and type information for each such symbol. Various execution options can be specified in theoptions struct, too.
Theoptions->params object should normally mark each parameter with thePARAM_FLAG_CONST flag, since a one-shot plan is always used for the query.
Ifoptions->dest is not NULL, then result tuples are passed to that object as they are generated by the executor, instead of being accumulated inSPI_tuptable. Using a caller-suppliedDestReceiver 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 entireoptions 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 availableoptions 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 forSPI_execute.
Whenoptions->dest is NULL,SPI_processed andSPI_tuptable are set as inSPI_execute. Whenoptions->dest is not NULL,SPI_processed is set to zero andSPI_tuptable is set to NULL. If a tuple count is required, the caller'sDestReceiver object must calculate it.