PostgreSQL 8.0.1 Documentation | ||||
---|---|---|---|---|
Prev | Fast Backward | Fast Forward | Next |
SPI_saveplan
Description
SPI_saveplan
saves a passed plan (prepared by SPI_prepare
) in memory protected from freeing by SPI_finish
and by the transaction manager and returns a pointer to the saved plan. This gives you the ability to reuse prepared plans in the subsequent invocations of your procedure in the current session. You may save the pointer returned in a local variable. Always check if this pointer is NULL or not either when preparing a plan or using an already prepared plan in SPI_execute_plan
.
Return Value
Pointer to the saved plan; NULL if unsuccessful. On error, SPI_result is set thus:
- SPI_ERROR_ARGUMENT
if plan is NULL
- SPI_ERROR_UNCONNECTED
if called from an unconnected procedure