Name

Synopsis

SPIPlanPtr SPI_saveplan(SPIPlanPtrplan)

Description

SPI_saveplan copies a passed statement (prepared bySPI_prepare) into memory that will not be freed bySPI_finish nor by the transaction manager, and returns a pointer to the copied statement. This gives you the ability to reuse prepared statements in the subsequent invocations of your procedure in the current session.

Arguments

Return Value

Pointer to the copied statement; orNULL if unsuccessful. On error,SPI_result is set thus:

Notes

The originally passed-in statement is not freed, so you might wish to doSPI_freeplan on it to avoid leaking memory untilSPI_finish.

In most cases,SPI_keepplan is preferred to this function, since it accomplishes largely the same result without needing to physically copy the prepared statement's data structures.