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.21 2003/08/31 17:32:24 petere 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
  12  <refnamediv>
  13   <refname>RESET</refname>
  14   <refpurpose>restore the value of a run-time parameter to the default value</refpurpose>
  15  </refnamediv>
  16
  17  <indexterm zone="sql-reset">
  18   <primary>RESET</primary>
  19  </indexterm>
  20
  21  <refsynopsisdiv>
  22 <synopsis>
  23 RESET <replaceable class="PARAMETER">parameter</replaceable>
  24 </synopsis>
  25 <synopsis>
  26 RESET ALL
  27 </synopsis>
  28  </refsynopsisdiv>
  29
  30  <refsect1>
  31   <title>Description</title>
  32
  33   <para>
  34    <command>RESET</command> restores run-time parameters to their
  35    default values.  <command>RESET</command> is an alternative
  36    spelling for
  37 <synopsis>
  38 SET <replaceable class="parameter">parameter</replaceable> TO DEFAULT
  39 </synopsis>
  40    Refer to <xref linkend="sql-set" endterm="sql-set-title"> for
  41    details.
  42   </para>
  43
  44   <para>
  45    The default value is defined as the value that the parameter would
  46    have had, had no <command>SET</> ever been issued for it in the
  47    current session.  The actual source of this value might be a
  48    compiled-in default, the configuration file, command-line options,
  49    or per-database or per-user default settings.  See <xref
  50    linkend="runtime-config"> for details.
  51   </para>
  52
  53   <para>
  54    See the <command>SET</> reference page for details on the
  55    transaction behavior of <command>RESET</>.
  56   </para>
  57  </refsect1>
  58
  59  <refsect1>
  60   <title>Parameters</title>
  61
  62   <variablelist>
  63    <varlistentry>
  64     <term><replaceable class="PARAMETER">parameter</replaceable></term>
  65     <listitem>
  66      <para>
  67       The name of a run-time parameter. See <xref linkend="sql-set"
  68       endterm="sql-set-title"> for a list.
  69      </para>
  70     </listitem>
  71    </varlistentry>
  72
  73    <varlistentry>
  74     <term><literal>ALL</literal></term>
  75     <listitem>
  76      <para>
  77       Resets all settable run-time parameters to default values.
  78      </para>
  79     </listitem>
  80    </varlistentry>
  81   </variablelist>
  82  </refsect1>
  83
  84  <refsect1>
  85   <title>Diagnostics</title>
  86
  87   <para>
  88    See under the <xref linkend="sql-set" endterm="sql-set-title">.
  89   </para>
  90  </refsect1>
  91
  92  <refsect1>
  93   <title>Examples</title>
  94
  95   <para>
  96    Set <varname>datestyle</> to its default value:
  97 <screen>
  98 RESET datestyle;
  99 </screen>
 100   </para>
 101
 102   <para>
 103    Set <varname>geqo</> to its default value:
 104 <screen>
 105 RESET geqo;
 106 </screen>
 107   </para>
 108  </refsect1>
 109
 110  <refsect1>
 111   <title>Compatibility</title>
 112
 113   <para>
 114    <command>RESET</command> is a <productname>PostgreSQL</productname> extension.
 115   </para>
 116  </refsect1>
 117 </refentry>
 118
 119 <!-- Keep this comment at the end of the file
 120 Local variables:
 121 mode: sgml
 122 sgml-omittag:nil
 123 sgml-shorttag:t
 124 sgml-minimize-attributes:nil
 125 sgml-always-quote-attributes:t
 126 sgml-indent-step:1
 127 sgml-indent-data:t
 128 sgml-parent-document:nil
 129 sgml-default-dtd-file:"../reference.ced"
 130 sgml-exposed-tags:nil
 131 sgml-local-catalogs:"/usr/lib/sgml/catalog"
 132 sgml-local-ecat-files:nil
 133 End:
 134 -->