SPI_execute_plan_with_paramlist

Supported versions: Current (18) / 17 / 16 / 15 / 14

Development versions: 19 / 20devel

Unsupported versions: 13 / 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0

Development snapshot. PostgreSQL 20devel has not been released. Content may change.

SPI_execute_plan_with_paramlist
Prev	Up	45.1. Interface Functions	Home	Next

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: prepared statement (returned by SPI_prepare)
ParamListInfo params: data structure containing parameter types and values; NULL if none
bool read_only: true for read-only execution
long count: maximum number of rows to return, or 0 for no limit

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.

Prev	Up	Next
SPI_execute_plan_extended	Home	SPI_execp

Report a documentation issue

Read the upstream documentation. For corrections, first check the current manual.