aboutsummaryrefslogtreecommitdiff
path: root/doc/src/sgml/ref/reset.sgml
blob: e98f7ff56c6af0830cb33f62eb7200b772cc82a4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/reset.sgml,v 1.34 2007/04/12 22:34:45 neilc 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>
RESET <replaceable class="PARAMETER">configuration_parameter</replaceable>
RESET ALL
RESET { PLANS | SESSION | TEMP | TEMPORARY }
</synopsis>
 </refsynopsisdiv>

 <refsect1>
  <title>Description</title>

  <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">configuration_parameter</replaceable> TO DEFAULT
</synopsis>
   Refer to <xref linkend="sql-set" endterm="sql-set-title"> for
   details.
  </para>

  <para>
   The default value is defined as the value that the parameter would
   have had, if no <command>SET</> had 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</>.
  </para>

  <para>
   <command>RESET</> can also be used to release internal resources
   that are usually released at the end of session.  <command>RESET
   TEMP</> drops all temporary tables created in the current session.
   <command>RESET PLANS</> releases all internally cached plans.
   <command>RESET SESSION</> releases all externally visible temporary
   resources associated with the current session.
  </para>
 </refsect1>

 <refsect1>
  <title>Parameters</title>

  <variablelist>
   <varlistentry>
    <term><replaceable class="PARAMETER">configuration_parameter</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>

   <varlistentry>
    <term><literal>TEMP, TEMPORARY</literal></term>
    <listitem>
     <para>
      Drops all temporary tables created in the current session.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><literal>PLANS</literal></term>
    <listitem>
     <para>
      Releases all cached query plans.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><literal>SESSION</literal></term>
    <listitem>
     <para>
      Releases all temporary resources associated with the current
      session. This has the same effect as executing the following
      command sequence:
<programlisting>
SET SESSION AUTHORIZATION DEFAULT;
RESET ALL;
DEALLOCATE ALL;
CLOSE ALL;
UNLISTEN *;
RESET PLANS;
RESET TEMP;
</programlisting>
     </para>
    </listitem>
   </varlistentry>

  </variablelist>
 </refsect1>

 <refsect1>
  <title>Notes</title>

   <para>
    <command>RESET SESSION</> cannot be executed inside a transaction block.
   </para>
 </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>