From d245b6bd9f55f33f851f6501f02a6e9cb1305e75 Mon Sep 17 00:00:00 2001
From: Bruce Momjian <bruce@momjian.us>
Date: Wed, 17 Mar 2004 01:05:10 +0000
Subject: Document SPI_push() and SPI_pop().

---
 doc/src/sgml/spi.sgml | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 63 insertions(+), 1 deletion(-)

(limited to 'doc/src')

diff --git a/doc/src/sgml/spi.sgml b/doc/src/sgml/spi.sgml
index ad8a5f084f9..c87a136bdd4 100644
--- a/doc/src/sgml/spi.sgml
+++ b/doc/src/sgml/spi.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/spi.sgml,v 1.32 2004/03/05 01:00:45 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/spi.sgml,v 1.33 2004/03/17 01:05:10 momjian Exp $
 -->
 
 <chapter id="spi">
@@ -199,6 +199,68 @@ int SPI_finish(void)
 
 <!-- *********************************************** -->
 
+<refentry id="spi-spi-push">
+ <refmeta>
+  <refentrytitle>SPI_push</refentrytitle>
+ </refmeta>
+
+ <refnamediv>
+  <refname>SPI_push</refname>
+  <refpurpose>pushes SPI stack to allow recursive SPI calls</refpurpose>
+ </refnamediv>
+
+ <indexterm><primary>SPI_push</primary></indexterm>
+
+ <refsynopsisdiv>
+<synopsis>
+void SPI_push(void)
+</synopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+  <title>Description</title>
+
+  <para>
+   <function>SPI_push</function> pushes a new environment on to the 
+   SPI call stack, allowing recursive calls to use a new environment.
+  </para>
+ </refsect1>
+
+</refentry>
+
+<!-- *********************************************** -->
+
+<refentry id="spi-spi-pop">
+ <refmeta>
+  <refentrytitle>SPI_pop</refentrytitle>
+ </refmeta>
+
+ <refnamediv>
+  <refname>SPI_pop</refname>
+  <refpurpose>pops SPI stack to allow recursive SPI calls</refpurpose>
+ </refnamediv>
+
+ <indexterm><primary>SPI_pop</primary></indexterm>
+
+ <refsynopsisdiv>
+<synopsis>
+void SPI_pop(void)
+</synopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+  <title>Description</title>
+
+  <para>
+   <function>SPI_pop</function> pops the previous environment from the 
+   SPI call stack.  For use when returning from recursive SPI calls.
+  </para>
+ </refsect1>
+
+</refentry>
+
+<!-- *********************************************** -->
+
 <refentry id="spi-spi-exec">
  <refmeta>
   <refentrytitle>SPI_exec</refentrytitle>
-- 
cgit v1.2.3