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

   1 <REFENTRY ID="SQL-RESET">
   2 <REFMETA>
   3 <REFENTRYTITLE>
   4 RESET
   5 </REFENTRYTITLE>
   6 <REFMISCINFO>SQL - Language Statements</REFMISCINFO>
   7 </REFMETA>
   8 <REFNAMEDIV>
   9 <REFNAME>
  10 RESET
  11 </REFNAME>
  12 <REFPURPOSE>
  13 Restores run-time parameters for session to default values
  14 </REFPURPOSE>
  15   </refnamediv>
  16 <REFSYNOPSISDIV>
  17 <REFSYNOPSISDIVINFO>
  18 <DATE>1998-09-24</DATE>
  19 </REFSYNOPSISDIVINFO>
  20 <SYNOPSIS>
  21 RESET <REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE>
  22 </SYNOPSIS>
  23
  24         <REFSECT2 ID="R2-SQL-RESET-1">
  25           <REFSECT2INFO>
  26                 <DATE>1998-09-24</DATE>
  27           </REFSECT2INFO>
  28           <TITLE>
  29                 Inputs
  30           </TITLE>
  31           <PARA>
  32                 <VARIABLELIST>
  33                   <VARLISTENTRY>
  34                         <TERM>
  35                           <REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE>
  36                         </TERM>
  37                         <LISTITEM>
  38                           <PARA>
  39                                 Refer to the SET statement for more information on available
  40                                 variables.
  41                           </para>
  42                         </listitem>
  43                   </varlistentry>
  44                 </variablelist>
  45           </para>
  46         </REFSECT2>
  47
  48         <REFSECT2 ID="R2-SQL-RESET-2">
  49           <REFSECT2INFO>
  50                 <DATE>1998-09-24</DATE>
  51           </REFSECT2INFO>
  52           <TITLE>
  53                 Outputs
  54           </TITLE>
  55           <PARA>
  56
  57                 <VARIABLELIST>
  58                   <VARLISTENTRY>
  59                         <TERM>
  60                           RESET VARIABLE
  61                         </TERM>
  62                         <LISTITEM>
  63                           <PARA>
  64                                 Message returned if
  65                                 <REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE> is successfully reset
  66                                 to its default value..
  67                           </para>
  68                         </listitem>
  69                   </varlistentry>
  70                 </VARIABLELIST>
  71           </para>
  72         </REFSECT2>
  73   </REFSYNOPSISDIV>
  74
  75   <REFSECT1 ID="R1-SQL-RESET-1">
  76         <REFSECT1INFO>
  77           <DATE>1998-09-24</DATE>
  78         </REFSECT1INFO>
  79         <TITLE>
  80           Description
  81         </TITLE>
  82         <PARA>
  83           <command>RESET</command> restores variables to the
  84           default values.
  85           Refer to the <command>SET</command> command for details on
  86           allowed values and defaults.
  87           <command>RESET</command> is an alternate form for
  88           <synopsis>
  89                 <command>SET <replaceable class="parameter">variable</replaceable> = DEFAULT</command>
  90           </synopsis>
  91         </para>
  92
  93         <REFSECT2 ID="R2-SQL-RESET-3">
  94           <REFSECT2INFO>
  95                 <DATE>1998-09-24</DATE>
  96           </REFSECT2INFO>
  97           <TITLE>
  98                 Notes
  99           </TITLE>
 100           <PARA>
 101                 The RESET statement is a <productname>Postgres</productname> language extension.
 102           </para>
 103           <para>
 104                   Refer to SET/SHOW statements to set/show variable values.
 105           </para>
 106         </REFSECT2>
 107   </refsect1>
 108
 109   <REFSECT1 ID="R1-SQL-RESET-2">
 110         <TITLE>
 111           Usage
 112         </TITLE>
 113         <PARA>
 114           <ProgramListing>
 115                 -- reset DateStyle to its default;
 116                 RESET DateStyle;
 117           </programlisting>
 118           <programlisting>
 119                 -- reset Geqo to its default;
 120                 RESET GEQO;
 121           </ProgramListing>
 122         </para>
 123   </REFSECT1>
 124
 125   <REFSECT1 ID="R1-SQL-RESET-3">
 126         <TITLE>
 127           Compatibility
 128         </TITLE>
 129
 130         <REFSECT2 ID="R2-SQL-RESET-4">
 131           <REFSECT2INFO>
 132                 <DATE>1998-09-24</DATE>
 133           </REFSECT2INFO>
 134           <TITLE>
 135                 SQL92
 136           </TITLE>
 137           <PARA>
 138                 There is no <command>RESET</command> in <acronym>SQL92</acronym>.
 139           </para>
 140         </refsect2>
 141   </refsect1>
 142 </REFENTRY>