Section 3: library functions
SPI_getbinval – return the binary value of the specified column Synopsis Datum SPI_getbinval(HeapTuple row, TupleDesc rowdesc, int colnumber, bool * isnull) Description SPI_getbinval returns the value of the specified column in the internal form (as type Datum). This function does not allocate new space for the datum. In the case of a pass-by-reference data type,…
SPI_getargtypeid – return the data type OID for an argument of a statement prepared by SPI_prepare Synopsis Oid SPI_getargtypeid(SPIPlanPtr plan, int argIndex) Description SPI_getargtypeid returns the OID representing the type for the argIndex‘th argument of a statement prepared by SPI_prepare. First argument is at index zero. Arguments SPIPlanPtr plan prepared statement (returned by SPI_prepare) int…
SPI_getargcount – return the number of arguments needed by a statement prepared by SPI_prepare Synopsis int SPI_getargcount(SPIPlanPtr plan) Description SPI_getargcount returns the number of arguments needed to execute a statement prepared by SPI_prepare. Arguments SPIPlanPtr plan prepared statement (returned by SPI_prepare) Return Value The count of expected arguments for the plan. If the plan is…
SPI_freetuptable – free a row set created by SPI_execute or a similar function Synopsis void SPI_freetuptable(SPITupleTable * tuptable) Description SPI_freetuptable frees a row set created by a prior SPI command execution function, such as SPI_execute. Therefore, this function is usually called with the global variable SPI_tupletable as argument. This function is useful if a SPI…
SPI_freetuple – free a row allocated in the upper executor context Synopsis void SPI_freetuple(HeapTuple row) Description SPI_freetuple frees a row previously allocated in the upper executor context. This function is no longer different from plain heap_freetuple. It’s kept just for backward compatibility of existing code. Arguments HeapTuple row row to free
SPI_freeplan – free a previously saved prepared statement Synopsis int SPI_freeplan(SPIPlanPtr plan) Description SPI_freeplan releases a prepared statement previously returned by SPI_prepare or saved by SPI_keepplan or SPI_saveplan. Arguments SPIPlanPtr plan pointer to statement to free Return Value 0 on success; SPI_ERROR_ARGUMENT if plan is NULL or invalid
SPI_fnumber – determine the column number for the specified column name Synopsis int SPI_fnumber(TupleDesc rowdesc, const char * colname) Description SPI_fnumber returns the column number for the column with the specified name. If colname refers to a system column (e.g., oid) then the appropriate negative column number will be returned. The caller should be careful…
SPI_fname – determine the column name for the specified column number Synopsis char * SPI_fname(TupleDesc rowdesc, int colnumber) Description SPI_fname returns a copy of the column name of the specified column. (You can use pfree to release the copy of the name when you don’t need it anymore.) Arguments TupleDesc rowdesc input row description int…
SPI_finish – disconnect a procedure from the SPI manager Synopsis int SPI_finish(void) Description SPI_finish closes an existing connection to the SPI manager. You must call this function after completing the SPI operations needed during your procedure’s current invocation. You do not need to worry about making this happen, however, if you abort the transaction via…
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…
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…
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…
SPI_execute – execute a command Synopsis int SPI_execute(const char * command, bool read_only, long count) Description SPI_execute executes the specified SQL command for count rows. If read_only is true, the command must be read-only, and execution overhead is somewhat reduced. This function can only be called from a connected procedure. If count is zero then…
SPI_execp – execute a statement in read/write mode Synopsis int SPI_execp(SPIPlanPtr plan, Datum * values, const char * nulls, long count) Description SPI_execp is the same as SPI_execute_plan, with the latter’s read_only parameter always taken as false. Arguments SPIPlanPtr plan prepared statement (returned by SPI_prepare) Datum * values An array of actual parameter values. Must…
SPI_exec – execute a read/write command Synopsis int SPI_exec(const char * command, long count) Description SPI_exec is the same as SPI_execute, with the latter’s read_only parameter always taken as false. Arguments const char * command string containing command to execute long count maximum number of rows to return, or 0 for no limit Return Value…
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…
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…
SPI_cursor_open – set up a cursor using a statement created with SPI_prepare Synopsis Portal SPI_cursor_open(const char * name, SPIPlanPtr plan, Datum * values, const char * nulls, bool read_only) Description SPI_cursor_open sets up a cursor (internally, a portal) that will execute a statement prepared by SPI_prepare. The parameters have the same meanings as the corresponding…
SPI_cursor_move – move a cursor Synopsis void SPI_cursor_move(Portal portal, bool forward, long count) Description SPI_cursor_move skips over some number of rows in a cursor. This is equivalent to a subset of the SQL command MOVE (see SPI_scroll_cursor_move for more functionality). Arguments Portal portal portal containing the cursor bool forward true for move forward, false for…
SPI_cursor_find – find an existing cursor by name Synopsis Portal SPI_cursor_find(const char * name) Description SPI_cursor_find finds an existing portal by name. This is primarily useful to resolve a cursor name returned as text by some other function. Arguments const char * name name of the portal Return Value pointer to the portal with the…