PostgreSQL :: Tecnisys Docs

SPI_execute_plan_with_paramlist
Prev	Up	46.1. Interface Functions	Home	Next

SPI_execute_plan_with_paramlist

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.

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	Home	SPI_execp

Home

SPI_execp

Submit correction

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.

Privacy Policy | Code of Conduct | About PostgreSQL | Contact