RESET SESSION, plus related new DDL commands. Patch from Marko Kreen,

[postgresql] / doc / src / sgml / ref / reset.sgml

diff --git a/doc/src/sgml/ref/reset.sgml b/doc/src/sgml/ref/reset.sgml
index f8729d3fdaebd52c7091c40f5b383be139d96786..e94ef0b8d57e7d98105867262a818f649be0f7aa 100644 (file)
--- a/doc/src/sgml/ref/reset.sgml
+++ b/doc/src/sgml/ref/reset.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/reset.sgml,v 1.29 2006/04/25 14:47:29 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/reset.sgml,v 1.33 2007/04/12 06:53:46 neilc Exp $
 PostgreSQL documentation
 -->
 
@@ -20,11 +20,12 @@ PostgreSQL documentation
 
  <refsynopsisdiv>
 <synopsis>
-RESET <replaceable class="PARAMETER">varname</replaceable>
+RESET <replaceable class="PARAMETER">configuration_parameter</replaceable>
 RESET ALL
+RESET { PLANS | SESSION | TEMP | TEMPORARY }
 </synopsis>
  </refsynopsisdiv>
-  
+
  <refsect1>
   <title>Description</title>
 
@@ -33,7 +34,7 @@ RESET ALL
    default values.  <command>RESET</command> is an alternative
    spelling for
 <synopsis>
-SET <replaceable class="parameter">varname</replaceable> TO DEFAULT
+SET <replaceable class="parameter">configuration_parameter</replaceable> TO DEFAULT
 </synopsis>
    Refer to <xref linkend="sql-set" endterm="sql-set-title"> for
    details.
@@ -41,7 +42,7 @@ SET <replaceable class="parameter">varname</replaceable> TO DEFAULT
 
   <para>
    The default value is defined as the value that the parameter would
-   have had, had no <command>SET</> ever been issued for it in the
+   have had, if no <command>SET</> ever been issued for it in the
    current session.  The actual source of this value might be a
    compiled-in default, the configuration file, command-line options,
    or per-database or per-user default settings.  See <xref
@@ -50,11 +51,17 @@ SET <replaceable class="parameter">varname</replaceable> TO DEFAULT
 
   <para>
    See the <command>SET</> reference page for details on the
-   transaction behavior of <command>RESET</>.  <command>RESET
-   CONNECTION</command> can be used to reset all aspects of
-   a session, not just parameter values.
+   transaction behavior of <command>RESET</>.
   </para>
 
+  <para>
+   <command>RESET</> can also be used to release internal resources
+   that are usually released at the end of session.  <command>RESET
+   TEMP</> drops all temporary tables created in the current session.
+   <command>RESET PLANS</> releases all internally cached plans.
+   <command>RESET SESSION</> releases all externally visible temporary
+   resources associated with the current session.
+  </para>
  </refsect1>
 
  <refsect1>
@@ -62,7 +69,7 @@ SET <replaceable class="parameter">varname</replaceable> TO DEFAULT
 
   <variablelist>
    <varlistentry>
-    <term><replaceable class="PARAMETER">varname</replaceable></term>
+    <term><replaceable class="PARAMETER">configuration_parameter</replaceable></term>
     <listitem>
      <para>
       The name of a run-time parameter. See <xref linkend="sql-set"
@@ -79,9 +86,56 @@ SET <replaceable class="parameter">varname</replaceable> TO DEFAULT
      </para>
     </listitem>
    </varlistentry>
+
+   <varlistentry>
+    <term><literal>TEMP, TEMPORARY</literal></term>
+    <listitem>
+     <para>
+      Drops all temporary tables created in the current session.
+     </para>
+    </listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term><literal>PLANS</literal></term>
+    <listitem>
+     <para>
+      Releases all cached query plans.
+     </para>
+    </listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term><literal>SESSION</literal></term>
+    <listitem>
+     <para>
+      Releases all temporary resources associated with the current
+      session. This has the same effect as executing the following
+      command sequence:
+<synopsis>
+SET SESSION AUTHORIZATION DEFAULT;
+RESET ALL;
+DEALLOCATE ALL;
+CLOSE ALL;
+UNLISTEN *;
+RESET PLANS;
+RESET TEMP;
+</synopsis>
+     </para>
+    </listitem>
+   </varlistentry>
+
   </variablelist>
  </refsect1>
 
+ <refsect1>
+  <title>Notes</title>
+
+   <para>
+    <command>RESET SESSION</> cannot be executed inside a transaction block.
+   </para>
+ </refsect1>
+
  <refsect1>
   <title>Examples</title>
 
@@ -101,20 +155,3 @@ RESET geqo;
   </para>
  </refsect1>
 </refentry>
-
-<!-- Keep this comment at the end of the file
-Local variables:
-mode: sgml
-sgml-omittag:nil
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:1
-sgml-indent-data:t
-sgml-parent-document:nil
-sgml-default-dtd-file:"../reference.ced"
-sgml-exposed-tags:nil
-sgml-local-catalogs:"/usr/lib/sgml/catalog"
-sgml-local-ecat-files:nil
-End:
--->