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

   1
   2 SPI_execute_plan_with_paramlist
   3
   4    SPI_execute_plan_with_paramlist — execute a statement prepared by
   5    SPI_prepare
   6
   7 Synopsis
   8
   9 int SPI_execute_plan_with_paramlist(SPIPlanPtr plan,
  10                                     ParamListInfo params,
  11                                     bool read_only,
  12                                     long count)
  13
  14 Description
  15
  16    SPI_execute_plan_with_paramlist executes a statement prepared by
  17    SPI_prepare. This function is equivalent to SPI_execute_plan except
  18    that information about the parameter values to be passed to the query
  19    is presented differently. The ParamListInfo representation can be
  20    convenient for passing down values that are already available in that
  21    format. It also supports use of dynamic parameter sets via hook
  22    functions specified in ParamListInfo.
  23
  24    This function is now deprecated in favor of SPI_execute_plan_extended.
  25
  26 Arguments
  27
  28    SPIPlanPtr plan
  29           prepared statement (returned by SPI_prepare)
  30
  31    ParamListInfo params
  32           data structure containing parameter types and values; NULL if
  33           none
  34
  35    bool read_only
  36           true for read-only execution
  37
  38    long count
  39           maximum number of rows to return, or 0 for no limit
  40
  41 Return Value
  42
  43    The return value is the same as for SPI_execute_plan.
  44
  45    SPI_processed and SPI_tuptable are set as in SPI_execute_plan if
  46    successful.