]> granicus.if.org Git - postgresql/blobdiff - doc/src/sgml/ref/reset.sgml
Change "parameter" to "varname" in the alter role and alter user
[postgresql] / doc / src / sgml / ref / reset.sgml
index 39829f631d869d391572b55b41ea430facd70d36..f8729d3fdaebd52c7091c40f5b383be139d96786 100644 (file)
-<REFENTRY ID="SQL-RESET">
-<REFMETA>
-<REFENTRYTITLE>
-RESET
-</REFENTRYTITLE>
-<REFMISCINFO>SQL - Language Statements</REFMISCINFO>
-</REFMETA>
-<REFNAMEDIV>
-<REFNAME>
-RESET
-</REFNAME>
-<REFPURPOSE>
-Restores run-time parameters for session to default values
-</REFPURPOSE>
-
-<REFSYNOPSISDIV>
-<REFSYNOPSISDIVINFO>
-<DATE>1998-09-01</DATE>
-</REFSYNOPSISDIVINFO>
-<SYNOPSIS>
-RESET <REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE>
-</SYNOPSIS>
-
-<REFSECT2 ID="R2-SQL-RESET-1">
-<REFSECT2INFO>
-<DATE>1998-09-01</DATE>
-</REFSECT2INFO>
-<TITLE>
-Inputs
-</TITLE>
-<PARA>
-</PARA>
-<VARIABLELIST>
-<VARLISTENTRY>
-<TERM>
-<REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE>
-</TERM>
-<LISTITEM>
-<PARA>
-          Refer to the SET statement for more information on available
-          variables.
-</variablelist>
-
-</REFSECT2>
-
-<REFSECT2 ID="R2-SQL-RESET-2">
-<REFSECT2INFO>
-<DATE>1998-04-15</DATE>
-</REFSECT2INFO>
-<TITLE>
-Outputs
-</TITLE>
-<PARA>
-</PARA>
-
-<VARIABLELIST>
-<VARLISTENTRY>
-<TERM>
-RESET VARIABLE
-</TERM>
-<LISTITEM>
-<PARA>
-          Message returned if successfully.
-
-</VARIABLELIST>
-
-</REFSECT2>
-</REFSYNOPSISDIV>
-
-<REFSECT1 ID="R1-SQL-RESET-1">
-<REFSECT1INFO>
-<DATE>1998-04-15</DATE>
-</REFSECT1INFO>
-<TITLE>
-Description
-</TITLE>
-<PARA>
-   The RESET statement restores variables to the default values.
-Refer to the SET command for details on allowed values and defaults.
-RESET is an alternate form for
+<!--
+$PostgreSQL: pgsql/doc/src/sgml/ref/reset.sgml,v 1.29 2006/04/25 14:47:29 momjian 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>
-<command>SET <replaceable class="parameter">variable</replaceable> = DEFAULT</command>
+RESET <replaceable class="PARAMETER">varname</replaceable>
+RESET ALL
 </synopsis>
+ </refsynopsisdiv>
+  
+ <refsect1>
+  <title>Description</title>
 
-<REFSECT2 ID="R2-SQL-RESET-3">
-<REFSECT2INFO>
-<DATE>1998-04-15</DATE>
-</REFSECT2INFO>
-<TITLE>
-Notes
-</TITLE>
-<PARA>
-The RESET statement is a <productname>Postgres</productname> language extension.
-<para>
-   Refer to SET/SHOW statements to set/show variable values.
-
-</REFSECT2>
-</refsect1>
-
-<REFSECT1 ID="R1-SQL-RESET-2">
-<TITLE>
-Usage
-</TITLE>
-<PARA>
-<ProgramListing>
-   -- reset DateStyle to its default;
-   RESET DateStyle;
-</programlisting>
-<programlisting>   
-   -- reset Geqo to its default;
-   RESET GEQO;
-</ProgramListing>
-
-</REFSECT1>
-
-<REFSECT1 ID="R1-SQL-RESET-3">
-<TITLE>
-Compatibility
-</TITLE>
-<PARA>
-</PARA>
-
-<REFSECT2 ID="R2-SQL-RESET-4">
-<REFSECT2INFO>
-<DATE>1998-04-15</DATE>
-</REFSECT2INFO>
-<TITLE>
-SQL92
-</TITLE>
-<PARA>
-   There is no RESET statement in SQL92.
-</REFENTRY>
+  <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">varname</replaceable> TO DEFAULT
+</synopsis>
+   Refer to <xref linkend="sql-set" endterm="sql-set-title"> for
+   details.
+  </para>
 
-<!--
-<REPLACEABLE CLASS="PARAMETER">
-</REPLACEABLE>
-<ReturnValue></ReturnValue>
-<PARA>
-</PARA>
-<VARIABLELIST>
-<VARLISTENTRY>
-<TERM>&bull;
-</TERM>
-<LISTITEM>
-<PARA>
-</PARA>
-</LISTITEM>
-</VARLISTENTRY>
-</VARIABLELIST>
-<PARA>
-</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</>.  <command>RESET
+   CONNECTION</command> can be used to reset all aspects of
+   a session, not just parameter values.
+  </para>
+
+ </refsect1>
+
+ <refsect1>
+  <title>Parameters</title>
+
+  <variablelist>
+   <varlistentry>
+    <term><replaceable class="PARAMETER">varname</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 the <varname>geqo</> configuration variable 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:
 -->