summaryrefslogtreecommitdiffstats
path: root/doc/src/sgml/man7/SHOW.7
blob: 5b0306417d7c2647f15ee1bff744de63635bc15a (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
'\" t
.\"     Title: SHOW
.\"    Author: The PostgreSQL Global Development Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 2023
.\"    Manual: PostgreSQL 15.5 Documentation
.\"    Source: PostgreSQL 15.5
.\"  Language: English
.\"
.TH "SHOW" "7" "2023" "PostgreSQL 15.5" "PostgreSQL 15.5 Documentation"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
SHOW \- show the value of a run\-time parameter
.SH "SYNOPSIS"
.sp
.nf
SHOW \fIname\fR
SHOW ALL
.fi
.SH "DESCRIPTION"
.PP
\fBSHOW\fR
will display the current setting of run\-time parameters\&. These variables can be set using the
\fBSET\fR
statement, by editing the
postgresql\&.conf
configuration file, through the
\fBPGOPTIONS\fR
environmental variable (when using
libpq
or a
libpq\-based application), or through command\-line flags when starting the
\fBpostgres\fR
server\&. See
Chapter\ \&20
for details\&.
.SH "PARAMETERS"
.PP
\fIname\fR
.RS 4
The name of a run\-time parameter\&. Available parameters are documented in
Chapter\ \&20
and on the
\fBSET\fR(7)
reference page\&. In addition, there are a few parameters that can be shown but not set:
.PP
SERVER_VERSION
.RS 4
Shows the server\*(Aqs version number\&.
.RE
.PP
SERVER_ENCODING
.RS 4
Shows the server\-side character set encoding\&. At present, this parameter can be shown but not set, because the encoding is determined at database creation time\&.
.RE
.PP
LC_COLLATE
.RS 4
Shows the database\*(Aqs locale setting for collation (text ordering)\&. At present, this parameter can be shown but not set, because the setting is determined at database creation time\&.
.RE
.PP
LC_CTYPE
.RS 4
Shows the database\*(Aqs locale setting for character classification\&. At present, this parameter can be shown but not set, because the setting is determined at database creation time\&.
.RE
.PP
IS_SUPERUSER
.RS 4
True if the current role has superuser privileges\&.
.RE
.RE
.PP
ALL
.RS 4
Show the values of all configuration parameters, with descriptions\&.
.RE
.SH "NOTES"
.PP
The function
\fBcurrent_setting\fR
produces equivalent output; see
Section\ \&9.27.1\&. Also, the
pg_settings
system view produces the same information\&.
.SH "EXAMPLES"
.PP
Show the current setting of the parameter
\fIDateStyle\fR:
.sp
.if n \{\
.RS 4
.\}
.nf
SHOW DateStyle;
 DateStyle
\-\-\-\-\-\-\-\-\-\-\-
 ISO, MDY
(1 row)
.fi
.if n \{\
.RE
.\}
.PP
Show the current setting of the parameter
\fIgeqo\fR:
.sp
.if n \{\
.RS 4
.\}
.nf
SHOW geqo;
 geqo
\-\-\-\-\-\-
 on
(1 row)
.fi
.if n \{\
.RE
.\}
.PP
Show all settings:
.sp
.if n \{\
.RS 4
.\}
.nf
SHOW ALL;
            name         | setting |                description
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
 allow_system_table_mods | off     | Allows modifications of the structure of \&.\&.\&.
    \&.
    \&.
    \&.
 xmloption               | content | Sets whether XML data in implicit parsing \&.\&.\&.
 zero_damaged_pages      | off     | Continues processing past damaged page headers\&.
(196 rows)
.fi
.if n \{\
.RE
.\}
.SH "COMPATIBILITY"
.PP
The
\fBSHOW\fR
command is a
PostgreSQL
extension\&.
.SH "SEE ALSO"
\fBSET\fR(7), \fBRESET\fR(7)