1SPI_EXECUTE_PLAN_WITH_PARAPMoLsItSgTr(e3S)QL 12.6 DocuSmPeIn_tEaXtEiCoUnTE_PLAN_WITH_PARAMLIST(3)
2
3
4

NAME

6       SPI_execute_plan_with_paramlist - execute a statement prepared by
7       SPI_prepare
8

SYNOPSIS

10       int SPI_execute_plan_with_paramlist(SPIPlanPtr plan,
11                                           ParamListInfo params,
12                                           bool read_only,
13                                           long count)
14

DESCRIPTION

16       SPI_execute_plan_with_paramlist executes a statement prepared by
17       SPI_prepare. This function is equivalent to SPI_execute_plan except
18       that information about the parameter values to be passed to the query
19       is presented differently. The ParamListInfo representation can be
20       convenient for passing down values that are already available in that
21       format. It also supports use of dynamic parameter sets via hook
22       functions specified in ParamListInfo.
23

ARGUMENTS

25       SPIPlanPtr plan
26           prepared statement (returned by SPI_prepare)
27
28       ParamListInfo params
29           data structure containing parameter types and values; NULL if none
30
31       bool read_only
32           true for read-only execution
33
34       long count
35           maximum number of rows to return, or 0 for no limit
36

RETURN VALUE

38       The return value is the same as for SPI_execute_plan.
39
40       SPI_processed and SPI_tuptable are set as in SPI_execute_plan if
41       successful.
42
43
44
45PostgreSQL 12.6                      2021   SPI_EXECUTE_PLAN_WITH_PARAMLIST(3)
Impressum