aboutsummaryrefslogtreecommitdiff
path: root/doc/src/sgml/ref/show.sgml
blob: 7cacd634e7bb75635766066cedfe5575bdb1a8d2 (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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/show.sgml,v 1.9 2000/04/08 02:39:02 tgl Exp $
Postgres documentation
-->

<refentry id="SQL-SHOW">
 <refmeta>
  <refentrytitle id="SQL-SHOW-TITLE">
   SHOW
  </refentrytitle>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>
   SHOW
  </refname>
  <refpurpose>
   Shows run-time parameters for session
  </refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <refsynopsisdivinfo>
   <date>1999-07-20</date>
  </refsynopsisdivinfo>
  <synopsis>
SHOW <replaceable class="PARAMETER">keyword</replaceable>
  </synopsis>

  <refsect2 id="R2-SQL-SHOW-1">
   <refsect2info>
    <date>1998-09-24</date>
   </refsect2info>
   <title>
    Inputs
   </title>

   <para>
    <variablelist>
     <varlistentry>
      <term><replaceable class="PARAMETER">keyword</replaceable></term>
      <listitem>
       <para>
	Refer to
	<xref linkend="sql-set-title" endterm="sql-set-title">
	for more information on available variables.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </refsect2>

  <refsect2 id="R2-SQL-SHOW-2">
   <refsect2info>
    <date>1998-09-24</date>
   </refsect2info>
   <title>
    Outputs
   </title>

   <para>
    <variablelist>
     <varlistentry>
      <term><computeroutput>
NOTICE: <replaceable class="PARAMETER">variable</replaceable> is <replaceable>value</replaceable>
       </computeroutput></term>
      <listitem>
       <para>
	Message returned if successful.
       </para>
      </listitem>
     </varlistentry>
     <varlistentry>
      <term><computeroutput>
NOTICE:  Unrecognized variable <replaceable>value</replaceable>
       </computeroutput></term>
      <listitem>
       <para>
	Message returned if <returnvalue>variable</returnvalue> does not exist.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><computeroutput>
NOTICE:  Time zone is unknown
       </computeroutput></term>
      <listitem>
       <para>
	If the <envar>TZ</envar> or <envar>PGTZ</envar> environment
	variable is not set.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </refsect2>
 </refsynopsisdiv>

 <refsect1 id="R1-SQL-SHOW-1">
  <refsect1info>
   <date>1998-09-24</date>
  </refsect1info>
  <title>
   Description
  </title>
  <para>
   <command>SHOW</command> will display the current setting of a
   run-time parameter during a session.
  </para>
  <para>
   These variables can be set using the <command>SET</command> statement,
   and
   can be restored to the default values using the <command>RESET</command>
   statement.
   Parameters and values are case-insensitive.
  </para>

  <refsect2 id="R2-SQL-SHOW-3">
   <refsect2info>
    <date>1998-09-24</date>
   </refsect2info>
   <title>
    Notes
   </title>
   <para>
    See also
    <xref linkend="sql-set-title" endterm="sql-set-title"> and
    <xref linkend="sql-reset-title" endterm="sql-reset-title">
    to manipulate variable values.
   </para>
  </refsect2>
 </refsect1>

 <refsect1 id="R1-SQL-SHOW-2">
  <title>
   Usage
  </title>
  <para>
   Show the current <literal>DateStyle</literal> setting:

   <programlisting>
SHOW DateStyle;
NOTICE:  DateStyle is ISO with US (NonEuropean) conventions
   </programlisting>
  </para>

  <para>
   Show the current genetic optimizer (<literal>geqo</literal>) setting:
   <programlisting>
SHOW GEQO;
NOTICE:  GEQO is ON beginning with 11 relations
   </programlisting>
  </para>
 </refsect1>

 <refsect1 id="R1-SQL-SHOW-3">
  <title>
   Compatibility
  </title>

  <refsect2 id="R2-SQL-SHOW-4">
   <refsect2info>
    <date>1998-09-24</date>
   </refsect2info>
   <title>
    SQL92
   </title>
   <para>
    There is no <command>SHOW</command> defined in <acronym>SQL92</acronym>.
   </para>
  </refsect2>
 </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:
-->