MAINHACK

Viewing / Editing File: spi-spi-is-cursor-plan.html

File is not writable. Editing disabled.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>SPI_is_cursor_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 9.2.24 Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="Interface Functions"
HREF="spi-interface.html"><LINK
REL="PREVIOUS"
TITLE="SPI_getargtypeid"
HREF="spi-spi-getargtypeid.html"><LINK
REL="NEXT"
TITLE="SPI_execute_plan"
HREF="spi-spi-execute-plan.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_getargtypeid"
HREF="spi-spi-getargtypeid.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_execute_plan"
HREF="spi-spi-execute-plan.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SPI-SPI-IS-CURSOR-PLAN"
></A
>SPI_is_cursor_plan</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN60744"
></A
><H2
>Name</H2
>SPI_is_cursor_plan&nbsp;--&nbsp;return <TT
CLASS="SYMBOL"
>true</TT
> if a statement
  prepared by <CODE
CLASS="FUNCTION"
>SPI_prepare</CODE
> can be used with
  <CODE
CLASS="FUNCTION"
>SPI_cursor_open</CODE
></DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN60752"
></A
><H2
>Synopsis</H2
><PRE
CLASS="SYNOPSIS"
>bool SPI_is_cursor_plan(SPIPlanPtr <TT
CLASS="PARAMETER"
>plan</TT
>)</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN60755"
></A
><H2
>Description</H2
><P
>   <CODE
CLASS="FUNCTION"
>SPI_is_cursor_plan</CODE
> returns <TT
CLASS="SYMBOL"
>true</TT
>
   if a statement prepared by <CODE
CLASS="FUNCTION"
>SPI_prepare</CODE
> can be passed
   as an argument to <CODE
CLASS="FUNCTION"
>SPI_cursor_open</CODE
>, or
   <TT
CLASS="SYMBOL"
>false</TT
> if that is not the case. The criteria are that the
   <TT
CLASS="PARAMETER"
>plan</TT
> represents one single command and that this
   command returns tuples to the caller; for example, <TT
CLASS="COMMAND"
>SELECT</TT
>
   is allowed unless it contains an <TT
CLASS="LITERAL"
>INTO</TT
> clause, and
   <TT
CLASS="COMMAND"
>UPDATE</TT
> is allowed only if it contains a <TT
CLASS="LITERAL"
>RETURNING</TT
>
   clause.
  </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN60768"
></A
><H2
>Arguments</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="LITERAL"
>SPIPlanPtr <TT
CLASS="PARAMETER"
>plan</TT
></TT
></DT
><DD
><P
>      prepared statement (returned by <CODE
CLASS="FUNCTION"
>SPI_prepare</CODE
>)
     </P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN60778"
></A
><H2
>Return Value</H2
><P
>    <TT
CLASS="SYMBOL"
>true</TT
> or <TT
CLASS="SYMBOL"
>false</TT
> to indicate if the
    <TT
CLASS="PARAMETER"
>plan</TT
> can produce a cursor or not, with
    <TT
CLASS="VARNAME"
>SPI_result</TT
> set to zero.
    If it is not possible to determine the answer (for example,
    if the <TT
CLASS="PARAMETER"
>plan</TT
> is <TT
CLASS="SYMBOL"
>NULL</TT
> or invalid,
    or if called when not connected to SPI), then
    <TT
CLASS="VARNAME"
>SPI_result</TT
> is set to a suitable error code
    and <TT
CLASS="SYMBOL"
>false</TT
> is returned.
  </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-getargtypeid.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-execute-plan.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SPI_getargtypeid</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_execute_plan</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
Cancel / Back
[ MAINHACK ]

Viewing / Editing File: spi-spi-is-cursor-plan.html

Server Info

System Features

User Info
