Postgresql 中文操作指南

SPI_execute_plan

SPI_execute_plan — 执行由 SPI_prepare 准备的语句

SPI_execute_plan — execute a statement prepared by SPI_prepare

Synopsis

int SPI_execute_plan(SPIPlanPtr plan, Datum * values, const char * nulls,
                     bool read_only, long count)

Description

SPI_execute_plan 执行由 SPI_prepare 或其兄弟之一准备的语句。 read_only 和 count 的解释与 SPI_execute 中相同。

SPI_execute_plan executes a statement prepared by SPI_prepare or one of its siblings. read_only and count have the same interpretation as in SPI_execute.

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_execute_plan 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.

  • bool _read_only_

    • true for read-only execution

  • long _count_

    • maximum number of rows to return, or 0 for no limit

Return Value

返回值与 SPI_execute 相同，并带有以下附加的可能出错（负数）结果：

The return value is the same as for SPI_execute, with the following additional possible error (negative) results:

  • SPI_ERROR_ARGUMENT

    • if plan is NULL or invalid, or count is less than 0

  • SPI_ERROR_PARAM

    • if values is NULL and plan was prepared with some parameters

如果成功，则 SPI_processed 和 SPI_tuptable 与 SPI_execute 中的设置相同。

SPI_processed and SPI_tuptable are set as in SPI_execute if successful.