Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
SPI_KEEPPLAN(3)		 PostgreSQL 17.5 Documentation	       SPI_KEEPPLAN(3)

NAME
       SPI_keepplan - save a prepared statement

SYNOPSIS
       int SPI_keepplan(SPIPlanPtr plan)

DESCRIPTION
       SPI_keepplan saves a passed statement (prepared by SPI_prepare) so that
       it will not be freed by SPI_finish nor by the transaction manager. 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
       0 on success; SPI_ERROR_ARGUMENT	if plan	is NULL	or invalid

NOTES
       The passed-in statement is relocated to permanent storage by means of
       pointer adjustment (no data copying is required). If you	later wish to
       delete it, use SPI_freeplan on it.

PostgreSQL 17.5			     2025		       SPI_KEEPPLAN(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=SPI_keepplan&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help