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

   1
   2 SPI_execute_plan
   3
   4    SPI_execute_plan — execute a statement prepared by SPI_prepare
   5
   6 Synopsis
   7
   8 int SPI_execute_plan(SPIPlanPtr plan, Datum * values, const char * nulls,
   9                      bool read_only, long count)
  10
  11 Description
  12
  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
  17 Arguments
  18
  19    SPIPlanPtr plan
  20           prepared statement (returned by SPI_prepare)
  21
  22    Datum * values
  23           An array of actual parameter values. Must have same length as
  24           the statement's number of arguments.
  25
  26    const char * nulls
  27           An array describing which parameters are null. Must have same
  28           length as the statement's number of arguments.
  29
  30           If nulls is NULL then SPI_execute_plan assumes that no
  31           parameters are null. Otherwise, each entry of the nulls array
  32           should be ' ' if the corresponding parameter value is non-null,
  33           or 'n' if the corresponding parameter value is null. (In the
  34           latter case, the actual value in the corresponding values entry
  35           doesn't matter.) Note that nulls is not a text string, just an
  36           array: it does not need a '\0' terminator.
  37
  38    bool read_only
  39           true for read-only execution
  40
  41    long count
  42           maximum number of rows to return, or 0 for no limit
  43
  44 Return Value
  45
  46    The return value is the same as for SPI_execute, with the following
  47    additional possible error (negative) results:
  48
  49    SPI_ERROR_ARGUMENT
  50           if plan is NULL or invalid, or count is less than 0
  51
  52    SPI_ERROR_PARAM
  53           if values is NULL and plan was prepared with some parameters
  54
  55    SPI_processed and SPI_tuptable are set as in SPI_execute if successful.