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

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