begriffs open source - ai-pg/blob - full-docs/man7/SHOW.7

   1 '\" t
   2 .\"     Title: SHOW
   3 .\"    Author: The PostgreSQL Global Development Group
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2025
   6 .\"    Manual: PostgreSQL 18.0 Documentation
   7 .\"    Source: PostgreSQL 18.0
   8 .\"  Language: English
   9 .\"
  10 .TH "SHOW" "7" "2025" "PostgreSQL 18.0" "PostgreSQL 18.0 Documentation"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 SHOW \- show the value of a run\-time parameter
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 SHOW \fIname\fR
  36 SHOW ALL
  37 .fi
  38 .SH "DESCRIPTION"
  39 .PP
  40 \fBSHOW\fR
  41 will display the current setting of run\-time parameters\&. These variables can be set using the
  42 \fBSET\fR
  43 statement, by editing the
  44 postgresql\&.conf
  45 configuration file, through the
  46 \fBPGOPTIONS\fR
  47 environmental variable (when using
  48 libpq
  49 or a
  50 libpq\-based application), or through command\-line flags when starting the
  51 \fBpostgres\fR
  52 server\&. See
  53 Chapter\ \&19
  54 for details\&.
  55 .SH "PARAMETERS"
  56 .PP
  57 \fIname\fR
  58 .RS 4
  59 The name of a run\-time parameter\&. Available parameters are documented in
  60 Chapter\ \&19
  61 and on the
  62 \fBSET\fR(7)
  63 reference page\&. In addition, there are a few parameters that can be shown but not set:
  64 .PP
  65 SERVER_VERSION
  66 .RS 4
  67 Shows the server\*(Aqs version number\&.
  68 .RE
  69 .PP
  70 SERVER_ENCODING
  71 .RS 4
  72 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\&.
  73 .RE
  74 .PP
  75 IS_SUPERUSER
  76 .RS 4
  77 True if the current role has superuser privileges\&.
  78 .RE
  79 .RE
  80 .PP
  81 ALL
  82 .RS 4
  83 Show the values of all configuration parameters, with descriptions\&.
  84 .RE
  85 .SH "NOTES"
  86 .PP
  87 The function
  88 \fBcurrent_setting\fR
  89 produces equivalent output; see
  90 Section\ \&9.28.1\&. Also, the
  91 pg_settings
  92 system view produces the same information\&.
  93 .SH "EXAMPLES"
  94 .PP
  95 Show the current setting of the parameter
  96 \fIDateStyle\fR:
  97 .sp
  98 .if n \{\
  99 .RS 4
 100 .\}
 101 .nf
 102 SHOW DateStyle;
 103  DateStyle
 104 \-\-\-\-\-\-\-\-\-\-\-
 105  ISO, MDY
 106 (1 row)
 107 .fi
 108 .if n \{\
 109 .RE
 110 .\}
 111 .PP
 112 Show the current setting of the parameter
 113 \fIgeqo\fR:
 114 .sp
 115 .if n \{\
 116 .RS 4
 117 .\}
 118 .nf
 119 SHOW geqo;
 120  geqo
 121 \-\-\-\-\-\-
 122  on
 123 (1 row)
 124 .fi
 125 .if n \{\
 126 .RE
 127 .\}
 128 .PP
 129 Show all settings:
 130 .sp
 131 .if n \{\
 132 .RS 4
 133 .\}
 134 .nf
 135 SHOW ALL;
 136             name         | setting |                description
 137 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
 138  allow_system_table_mods | off     | Allows modifications of the structure of \&.\&.\&.
 139     \&.
 140     \&.
 141     \&.
 142  xmloption               | content | Sets whether XML data in implicit parsing \&.\&.\&.
 143  zero_damaged_pages      | off     | Continues processing past damaged page headers\&.
 144 (196 rows)
 145 .fi
 146 .if n \{\
 147 .RE
 148 .\}
 149 .SH "COMPATIBILITY"
 150 .PP
 151 The
 152 \fBSHOW\fR
 153 command is a
 154 PostgreSQL
 155 extension\&.
 156 .SH "SEE ALSO"
 157 \fBSET\fR(7), \fBRESET\fR(7)