Portal SPI_cursor_open(const char * name, SPIPlanPtr plan, Datum * values, const char * nulls, bool read_only)
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 parameters to
Using a cursor instead of executing the statement directly has two benefits. First, the result rows can be retrieved a few at a time, avoiding memory overrun for queries that return many rows. Second, a portal can outlive the current procedure (it can, in fact, live to the end of the current transaction). Returning the portal name to the procedure's caller provides a way of returning a row set as result.
The passed-in parameter data will be copied into the cursor's portal, so it can be freed while the cursor still exists.
name for portal, or NULL to let the system select a name
prepared statement (returned by
An array of actual parameter values. Must have same length as the statement's number of arguments.
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_cursor_open assumes that no
parameters are null.
true for read-only execution
Pointer to portal containing the cursor. Note there is no
error return convention; any error will be reported via
Please use this form to add your own comments regarding your experience with particular features of PostgreSQL, clarifications of the documentation, or hints for other users. Please note, this is not a support forum, and your IP address will be logged. If you have a question or need help, please see the faq, try a mailing list, or join us on IRC. Note that submissions containing URLs or other keywords commonly found in 'spam' comments may be silently discarded. Please contact the webmaster if you think this is happening to you in error.
Proceed to the comment form.