spi_execute_with_args(3) [centos man page]

SPI_EXECUTE_WITH_ARGS(3)				  PostgreSQL 9.2.7 Documentation				  SPI_EXECUTE_WITH_ARGS(3)

NAME

       SPI_execute_with_args - execute a command with out-of-line parameters

SYNOPSIS

       int SPI_execute_with_args(const char *command,
				 int nargs, Oid *argtypes,
				 Datum *values, const char *nulls,
				 bool read_only, long count)

DESCRIPTION

       SPI_execute_with_args executes a command that might include references to externally supplied parameters. The command text refers to a
       parameter as $n, and the call specifies data types and values for each such symbol.  read_only and count have the same interpretation as in
       SPI_execute.

       The main advantage of this routine compared to SPI_execute is that data values can be inserted into the command without tedious
       quoting/escaping, and thus with much less risk of SQL-injection attacks.

       Similar results can be achieved with SPI_prepare followed by SPI_execute_plan; however, when using this function the query plan is always
       customized to the specific parameter values provided. For one-time query execution, this function should be preferred. If the same command
       is to be executed with many different parameters, either method might be faster, depending on the cost of re-planning versus the benefit of
       custom plans.

ARGUMENTS

       const char * command
	   command string

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

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

       Datum * values
	   an array of actual parameter values

       const char * nulls
	   an array describing which parameters are null

	   If nulls is NULL then SPI_execute_with_args 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.

       SPI_processed and SPI_tuptable are set as in SPI_execute if successful.

PostgreSQL 9.2.7						    2014-02-17						  SPI_EXECUTE_WITH_ARGS(3)

Check Out this Related Man Page

SPI_CURSOR_OPEN_WITH_ARGS(3)				  PostgreSQL 9.2.7 Documentation			      SPI_CURSOR_OPEN_WITH_ARGS(3)

NAME

       SPI_cursor_open_with_args - set up a cursor using a query and parameters

SYNOPSIS

       Portal SPI_cursor_open_with_args(const char *name,
					const char *command,
					int nargs, Oid *argtypes,
					Datum *values, const char *nulls,
					bool read_only, int cursorOptions)

DESCRIPTION

       SPI_cursor_open_with_args sets up a cursor (internally, a portal) that will execute the specified query. Most of the parameters have the
       same meanings as the corresponding parameters to SPI_prepare_cursor and SPI_cursor_open.

       For one-time query execution, this function should be preferred over SPI_prepare_cursor followed by SPI_cursor_open. If the same command is
       to be executed with many different parameters, either method might be faster, depending on the cost of re-planning versus the benefit of
       custom plans.

       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

       const char * command
	   command string

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

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

       Datum * values
	   an array of actual parameter values

       const char * nulls
	   an array describing which parameters are null

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

       bool read_only
	   true for read-only execution

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

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_ARGS(3)

Linux and UNIX Man Pages

spi_execute_with_args(3) [centos man page]

Check Out this Related Man Page