begriffs open source - ai-pg/blob - full-docs/txt/spi-spi-execp.txt

   1
   2 SPI_execp
   3
   4    SPI_execp — execute a statement in read/write mode
   5
   6 Synopsis
   7
   8 int SPI_execp(SPIPlanPtr plan, Datum * values, const char * nulls, long count)
   9
  10 Description
  11
  12    SPI_execp is the same as SPI_execute_plan, with the latter's read_only
  13    parameter always taken as false.
  14
  15 Arguments
  16
  17    SPIPlanPtr plan
  18           prepared statement (returned by SPI_prepare)
  19
  20    Datum * values
  21           An array of actual parameter values. Must have same length as
  22           the statement's number of arguments.
  23
  24    const char * nulls
  25           An array describing which parameters are null. Must have same
  26           length as the statement's number of arguments.
  27
  28           If nulls is NULL then SPI_execp assumes that no parameters are
  29           null. Otherwise, each entry of the nulls array should be ' ' if
  30           the corresponding parameter value is non-null, or 'n' if the
  31           corresponding parameter value is null. (In the latter case, the
  32           actual value in the corresponding values entry doesn't matter.)
  33           Note that nulls is not a text string, just an array: it does not
  34           need a '\0' terminator.
  35
  36    long count
  37           maximum number of rows to return, or 0 for no limit
  38
  39 Return Value
  40
  41    See SPI_execute_plan.
  42
  43    SPI_processed and SPI_tuptable are set as in SPI_execute if successful.