aboutsummaryrefslogtreecommitdiff
path: root/doc/src/sgml/ref/show.sgml
blob: 4db7531fbdf327af3a80ab95a1634686274664ad (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
<REFENTRY ID="SQL-SHOW">
<REFMETA>
<REFENTRYTITLE>
SHOW
</REFENTRYTITLE>
<REFMISCINFO>SQL - Language Statements</REFMISCINFO>
</REFMETA>
<REFNAMEDIV>
<REFNAME>
SHOW
</REFNAME>
<REFPURPOSE>
Shows run-time parameters for session
</REFPURPOSE>
  </refnamediv>
<REFSYNOPSISDIV>
<REFSYNOPSISDIVINFO>
<DATE>1998-09-24</DATE>
</REFSYNOPSISDIVINFO>
<SYNOPSIS>
SHOW <REPLACEABLE CLASS="PARAMETER">variable</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">variable</REPLACEABLE>
			</TERM>
			<LISTITEM>
			  <PARA>
				Refer to <command>SET</command> 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>
			  <returnvalue>NOTICE: <REPLACEABLE CLASS="PARAMETER">variable</REPLACEABLE> is <replaceable>value</replaceable></ReturnValue>
			  SHOW VARIABLE
			</TERM>
			<LISTITEM>
			  <PARA>
				Message returned if successfully.
			  </para>
			</listitem>
		  </varlistentry>
		  <VARLISTENTRY>
			<TERM>
			  <returnvalue>NOTICE:  Unrecognized variable <replaceable>value</replaceable></ReturnValue>
			</TERM>
			<LISTITEM>
			  <PARA>
				Message returned if <ReturnValue>value</ReturnValue> does not exist.
			  </PARA>
			</LISTITEM>
		  </VARLISTENTRY>
		  
		  <VARLISTENTRY>
			<TERM>
			  NOTICE:  Time zone is unknown
			  SHOW VARIABLE
			</TERM>
			<LISTITEM>
			  <PARA>
				If the TZ 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
	  configuration parameters for
	  variable during a session.
	</para>
	<para>
	  The session can be configured using <command>SET</command> statement,
	  and values
	  can be restored to the defaults using <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>
		The <command>SHOW</command> is a <productname>Postgres</productname>
		language extension.
	  </para>
	  <para>
		Refer to  <command>SET</command>/<command>RESET</command> 
		to set/reset variable values.
		See also  <command>SET TIME ZONE</command>.
	  </para>
	</REFSECT2>
  </REFSECT1>

  <REFSECT1 ID="R1-SQL-SHOW-2">
	<TITLE>
	  Usage
	</TITLE>
	<PARA>
	  <ProgramListing>
		-- show DateStyle;
		SHOW DateStyle;
		NOTICE:DateStyle is Postgres with US (NonEuropean) conventions
		
		-- show Geqo;
		SHOW GEQO;
		NOTICE:GEQO is ON
	  </ProgramListing>
	</para>
  </REFSECT1>

  <REFSECT1 ID="R1-SQL-SHOW-3">
	<TITLE>
	  Compatibility
	</TITLE>
	<PARA>
	</PARA>
	
	<REFSECT2 ID="R2-SQL-SHOW-4">
	  <REFSECT2INFO>
		<DATE>1998-09-24</DATE>
	  </REFSECT2INFO>
	  <TITLE>
		SQL92
	  </TITLE>
	  <PARA>
		There is no <command>SET</command> defined in <acronym>SQL92</acronym>.
	  </para>
	</refsect2>
  </refsect1>
</REFENTRY>