diff options
Diffstat (limited to 'doc/src/sgml/ref/show.sgml')
| -rw-r--r-- | doc/src/sgml/ref/show.sgml | 231 |
1 files changed, 114 insertions, 117 deletions
diff --git a/doc/src/sgml/ref/show.sgml b/doc/src/sgml/ref/show.sgml index 0fec5fcce55..dd8e9cf0412 100644 --- a/doc/src/sgml/ref/show.sgml +++ b/doc/src/sgml/ref/show.sgml @@ -1,5 +1,5 @@ <!-- -$Header: /cvsroot/pgsql/doc/src/sgml/ref/show.sgml,v 1.25 2003/04/25 19:45:08 tgl Exp $ +$Header: /cvsroot/pgsql/doc/src/sgml/ref/show.sgml,v 1.26 2003/05/04 02:23:16 petere Exp $ PostgreSQL documentation --> @@ -8,58 +8,34 @@ PostgreSQL documentation <refentrytitle id="SQL-SHOW-TITLE">SHOW</refentrytitle> <refmiscinfo>SQL - Language Statements</refmiscinfo> </refmeta> + <refnamediv> <refname>SHOW</refname> <refpurpose>show the value of a run-time parameter</refpurpose> </refnamediv> + <refsynopsisdiv> - <synopsis> +<synopsis> SHOW <replaceable class="PARAMETER">name</replaceable> - </synopsis> - <synopsis> +</synopsis> +<synopsis> SHOW ALL - </synopsis> - - <refsect2 id="R2-SQL-SHOW-1"> - <title>Inputs</title> - - <para> - <variablelist> - <varlistentry> - <term><replaceable class="PARAMETER">name</replaceable></term> - <listitem> - <para> - The name of a run-time parameter. See - <xref linkend="sql-set" endterm="sql-set-title"> - for a list. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>ALL</term> - <listitem> - <para> - Show all current session parameters. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect2> - +</synopsis> </refsynopsisdiv> - <refsect1 id="R1-SQL-SHOW-1"> + <refsect1> <title>Description</title> + <para> <command>SHOW</command> will display the current setting of run-time parameters. These variables can be set using the <command>SET</command> statement, by editing the - <filename>postgresql.conf</filename> configuration file, through the - <envar>PGOPTIONS</envar> environmental variable (when using libpq - or a libpq-based application), or through - command-line flags when starting the - <application>postmaster</application>. + <filename>postgresql.conf</filename> configuration file, through + the <envar>PGOPTIONS</envar> environmental variable (when using + <application>libpq</> or a <application>libpq</>-based + application), or through command-line flags when starting the + <command>postmaster</command>. See <xref + linkend="runtime-config"> for details. </para> <para> @@ -67,83 +43,96 @@ SHOW ALL does not start a new transaction block. See the <varname>autocommit</> section in <xref linkend="runtime-config"> for details. </para> + </refsect1> - <para> - Available parameters are documented in - <xref linkend="runtime-config"> and on the - <xref linkend="SQL-SET" endterm="SQL-SET-title"> reference page. - In addition, there are a few parameters that can be shown but not set: - - <variablelist> - - <varlistentry> - <term>SERVER_VERSION</term> - <listitem> - <para> - Shows the server's version number. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>SERVER_ENCODING</term> - <listitem> - <para> - Shows the server-side multibyte encoding. At present, this - parameter can be shown but not set, because the encoding is - determined at database creation time. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>LC_COLLATE</term> - <listitem> - <para> - Shows the database's locale setting for collation (text ordering). - At present, this parameter can be shown but not set, because the - setting is determined at <application>initdb</> time. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term>LC_CTYPE</term> - <listitem> - <para> - Shows the database's locale setting for character set considerations. - At present, this parameter can be shown but not set, because the - setting is determined at <application>initdb</> time. - </para> - </listitem> - </varlistentry> - - </variablelist> - </para> - - <para> - Use <xref linkend="SQL-SET" endterm="SQL-SET-title"> to set the value - of settable parameters. - </para> + <refsect1> + <title>Parameters</title> + + <variablelist> + <varlistentry> + <term><replaceable class="PARAMETER">name</replaceable></term> + <listitem> + <para> + The name of a run-time parameter. Available parameters are + documented in <xref linkend="runtime-config"> and on the <xref + linkend="SQL-SET" endterm="SQL-SET-title"> reference page. In + addition, there are a few parameters that can be shown but not + set: + + <variablelist> + <varlistentry> + <term><literal>SERVER_VERSION</literal></term> + <listitem> + <para> + Shows the server's version number. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>SERVER_ENCODING</literal></term> + <listitem> + <para> + 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. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>LC_COLLATE</literal></term> + <listitem> + <para> + Shows the database's locale setting for collation (text + ordering). At present, this parameter can be shown but not + set, because the setting is determined at + <command>initdb</> time. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>LC_CTYPE</literal></term> + <listitem> + <para> + Shows the database's locale setting for character + classification. At present, this parameter can be shown but + not set, because the setting is determined at + <command>initdb</> time. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>ALL</literal></term> + <listitem> + <para> + Show the values of all configurations parameters. + </para> + </listitem> + </varlistentry> + </variablelist> </refsect1> <refsect1> <title>Diagnostics</title> - <para> - <variablelist> - <varlistentry> - <term><computeroutput>ERROR: Option '<replaceable>name</replaceable>' - is not recognized</computeroutput></term> - <listitem> - <para> - Message returned if <replaceable>name</replaceable> does - not stand for a known parameter. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> + <variablelist> + <varlistentry> + <term><computeroutput>ERROR: Option '<replaceable>name</replaceable>' is not recognized</computeroutput></term> + <listitem> + <para> + Message returned if <replaceable>name</replaceable> does not + stand for a known parameter. + </para> + </listitem> + </varlistentry> + </variablelist> </refsect1> <refsect1> @@ -155,10 +144,11 @@ SHOW ALL </para> </refsect1> - <refsect1 id="R1-SQL-SHOW-2"> + <refsect1> <title>Examples</title> + <para> - Show the current <varname>DateStyle</varname> setting: + Show the current setting of the parameter <varname>DateStyle</varname>: <programlisting> SHOW DateStyle; @@ -170,10 +160,9 @@ SHOW DateStyle; </para> <para> - Show whether the genetic query optimizer is enabled by displaying - the <varname>geqo</varname> setting: + Show the current setting of the parameter <varname>geqo</varname>: <programlisting> -SHOW GEQO; +SHOW geqo; geqo ------ on @@ -198,10 +187,9 @@ SHOW ALL; (94 rows) </programlisting> </para> - </refsect1> - <refsect1 id="R1-SQL-SHOW-3"> + <refsect1> <title>Compatibility</title> <para> @@ -209,6 +197,15 @@ SHOW ALL; <productname>PostgreSQL</productname> extension. </para> </refsect1> + + <refsect1> + <title>See Also</title> + + <simplelist type="inline"> + <member><xref linkend="SQL-SET" endterm="SQL-SET-title"></member> + </simplelist> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file |