From 46651ce6fe013220ed397add242004d764fc0153 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sat, 4 May 2024 14:15:05 +0200 Subject: Adding upstream version 14.5. Signed-off-by: Daniel Baumann --- doc/src/sgml/html/spi-spi-saveplan.html | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 doc/src/sgml/html/spi-spi-saveplan.html (limited to 'doc/src/sgml/html/spi-spi-saveplan.html') diff --git a/doc/src/sgml/html/spi-spi-saveplan.html b/doc/src/sgml/html/spi-spi-saveplan.html new file mode 100644 index 0000000..f583a9f --- /dev/null +++ b/doc/src/sgml/html/spi-spi-saveplan.html @@ -0,0 +1,30 @@ + +SPI_saveplan
SPI_saveplan
Prev Up47.1. Interface FunctionsHome Next

SPI_saveplan

SPI_saveplan — save a prepared statement

Synopsis

+SPIPlanPtr SPI_saveplan(SPIPlanPtr plan)
+

Description

+ SPI_saveplan copies a passed statement (prepared by + SPI_prepare) into memory that will not be freed + by SPI_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 C function in the current session. +

Arguments

SPIPlanPtr plan

+ the prepared statement to be saved +

Return Value

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

SPI_ERROR_ARGUMENT

+ if plan is NULL or invalid +

SPI_ERROR_UNCONNECTED

+ if called from an unconnected C function +

+

Notes

+ The originally passed-in statement is not freed, so you might wish to do + SPI_freeplan on it to avoid leaking memory + until SPI_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. +

Prev Up Next
SPI_keepplan Home SPI_register_relation
\ No newline at end of file -- cgit v1.2.3