spi_prepare_cursor(3) [centos man page]

SPI_PREPARE_CURSOR(3)					  PostgreSQL 9.2.7 Documentation				     SPI_PREPARE_CURSOR(3)

NAME

       SPI_prepare_cursor - prepare a statement, without executing it yet

SYNOPSIS

       SPIPlanPtr SPI_prepare_cursor(const char * command, int nargs,
				     Oid * argtypes, int cursorOptions)

DESCRIPTION

       SPI_prepare_cursor is identical to SPI_prepare, except that it also allows specification of the planner's "cursor options" parameter. This
       is a bit mask having the values shown in nodes/parsenodes.h for the options field of DeclareCursorStmt.	SPI_prepare always takes the
       cursor options as zero.

ARGUMENTS

       const char * command
	   command string

       int nargs
	   number of input parameters ($1, $2, etc.)

       Oid * argtypes
	   pointer to an array containing the OIDs of the data types of the parameters

       int cursorOptions
	   integer bit mask of cursor options; zero produces default behavior

RETURN VALUE

       SPI_prepare_cursor has the same return conventions as SPI_prepare.

NOTES

       Useful bits to set in cursorOptions include CURSOR_OPT_SCROLL, CURSOR_OPT_NO_SCROLL, CURSOR_OPT_FAST_PLAN, CURSOR_OPT_GENERIC_PLAN, and
       CURSOR_OPT_CUSTOM_PLAN. Note in particular that CURSOR_OPT_HOLD is ignored.

PostgreSQL 9.2.7						    2014-02-17						     SPI_PREPARE_CURSOR(3)

SPI_CURSOR_OPEN_WITH_PARAMLIST(3)			  PostgreSQL 9.2.7 Documentation			 SPI_CURSOR_OPEN_WITH_PARAMLIST(3)

NAME

       SPI_cursor_open_with_paramlist - set up a cursor using parameters

SYNOPSIS

       Portal SPI_cursor_open_with_paramlist(const char *name,
					     SPIPlanPtr plan,
					     ParamListInfo params,
					     bool read_only)

DESCRIPTION

       SPI_cursor_open_with_paramlist sets up a cursor (internally, a portal) that will execute a statement prepared by SPI_prepare. This function
       is equivalent to SPI_cursor_open 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.

       The passed-in parameter data will be copied into the cursor's portal, so it can be freed while the cursor still exists.

ARGUMENTS

       const char * name
	   name for portal, or NULL to let the system select a name

       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

RETURN VALUE

       Pointer to portal containing the cursor. Note there is no error return convention; any error will be reported via elog.

PostgreSQL 9.2.7						    2014-02-17					 SPI_CURSOR_OPEN_WITH_PARAMLIST(3)