<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <HTML ><HEAD ><TITLE >SPI_execute_plan</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 8.0.11 Documentation" HREF="index.html"><LINK REL="UP" TITLE="Interface Functions" HREF="spi.html#SPI-INTERFACE"><LINK REL="PREVIOUS" TITLE="SPI_is_cursor_plan" HREF="spi-spi-is-cursor-plan.html"><LINK REL="NEXT" TITLE="SPI_execp" HREF="spi-spi-execp.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="2007-02-02T03:57:22"></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" >PostgreSQL 8.0.11 Documentation</TH ></TR ><TR ><TD WIDTH="10%" ALIGN="left" VALIGN="top" ><A HREF="spi-spi-is-cursor-plan.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="10%" ALIGN="left" VALIGN="top" ><A HREF="spi-spi-is-cursor-plan.html" >Fast Backward</A ></TD ><TD WIDTH="60%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="top" ><A HREF="spi-spi-execp.html" >Fast Forward</A ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="top" ><A HREF="spi-spi-execp.html" ACCESSKEY="N" >Next</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><H1 ><A NAME="SPI-SPI-EXECUTE-PLAN" ></A >SPI_execute_plan</H1 ><DIV CLASS="REFNAMEDIV" ><A NAME="AEN35092" ></A ><H2 >Name</H2 >SPI_execute_plan -- execute a plan prepared by <CODE CLASS="FUNCTION" >SPI_prepare</CODE ></DIV ><A NAME="AEN35096" ></A ><DIV CLASS="REFSYNOPSISDIV" ><A NAME="AEN35098" ></A ><H2 >Synopsis</H2 ><PRE CLASS="SYNOPSIS" >int SPI_execute_plan(void * <TT CLASS="PARAMETER" >plan</TT >, Datum * <TT CLASS="PARAMETER" >values</TT >, const char * <TT CLASS="PARAMETER" >nulls</TT >, bool <TT CLASS="PARAMETER" >read_only</TT >, int <TT CLASS="PARAMETER" >count</TT >)</PRE ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN35105" ></A ><H2 >Description</H2 ><P > <CODE CLASS="FUNCTION" >SPI_execute_plan</CODE > executes a plan prepared by <CODE CLASS="FUNCTION" >SPI_prepare</CODE >. <TT CLASS="PARAMETER" >read_only</TT > and <TT CLASS="PARAMETER" >count</TT > have the same interpretation as in <CODE CLASS="FUNCTION" >SPI_execute</CODE >. </P ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN35113" ></A ><H2 >Arguments</H2 ><P ></P ><DIV CLASS="VARIABLELIST" ><DL ><DT ><TT CLASS="LITERAL" >void * <TT CLASS="PARAMETER" >plan</TT ></TT ></DT ><DD ><P > execution plan (returned by <CODE CLASS="FUNCTION" >SPI_prepare</CODE >) </P ></DD ><DT ><TT CLASS="LITERAL" >Datum * <TT CLASS="PARAMETER" >values</TT ></TT ></DT ><DD ><P > An array of actual parameter values. Must have same length as the plan's number of arguments. </P ></DD ><DT ><TT CLASS="LITERAL" >const char * <TT CLASS="PARAMETER" >nulls</TT ></TT ></DT ><DD ><P > An array describing which parameters are null. Must have same length as the plan's number of arguments. <TT CLASS="LITERAL" >n</TT > indicates a null value (entry in <TT CLASS="PARAMETER" >values</TT > will be ignored); a space indicates a nonnull value (entry in <TT CLASS="PARAMETER" >values</TT > is valid). </P ><P > If <TT CLASS="PARAMETER" >nulls</TT > is <TT CLASS="SYMBOL" >NULL</TT > then <CODE CLASS="FUNCTION" >SPI_execute_plan</CODE > assumes that no parameters are null. </P ></DD ><DT ><TT CLASS="LITERAL" >bool <TT CLASS="PARAMETER" >read_only</TT ></TT ></DT ><DD ><P > <TT CLASS="LITERAL" >true</TT > for read-only execution </P ></DD ><DT ><TT CLASS="LITERAL" >int <TT CLASS="PARAMETER" >count</TT ></TT ></DT ><DD ><P > maximum number of rows to process or return </P ></DD ></DL ></DIV ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN35155" ></A ><H2 >Return Value</H2 ><P > The return value is the same as for <CODE CLASS="FUNCTION" >SPI_execute</CODE >, with the following additional possible error (negative) results: <P ></P ></P><DIV CLASS="VARIABLELIST" ><DL ><DT ><TT CLASS="SYMBOL" >SPI_ERROR_ARGUMENT</TT ></DT ><DD ><P > if <TT CLASS="PARAMETER" >plan</TT > is <TT CLASS="SYMBOL" >NULL</TT > or <TT CLASS="PARAMETER" >count</TT > is less than 0 </P ></DD ><DT ><TT CLASS="SYMBOL" >SPI_ERROR_PARAM</TT ></DT ><DD ><P > if <TT CLASS="PARAMETER" >values</TT > is <TT CLASS="SYMBOL" >NULL</TT > and <TT CLASS="PARAMETER" >plan</TT > was prepared with some parameters </P ></DD ></DL ></DIV ><P> </P ><P > <TT CLASS="VARNAME" >SPI_processed</TT > and <TT CLASS="VARNAME" >SPI_tuptable</TT > are set as in <CODE CLASS="FUNCTION" >SPI_execute</CODE > if successful. </P ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN35180" ></A ><H2 >Notes</H2 ><P > If one of the objects (a table, function, etc.) referenced by the prepared plan is dropped during the session then the result of <CODE CLASS="FUNCTION" >SPI_execute_plan</CODE > for this plan will be unpredictable. </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-is-cursor-plan.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-execp.html" ACCESSKEY="N" >Next</A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >SPI_is_cursor_plan</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="spi.html#SPI-INTERFACE" ACCESSKEY="U" >Up</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >SPI_execp</TD ></TR ></TABLE ></DIV ></BODY ></HTML >