reset.sgml

PostgreSQL7.4.6 for Linux

<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/reset.sgml,v 1.24 2003/09/22 00:16:58 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 the default value</refpurpose>
 </refnamediv>

 <indexterm zone="sql-reset">
  <primary>RESET</primary>
 </indexterm>

 <refsynopsisdiv>
<synopsis>
RESET <replaceable class="PARAMETER">name</replaceable>
RESET ALL
</synopsis>
 </refsynopsisdiv>
  
 <refsect1>
  <title>Description</title>

  <para>
   <command>RESET</command> restores run-time parameters to their
   default values.  <command>RESET</command> is an alternative
   spelling for
<synopsis>
SET <replaceable class="parameter">parameter</replaceable> TO DEFAULT
</synopsis>
   Refer to <xref linkend="sql-set" endterm="sql-set-title"> for
   details.
  </para>

  <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
   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>
   See the <command>SET</> reference page for details on the
   transaction behavior of <command>RESET</>.
  </para>
 </refsect1>

 <refsect1>
  <title>Parameters</title>

  <variablelist>
   <varlistentry>
    <term><replaceable class="PARAMETER">name</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>
  </variablelist>
 </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:
-->