reset.sgml

<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/reset.sgml,v 1.15 2002/09/21 18:32:54 petere Exp $
PostgreSQL documentation
-->

<refentry id="SQL-RESET">
 <refmeta>
  <refentrytitle id="SQL-RESET-TITLE">RESET</refentrytitle>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>RESET</refname>
  <refpurpose>restore the value of a run-time parameter to a default value</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <synopsis>
RESET <replaceable class="PARAMETER">variable</replaceable>
  </synopsis>
  <synopsis>
RESET ALL
  </synopsis>

  <refsect2 id="R2-SQL-RESET-1">
   <title>Inputs</title>
   <para>		
    <variablelist>
     <varlistentry>
      <term><replaceable class="PARAMETER">variable</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>ALL</term>
      <listitem>
       <para>
        Resets all settable run-time parameters to default values.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </refsect2>

 </refsynopsisdiv>
  
 <refsect1>
  <title>Description</title>
  <para>
   <command>RESET</command> restores run-time parameters to their
   default values. Refer to
   <xref linkend="sql-set" endterm="sql-set-title">
   for details. <command>RESET</command> is an alternate spelling for

   <synopsis>
SET <replaceable class="parameter">variable</replaceable> TO DEFAULT
   </synopsis>

   The default value is defined as the value that the variable would
   have had, had 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 postmaster's configuration file or command-line
   switches, or per-database or per-user default settings.  See the
   <citetitle>Administrator's Guide</citetitle> for details.
  </para>
 </refsect1>

 <refsect1>
  <title>Diagnostics</title>
  <para>
   See under the <xref linkend="sql-set"
   endterm="sql-set-title"> command.
  </para>
 </refsect1>

 <refsect1>
  <title>Examples</title>
  <para>
   Set <varname>DateStyle</> to its default value:

<screen>
RESET DateStyle;
</screen>
  </para>

  <para>
   Set <varname>geqo</> to its default value:

<screen>   
RESET GEQO;
</screen>
  </para>
 </refsect1>

 <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:
-->