Movatterモバイル変換

SPI_cursor_open_with_args

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,                                 intnargs, Oid *argtypes,                                 Datum *values, const char *nulls,                                 boolread_only, intcursorOptions)

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 toSPI_prepare_cursor andSPI_cursor_open.

For one-time query execution, this function should be preferred overSPI_prepare_cursor followed bySPI_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

Return Value

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