Debian Codegraph @

doc/src/sgml/ref/reset.sgml

raw
1 <!--
2 doc/src/sgml/ref/reset.sgml
3 PostgreSQL documentation
4 -->
5
6 <refentry id="sql-reset">
7 <indexterm zone="sql-reset">
8 <primary>RESET</primary>
9 </indexterm>
10
11 <refmeta>
12 <refentrytitle>RESET</refentrytitle>
13 <manvolnum>7</manvolnum>
14 <refmiscinfo>SQL - Language Statements</refmiscinfo>
15 </refmeta>
16
17 <refnamediv>
18 <refname>RESET</refname>
19 <refpurpose>restore the value of a run-time parameter to the default value</refpurpose>
20 </refnamediv>
21
22 <refsynopsisdiv>
23 <synopsis>
24 RESET <replaceable class="parameter">configuration_parameter</replaceable>
25 RESET ALL
26 </synopsis>
27 </refsynopsisdiv>
28
29 <refsect1>
30 <title>Description</title>
31
32 <para>
33 <command>RESET</command> restores run-time parameters to their
34 default values. <command>RESET</command> is an alternative
35 spelling for
36 <synopsis>
37 SET <replaceable class="parameter">configuration_parameter</replaceable> TO DEFAULT
38 </synopsis>
39 Refer to <xref linkend="sql-set"/> for
40 details.
41 </para>
42
43 <para>
44 The default value is defined as the value that the parameter would
45 have had, if no <command>SET</command> had ever been issued for it in the
46 current session. The actual source of this value might be a
47 compiled-in default, the configuration file, command-line options,
48 or per-database or per-user default settings. This is subtly different
49 from defining it as <quote>the value that the parameter had at session
50 start</quote>, because if the value came from the configuration file, it
51 will be reset to whatever is specified by the configuration file now.
52 See <xref linkend="runtime-config"/> for details.
53 </para>
54
55 <para>
56 The transactional behavior of <command>RESET</command> is the same as
57 <command>SET</command>: its effects will be undone by transaction rollback.
58 </para>
59 </refsect1>
60
61 <refsect1>
62 <title>Parameters</title>
63
64 <variablelist>
65 <varlistentry>
66 <term><replaceable class="parameter">configuration_parameter</replaceable></term>
67 <listitem>
68 <para>
69 Name of a settable run-time parameter. Available parameters are
70 documented in <xref linkend="runtime-config"/> and on the
71 <xref linkend="sql-set"/> reference page.
72 </para>
73 </listitem>
74 </varlistentry>
75
76 <varlistentry>
77 <term><literal>ALL</literal></term>
78 <listitem>
79 <para>
80 Resets all settable run-time parameters to default values.
81 </para>
82 </listitem>
83 </varlistentry>
84 </variablelist>
85 </refsect1>
86
87 <refsect1>
88 <title>Examples</title>
89
90 <para>
91 Set the <varname>timezone</varname> configuration variable to its default value:
92 <screen>
93 RESET timezone;
94 </screen></para>
95 </refsect1>
96
97 <refsect1>
98 <title>Compatibility</title>
99
100 <para>
101 <command>RESET</command> is a <productname>PostgreSQL</productname> extension.
102 </para>
103 </refsect1>
104
105 <refsect1>
106 <title>See Also</title>
107
108 <simplelist type="inline">
109 <member><xref linkend="sql-set"/></member>
110 <member><xref linkend="sql-show"/></member>
111 </simplelist>
112 </refsect1>
113 </refentry>