Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
SPI_EXECUTE_PLAN_WITH_PAPostgreSQL 9.6.3 DocSPI_EXECUTE_PLAN_WITH_PARAMLIST(3)

NAME
       SPI_execute_plan_with_paramlist - execute a statement prepared by
       SPI_prepare

SYNOPSIS
       int SPI_execute_plan_with_paramlist(SPIPlanPtr plan,
					   ParamListInfo params,
					   bool	read_only,
					   long	count)

DESCRIPTION
       SPI_execute_plan_with_paramlist executes	a statement prepared by
       SPI_prepare. This function is equivalent	to SPI_execute_plan except
       that information	about the parameter values to be passed	to the query
       is presented differently. The ParamListInfo representation can be
       convenient for passing down values that are already available in	that
       format. It also supports	use of dynamic parameter sets via hook
       functions specified in ParamListInfo.

ARGUMENTS
       SPIPlanPtr plan
	   prepared statement (returned	by SPI_prepare)

       ParamListInfo params
	   data	structure containing parameter types and values; NULL if none

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

       SPI_processed and SPI_tuptable are set as in SPI_execute_plan if
       successful.

PostgreSQL 9.6.3		     2017   SPI_EXECUTE_PLAN_WITH_PARAMLIST(3)

NAME | SYNOPSIS | DESCRIPTION | ARGUMENTS | RETURN VALUE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=SPI_execute_plan_with_paramlist&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help