postgresql/doc/src/sgml/ref/show.sgml

<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>