spi_execute_plan(3) [centos man page]

SPI_EXECUTE_PLAN(3)					  PostgreSQL 9.2.7 Documentation				       SPI_EXECUTE_PLAN(3)

NAME

       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 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.  n indicates a null value
	   (entry in values will be ignored); a space indicates a nonnull value (entry in values is valid).

	   If nulls is NULL then SPI_execute_plan assumes that no parameters are null.

       bool read_only
	   true for read-only execution

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

RETURN VALUE

       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 and SPI_tuptable are set as in SPI_execute if successful.

PostgreSQL 9.2.7						    2014-02-17						       SPI_EXECUTE_PLAN(3)

EXECUTE(7)						  PostgreSQL 9.2.7 Documentation						EXECUTE(7)

NAME

       EXECUTE - execute a prepared statement

SYNOPSIS

       EXECUTE name [ ( parameter [, ...] ) ]

DESCRIPTION

       EXECUTE is used to execute a previously prepared statement. Since prepared statements only exist for the duration of a session, the
       prepared statement must have been created by a PREPARE statement executed earlier in the current session.

       If the PREPARE statement that created the statement specified some parameters, a compatible set of parameters must be passed to the EXECUTE
       statement, or else an error is raised. Note that (unlike functions) prepared statements are not overloaded based on the type or number of
       their parameters; the name of a prepared statement must be unique within a database session.

       For more information on the creation and usage of prepared statements, see PREPARE(7).

PARAMETERS

       name
	   The name of the prepared statement to execute.

       parameter
	   The actual value of a parameter to the prepared statement. This must be an expression yielding a value that is compatible with the data
	   type of this parameter, as was determined when the prepared statement was created.

OUTPUTS

       The command tag returned by EXECUTE is that of the prepared statement, and not EXECUTE.

EXAMPLES

       Examples are given in the EXAMPLES section of the PREPARE(7) documentation.

COMPATIBILITY

       The SQL standard includes an EXECUTE statement, but it is only for use in embedded SQL. This version of the EXECUTE statement also uses a
       somewhat different syntax.

SEE ALSO

       DEALLOCATE(7), PREPARE(7)

PostgreSQL 9.2.7						    2014-02-17								EXECUTE(7)