table of contents
SPI_EXECUTE_PLAN_WITH_PARAMLIST(3) | PostgreSQL 17.2 Documentation | SPI_EXECUTE_PLAN_WITH_PARAMLIST(3) |
NAME¶
SPI_execute_plan_with_paramlist - execute a statement prepared by SPI_prepare
SYNOPSIS¶
int SPI_execute_plan_with_paramlist(SPIPlanPtr plan,
ParamListInfo params,
bool read_only,
long count)
DESCRIPTION¶
SPI_execute_plan_with_paramlist executes a statement prepared by SPI_prepare. This function is equivalent to SPI_execute_plan except that information about the parameter values to be passed to the query is presented differently. The ParamListInfo representation can be convenient for passing down values that are already available in that format. It also supports use of dynamic parameter sets via hook functions specified in ParamListInfo.
This function is now deprecated in favor of SPI_execute_plan_extended.
ARGUMENTS¶
SPIPlanPtr plan
ParamListInfo params
bool read_only
long count
RETURN VALUE¶
The return value is the same as for SPI_execute_plan.
SPI_processed and SPI_tuptable are set as in SPI_execute_plan if successful.
2024 | PostgreSQL 17.2 |