1SPI_EXECUTE_PLAN(3)     PostgreSQL 9.2.24 Documentation    SPI_EXECUTE_PLAN(3)
2
3
4

NAME

6       SPI_execute_plan - execute a statement prepared by SPI_prepare
7

SYNOPSIS

9       int SPI_execute_plan(SPIPlanPtr plan, Datum * values, const char * nulls,
10                            bool read_only, long count)
11

DESCRIPTION

13       SPI_execute_plan executes a statement prepared by SPI_prepare or one of
14       its siblings.  read_only and count have the same interpretation as in
15       SPI_execute.
16

ARGUMENTS

18       SPIPlanPtr plan
19           prepared statement (returned by SPI_prepare)
20
21       Datum * values
22           An array of actual parameter values. Must have same length as the
23           statement's number of arguments.
24
25       const char * nulls
26           An array describing which parameters are null. Must have same
27           length as the statement's number of arguments.  n indicates a null
28           value (entry in values will be ignored); a space indicates a
29           nonnull value (entry in values is valid).
30
31           If nulls is NULL then SPI_execute_plan assumes that no parameters
32           are null.
33
34       bool read_only
35           true for read-only execution
36
37       long count
38           maximum number of rows to return, or 0 for no limit
39

RETURN VALUE

41       The return value is the same as for SPI_execute, with the following
42       additional possible error (negative) results:
43
44       SPI_ERROR_ARGUMENT
45           if plan is NULL or invalid, or count is less than 0
46
47       SPI_ERROR_PARAM
48           if values is NULL and plan was prepared with some parameters
49
50       SPI_processed and SPI_tuptable are set as in SPI_execute if successful.
51
52
53
54PostgreSQL 9.2.24                 2017-11-06               SPI_EXECUTE_PLAN(3)
Impressum