1SPI_EXECUTE_PLAN_WITH_PARAPMoLsItSgTr(e3S)QL 14.3 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
24       This function is now deprecated in favor of SPI_execute_plan_extended.
25

ARGUMENTS

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

RETURN VALUE

40       The return value is the same as for SPI_execute_plan.
41
42       SPI_processed and SPI_tuptable are set as in SPI_execute_plan if
43       successful.
44
45
46
47PostgreSQL 14.3                      2022   SPI_EXECUTE_PLAN_WITH_PARAMLIST(3)
Impressum