<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>SPI_connect</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="Interface Functions"
HREF="spi-interface.html"><LINK
REL="NEXT"
TITLE="SPI_finish"
HREF="spi-spi-finish.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="Interface Functions"
HREF="spi-interface.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_finish"
HREF="spi-spi-finish.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SPI-SPI-CONNECT"
></A
>SPI_connect</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN60000"
></A
><H2
>Name</H2
>SPI_connect -- connect a procedure to the SPI manager</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN60005"
></A
><H2
>Synopsis</H2
><PRE
CLASS="SYNOPSIS"
>int SPI_connect(void)</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN60007"
></A
><H2
>Description</H2
><P
> <CODE
CLASS="FUNCTION"
>SPI_connect</CODE
> opens a connection from a
procedure invocation to the SPI manager. You must call this
function if you want to execute commands through SPI. Some utility
SPI functions can be called from unconnected procedures.
</P
><P
> If your procedure is already connected,
<CODE
CLASS="FUNCTION"
>SPI_connect</CODE
> will return the error code
<SPAN
CLASS="RETURNVALUE"
>SPI_ERROR_CONNECT</SPAN
>. This could happen if
a procedure that has called <CODE
CLASS="FUNCTION"
>SPI_connect</CODE
>
directly calls another procedure that calls
<CODE
CLASS="FUNCTION"
>SPI_connect</CODE
>. While recursive calls to the
<ACRONYM
CLASS="ACRONYM"
>SPI</ACRONYM
> manager are permitted when an SQL command
called through SPI invokes another function that uses
<ACRONYM
CLASS="ACRONYM"
>SPI</ACRONYM
>, directly nested calls to
<CODE
CLASS="FUNCTION"
>SPI_connect</CODE
> and
<CODE
CLASS="FUNCTION"
>SPI_finish</CODE
> are forbidden.
(But see <CODE
CLASS="FUNCTION"
>SPI_push</CODE
> and <CODE
CLASS="FUNCTION"
>SPI_pop</CODE
>.)
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN60022"
></A
><H2
>Return Value</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="SYMBOL"
>SPI_OK_CONNECT</TT
></DT
><DD
><P
> on success
</P
></DD
><DT
><TT
CLASS="SYMBOL"
>SPI_ERROR_CONNECT</TT
></DT
><DD
><P
> on error
</P
></DD
></DL
></DIV
></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-interface.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-finish.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Interface Functions</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_finish</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>