1#@!#!123s

: / opt / alt / postgresql11 / usr / share / doc / alt-postgresql11-9.2.24 / html /
Filename : spi-spi-keepplan.html
back
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>SPI_keepplan</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REV="MADE"
HREF="mailto:pgsql-docs@postgresql.org"><LINK
REL="HOME"
TITLE="PostgreSQL 9.2.24 Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="Interface Functions"
HREF="spi-interface.html"><LINK
REL="PREVIOUS"
TITLE="SPI_cursor_close"
HREF="spi-spi-cursor-close.html"><LINK
REL="NEXT"
TITLE="SPI_saveplan"
HREF="spi-spi-saveplan.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="stylesheet.css"><META
HTTP-EQUIV="Content-Type"
CONTENT="text/html; charset=ISO-8859-1"><META
NAME="creation"
CONTENT="2017-11-06T22:43:11"></HEAD
><BODY
CLASS="REFENTRY"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="5"
ALIGN="center"
VALIGN="bottom"
><A
HREF="index.html"
>PostgreSQL 9.2.24 Documentation</A
></TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
TITLE="SPI_cursor_close"
HREF="spi-spi-cursor-close.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
HREF="spi-interface.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="60%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="20%"
ALIGN="right"
VALIGN="top"
><A
TITLE="SPI_saveplan"
HREF="spi-spi-saveplan.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SPI-SPI-KEEPPLAN"
></A
>SPI_keepplan</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN61516"
></A
><H2
>Name</H2
>SPI_keepplan&nbsp;--&nbsp;save a prepared statement</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN61521"
></A
><H2
>Synopsis</H2
><PRE
CLASS="SYNOPSIS"
>int SPI_keepplan(SPIPlanPtr <TT
CLASS="PARAMETER"
>plan</TT
>)</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN61524"
></A
><H2
>Description</H2
><P
>   <CODE
CLASS="FUNCTION"
>SPI_keepplan</CODE
> saves a passed statement (prepared by
   <CODE
CLASS="FUNCTION"
>SPI_prepare</CODE
>) so that it will not be freed
   by <CODE
CLASS="FUNCTION"
>SPI_finish</CODE
> nor by the transaction manager.
   This gives you the ability to reuse prepared statements in the subsequent
   invocations of your procedure in the current session.
  </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN61530"
></A
><H2
>Arguments</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="LITERAL"
>SPIPlanPtr <TT
CLASS="PARAMETER"
>plan</TT
></TT
></DT
><DD
><P
>      the prepared statement to be saved
     </P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN61539"
></A
><H2
>Return Value</H2
><P
>   0 on success;
   <TT
CLASS="SYMBOL"
>SPI_ERROR_ARGUMENT</TT
> if <TT
CLASS="PARAMETER"
>plan</TT
>
   is <TT
CLASS="SYMBOL"
>NULL</TT
> or invalid
  </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN61545"
></A
><H2
>Notes</H2
><P
>   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 <CODE
CLASS="FUNCTION"
>SPI_freeplan</CODE
> on it.
  </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="spi-spi-cursor-close.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="spi-spi-saveplan.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SPI_cursor_close</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="spi-interface.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SPI_saveplan</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>