SPI_execute_plan
SPI_execute_plan — execute a statement prepared bySPI_prepare
Synopsis
int SPI_execute_plan(SPIPlanPtrplan, Datum *values, const char *nulls, boolread_only, longcount)
Description
SPI_execute_plan executes a statement prepared bySPI_prepare or one of its siblings.read_only andcount have the same interpretation as inSPI_execute.
Arguments
SPIPlanPtrplanprepared statement (returned by
SPI_prepare)Datum *valuesAn array of actual parameter values. Must have same length as the statement's number of arguments.
const char *nullsAn array describing which parameters are null. Must have same length as the statement's number of arguments.
If
nullsisNULLthenSPI_execute_planassumes that no parameters are null. Otherwise, each entry of thenullsarray should be' 'if the corresponding parameter value is non-null, or'n'if the corresponding parameter value is null. (In the latter case, the actual value in the correspondingvaluesentry doesn't matter.) Note thatnullsis not a text string, just an array: it does not need a'\0'terminator.boolread_onlytruefor read-only executionlongcountmaximum number of rows to return, or
0for no limit
Return Value
The return value is the same as forSPI_execute, with the following additional possible error (negative) results:
SPI_ERROR_ARGUMENTif
planisNULLor invalid, orcountis less than 0SPI_ERROR_PARAMif
valuesisNULLandplanwas prepared with some parameters
SPI_processed andSPI_tuptable are set as inSPI_execute if successful.