granicus.if.org Git - postgresql/blob - doc/src/sgml/ref/reset.sgml

   1 <!--
   2 $Header: /cvsroot/pgsql/doc/src/sgml/ref/reset.sgml,v 1.16 2002/10/09 04:59:38 momjian Exp $
   3 PostgreSQL documentation
   4 -->
   5
   6 <refentry id="SQL-RESET">
   7  <refmeta>
   8   <refentrytitle id="SQL-RESET-TITLE">RESET</refentrytitle>
   9   <refmiscinfo>SQL - Language Statements</refmiscinfo>
  10  </refmeta>
  11  <refnamediv>
  12   <refname>RESET</refname>
  13   <refpurpose>restore the value of a run-time parameter to a default value</refpurpose>
  14  </refnamediv>
  15  <refsynopsisdiv>
  16   <synopsis>
  17 RESET <replaceable class="PARAMETER">variable</replaceable>
  18   </synopsis>
  19   <synopsis>
  20 RESET ALL
  21   </synopsis>
  22
  23   <refsect2 id="R2-SQL-RESET-1">
  24    <title>Inputs</title>
  25    <para>
  26     <variablelist>
  27      <varlistentry>
  28       <term><replaceable class="PARAMETER">variable</replaceable></term>
  29       <listitem>
  30        <para>
  31         The name of a run-time parameter. See <xref
  32         linkend="sql-set" endterm="sql-set-title"> for a list.
  33        </para>
  34       </listitem>
  35      </varlistentry>
  36      <varlistentry>
  37       <term>ALL</term>
  38       <listitem>
  39        <para>
  40         Resets all settable run-time parameters to default values.
  41        </para>
  42       </listitem>
  43      </varlistentry>
  44     </variablelist>
  45    </para>
  46   </refsect2>
  47
  48  </refsynopsisdiv>
  49
  50  <refsect1>
  51   <title>Description</title>
  52   <para>
  53    <command>RESET</command> restores run-time parameters to their
  54    default values. Refer to
  55    <xref linkend="sql-set" endterm="sql-set-title">
  56    for details. <command>RESET</command> is an alternate spelling for
  57
  58    <synopsis>
  59 SET <replaceable class="parameter">variable</replaceable> TO DEFAULT
  60    </synopsis>
  61
  62    The default value is defined as the value that the variable would
  63    have had, had no <command>SET</> ever been issued for it in the
  64    current session.  The actual source of this value might be a
  65    compiled-in default, the postmaster's configuration file or command-line
  66    switches, or per-database or per-user default settings.  See the
  67    <citetitle>Administrator's Guide</citetitle> for details.
  68   </para>
  69
  70   <para>
  71    See the <command>SHOW</> manual page for details on the transaction
  72    behavior of <command>RESET</>.
  73   </para>
  74
  75  </refsect1>
  76
  77  <refsect1>
  78   <title>Diagnostics</title>
  79   <para>
  80    See under the <xref linkend="sql-set"
  81    endterm="sql-set-title"> command.
  82   </para>
  83  </refsect1>
  84
  85  <refsect1>
  86   <title>Examples</title>
  87   <para>
  88    Set <varname>DateStyle</> to its default value:
  89
  90 <screen>
  91 RESET DateStyle;
  92 </screen>
  93   </para>
  94
  95   <para>
  96    Set <varname>geqo</> to its default value:
  97
  98 <screen>
  99 RESET GEQO;
 100 </screen>
 101   </para>
 102  </refsect1>
 103
 104  <refsect1>
 105   <title>Compatibility</title>
 106
 107   <para>
 108    <command>RESET</command> is a <productname>PostgreSQL</productname> extension.
 109   </para>
 110  </refsect1>
 111 </refentry>
 112
 113 <!-- Keep this comment at the end of the file
 114 Local variables:
 115 mode: sgml
 116 sgml-omittag:nil
 117 sgml-shorttag:t
 118 sgml-minimize-attributes:nil
 119 sgml-always-quote-attributes:t
 120 sgml-indent-step:1
 121 sgml-indent-data:t
 122 sgml-parent-document:nil
 123 sgml-default-dtd-file:"../reference.ced"
 124 sgml-exposed-tags:nil
 125 sgml-local-catalogs:"/usr/lib/sgml/catalog"
 126 sgml-local-ecat-files:nil
 127 End:
 128 -->