table of contents
| SPI_EXECP(3) | PostgreSQL 16.1 Documentation | SPI_EXECP(3) |
NAME¶
SPI_execp - execute a statement in read/write mode
SYNOPSIS¶
int SPI_execp(SPIPlanPtr plan, Datum * values, const char * nulls, long count)
DESCRIPTION¶
SPI_execp is the same as SPI_execute_plan, with the latter's read_only parameter always taken as false.
ARGUMENTS¶
SPIPlanPtr plan
prepared statement (returned by SPI_prepare)
Datum * values
An array of actual parameter values. Must have same
length as the statement's number of arguments.
const char * nulls
An array describing which parameters are null. Must have
same length as the statement's number of arguments.
If nulls is NULL then SPI_execp assumes that no parameters are null. Otherwise, each entry of the nulls array 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 corresponding values entry doesn't matter.) Note that nulls is not a text string, just an array: it does not need a '\0' terminator.
long count
maximum number of rows to return, or 0 for no limit
RETURN VALUE¶
See SPI_execute_plan.
SPI_processed and SPI_tuptable are set as in SPI_execute if successful.
| 2023 | PostgreSQL 16.1 |