<!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/reset.sgml,v 1.7 1999/07/22 15:09:14 thomas Exp $
-Postgres documentation
+$PostgreSQL: pgsql/doc/src/sgml/ref/reset.sgml,v 1.33 2007/04/12 06:53:46 neilc Exp $
+PostgreSQL documentation
-->
<refentry id="SQL-RESET">
<refmeta>
- <refentrytitle id="SQL-RESET-TITLE">
- RESET
- </refentrytitle>
+ <refentrytitle id="SQL-RESET-TITLE">RESET</refentrytitle>
<refmiscinfo>SQL - Language Statements</refmiscinfo>
</refmeta>
+
<refnamediv>
- <refname>
- RESET
- </refname>
- <refpurpose>
- Restores run-time parameters for session to default values
- </refpurpose>
+ <refname>RESET</refname>
+ <refpurpose>restore the value of a run-time parameter to the default value</refpurpose>
</refnamediv>
- <refsynopsisdiv>
- <refsynopsisdivinfo>
- <date>1999-07-20</date>
- </refsynopsisdivinfo>
- <synopsis>
-RESET <replaceable class="PARAMETER">variable</replaceable>
- </synopsis>
-
- <refsect2 id="R2-SQL-RESET-1">
- <refsect2info>
- <date>1998-09-24</date>
- </refsect2info>
- <title>
- Inputs
- </title>
- <para>
- <variablelist>
- <varlistentry>
- <term><replaceable class="PARAMETER">variable</replaceable></term>
- <listitem>
- <para>
- Refer to
- <xref linkend="sql-set-title" endterm="sql-set-title">
- for more information on available
- variables.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </refsect2>
-
- <refsect2 id="R2-SQL-RESET-2">
- <refsect2info>
- <date>1998-09-24</date>
- </refsect2info>
- <title>
- Outputs
- </title>
- <para>
- <variablelist>
- <varlistentry>
- <term><computeroutput>
-RESET VARIABLE
- </computeroutput></term>
- <listitem>
- <para>
- Message returned if
- <replaceable class="PARAMETER">variable</replaceable> is successfully reset
- to its default value..
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </refsect2>
+ <indexterm zone="sql-reset">
+ <primary>RESET</primary>
+ </indexterm>
+
+ <refsynopsisdiv>
+<synopsis>
+RESET <replaceable class="PARAMETER">configuration_parameter</replaceable>
+RESET ALL
+RESET { PLANS | SESSION | TEMP | TEMPORARY }
+</synopsis>
</refsynopsisdiv>
-
- <refsect1 id="R1-SQL-RESET-1">
- <refsect1info>
- <date>1998-09-24</date>
- </refsect1info>
- <title>
- Description
- </title>
+
+ <refsect1>
+ <title>Description</title>
+
<para>
- <command>RESET</command> restores variables to the
- default values.
- Refer to
- <xref linkend="sql-set-title" endterm="sql-set-title">
- for details on allowed values and defaults.
- <command>RESET</command> is an alternate form for
-
- <synopsis>
-SET <replaceable class="parameter">variable</replaceable> = DEFAULT
- </synopsis>
+ <command>RESET</command> restores run-time parameters to their
+ default values. <command>RESET</command> is an alternative
+ spelling for
+<synopsis>
+SET <replaceable class="parameter">configuration_parameter</replaceable> TO DEFAULT
+</synopsis>
+ Refer to <xref linkend="sql-set" endterm="sql-set-title"> for
+ details.
</para>
- <refsect2 id="R2-SQL-RESET-3">
- <refsect2info>
- <date>1998-09-24</date>
- </refsect2info>
- <title>
- Notes
- </title>
+ <para>
+ The default value is defined as the value that the parameter would
+ 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
+ linkend="runtime-config"> for details.
+ </para>
- <para>
- <command>RESET</command> is a <productname>Postgres</productname>
- language extension.
- </para>
+ <para>
+ See the <command>SET</> reference page for details on the
+ 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>
+ <title>Parameters</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><replaceable class="PARAMETER">configuration_parameter</replaceable></term>
+ <listitem>
+ <para>
+ The name of a run-time parameter. See <xref linkend="sql-set"
+ endterm="sql-set-title"> for a list.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>ALL</literal></term>
+ <listitem>
+ <para>
+ Resets all settable run-time parameters to default values.
+ </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>
- Use to
- <xref linkend="sql-set-title" endterm="sql-set-title"> and
- <xref linkend="sql-show-title" endterm="sql-show-title">
- to manipulate variable values.
+ <command>RESET SESSION</> cannot be executed inside a transaction block.
</para>
- </refsect2>
</refsect1>
-
- <refsect1 id="R1-SQL-RESET-2">
- <title>
- Usage
- </title>
- <para>
- Set DateStyle to its default value:
- <programlisting>
-RESET DateStyle;
- </programlisting>
- </para>
+ <refsect1>
+ <title>Examples</title>
<para>
- Set Geqo to its default value:
-
- <programlisting>
-RESET GEQO;
- </programlisting>
+ Set the <varname>geqo</> configuration variable to its default value:
+<screen>
+RESET geqo;
+</screen>
</para>
</refsect1>
- <refsect1 id="R1-SQL-RESET-3">
- <title>
- Compatibility
- </title>
-
- <refsect2 id="R2-SQL-RESET-4">
- <refsect2info>
- <date>1998-09-24</date>
- </refsect2info>
- <title>
- SQL92
- </title>
- <para>
- There is no <command>RESET</command> in <acronym>SQL92</acronym>.
- </para>
- </refsect2>
+ <refsect1>
+ <title>Compatibility</title>
+
+ <para>
+ <command>RESET</command> is a <productname>PostgreSQL</productname> extension.
+ </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:
--->
projects / postgresql / blobdiff