Skip to content

P
Postgres FD Implementation
Commit 3c4447fd authored by Thomas G. Lockhart's avatar Thomas G. Lockhart
Browse files
Options

Complete markup for docbook2man support. 

Fix synopsis info thanks to Yves.Martin@ensimag.imag.fr.
parent f2738394
Show whitespace changes
Inline Side-by-side
Showing with 65 additions and 142 deletions
doc/src/sgml/ref/set.sgml
View file @ 3c4447fd
...@@ -20,7 +20,7 @@ ...@@ -20,7 +20,7 @@
<synopsis> <synopsis>
SET <replaceable class="PARAMETER">variable</replaceable> { TO | = } { '<replaceable class="PARAMETER">value</replaceable>' | DEFAULT } SET <replaceable class="PARAMETER">variable</replaceable> { TO | = } { '<replaceable class="PARAMETER">value</replaceable>' | DEFAULT }
SET TIME ZONE { '<replaceable class="PARAMETER">timezone</replaceable>' | LOCAL | DEFAULT } SET TIME ZONE { '<replaceable class="PARAMETER">timezone</replaceable>' | LOCAL | DEFAULT }
SET TRANSACTION ISOLATION LEVEL { READ COMMITTED | SERIALIZED } SET TRANSACTION ISOLATION LEVEL { READ COMMITTED | SERIALIZABLE }
</synopsis> </synopsis>
<refsect2 id="R2-SQL-SET-1"> <refsect2 id="R2-SQL-SET-1">
...@@ -34,9 +34,7 @@ SET TRANSACTION ISOLATION LEVEL { READ COMMITTED | SERIALIZED } ...@@ -34,9 +34,7 @@ SET TRANSACTION ISOLATION LEVEL { READ COMMITTED | SERIALIZED }
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term><replaceable class="PARAMETER">variable</replaceable></term>
<replaceable class="PARAMETER">variable</replaceable>
</term>
<listitem> <listitem>
<para> <para>
Settable global parameter. Settable global parameter.
...@@ -44,9 +42,7 @@ SET TRANSACTION ISOLATION LEVEL { READ COMMITTED | SERIALIZED } ...@@ -44,9 +42,7 @@ SET TRANSACTION ISOLATION LEVEL { READ COMMITTED | SERIALIZED }
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term><replaceable class="PARAMETER">value</replaceable></term>
<replaceable class="PARAMETER">value</replaceable>
</term>
<listitem> <listitem>
<para> <para>
New value of parameter. New value of parameter.
...@@ -61,18 +57,14 @@ SET TRANSACTION ISOLATION LEVEL { READ COMMITTED | SERIALIZED } ...@@ -61,18 +57,14 @@ SET TRANSACTION ISOLATION LEVEL { READ COMMITTED | SERIALIZED }
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>CLIENT_ENCODING | NAMES</term>
CLIENT_ENCODING | NAMES
</term>
<listitem> <listitem>
<para> <para>
Sets the multi-byte client encoding. Parameters are: Sets the multi-byte client encoding. Parameters are:
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term><replaceable class="parameter">value</replaceable></term>
<replaceable class="parameter">value</replaceable>
</term>
<listitem> <listitem>
<para> <para>
Sets the multi-byte client encoding to Sets the multi-byte client encoding to
...@@ -83,9 +75,7 @@ CLIENT_ENCODING | NAMES ...@@ -83,9 +75,7 @@ CLIENT_ENCODING | NAMES
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>DEFAULT</term>
DEFAULT
</term>
<listitem> <listitem>
<para> <para>
Sets the multi-byte client encoding to the default value. Sets the multi-byte client encoding to the default value.
...@@ -102,9 +92,7 @@ DEFAULT ...@@ -102,9 +92,7 @@ DEFAULT
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>DateStyle</term>
DateStyle
</term>
<listitem> <listitem>
<para> <para>
Set the date/time representation style. Affects the output format, Set the date/time representation style. Affects the output format,
...@@ -112,9 +100,7 @@ DateStyle ...@@ -112,9 +100,7 @@ DateStyle
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>ISO</term>
ISO
</term>
<listitem> <listitem>
<para> <para>
use ISO 8601-style dates and times use ISO 8601-style dates and times
...@@ -122,9 +108,7 @@ ISO ...@@ -122,9 +108,7 @@ ISO
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>SQL</term>
SQL
</term>
<listitem> <listitem>
<para> <para>
use Oracle/Ingres-style dates and times use Oracle/Ingres-style dates and times
...@@ -132,9 +116,7 @@ SQL ...@@ -132,9 +116,7 @@ SQL
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>Postgres</term>
Postgres
</term>
<listitem> <listitem>
<para> <para>
use traditional <productname>Postgres</productname> format use traditional <productname>Postgres</productname> format
...@@ -142,9 +124,7 @@ Postgres ...@@ -142,9 +124,7 @@ Postgres
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>European</term>
European
</term>
<listitem> <listitem>
<para> <para>
use dd/mm/yyyy for numeric date representations. use dd/mm/yyyy for numeric date representations.
...@@ -152,9 +132,7 @@ European ...@@ -152,9 +132,7 @@ European
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>NonEuropean</term>
NonEuropean
</term>
<listitem> <listitem>
<para> <para>
use mm/dd/yyyy for numeric date representations. use mm/dd/yyyy for numeric date representations.
...@@ -162,9 +140,7 @@ NonEuropean ...@@ -162,9 +140,7 @@ NonEuropean
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>German</term>
German
</term>
<listitem> <listitem>
<para> <para>
use dd.mm.yyyy for numeric date representations. use dd.mm.yyyy for numeric date representations.
...@@ -172,9 +148,7 @@ German ...@@ -172,9 +148,7 @@ German
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>US</term>
US
</term>
<listitem> <listitem>
<para> <para>
same as 'NonEuropean' same as 'NonEuropean'
...@@ -182,9 +156,7 @@ US ...@@ -182,9 +156,7 @@ US
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>DEFAULT</term>
default
</term>
<listitem> <listitem>
<para> <para>
restores the default values ('US,Postgres') restores the default values ('US,Postgres')
...@@ -227,18 +199,14 @@ default ...@@ -227,18 +199,14 @@ default
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>SERVER_ENCODING</term>
SERVER_ENCODING
</term>
<listitem> <listitem>
<para> <para>
Sets the multi-byte server encoding Sets the multi-byte server encoding
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term><replaceable class="parameter">value</replaceable></term>
<replaceable class="parameter">value</replaceable>
</term>
<listitem> <listitem>
<para> <para>
Sets the multi-byte server encoding. Sets the multi-byte server encoding.
...@@ -247,9 +215,7 @@ SERVER_ENCODING ...@@ -247,9 +215,7 @@ SERVER_ENCODING
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>DEFAULT</term>
DEFAULT
</term>
<listitem> <listitem>
<para> <para>
Sets the multi-byte server encoding. Sets the multi-byte server encoding.
...@@ -265,9 +231,7 @@ DEFAULT ...@@ -265,9 +231,7 @@ DEFAULT
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>TIMEZONE</term>
TIMEZONE
</term>
<listitem> <listitem>
<para> <para>
The possible values for timezone depends on your operating The possible values for timezone depends on your operating
...@@ -279,9 +243,7 @@ TIMEZONE ...@@ -279,9 +243,7 @@ TIMEZONE
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>'PST8PDT'</term>
'PST8PDT'
</term>
<listitem> <listitem>
<para> <para>
set the timezone for California set the timezone for California
...@@ -289,9 +251,7 @@ TIMEZONE ...@@ -289,9 +251,7 @@ TIMEZONE
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>'Portugal'</term>
'Portugal'
</term>
<listitem> <listitem>
<para> <para>
set time zone for Portugal. set time zone for Portugal.
...@@ -299,9 +259,7 @@ TIMEZONE ...@@ -299,9 +259,7 @@ TIMEZONE
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>'Europe/Rome'</term>
'Europe/Rome'
</term>
<listitem> <listitem>
<para> <para>
set time zone for Italy. set time zone for Italy.
...@@ -309,9 +267,7 @@ TIMEZONE ...@@ -309,9 +267,7 @@ TIMEZONE
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>DEFAULT</term>
DEFAULT
</term>
<listitem> <listitem>
<para> <para>
set time zone to your local timezone set time zone to your local timezone
...@@ -339,18 +295,14 @@ DEFAULT ...@@ -339,18 +295,14 @@ DEFAULT
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>TRANSACTION ISOLATION LEVEL</term>
TRANSACTION ISOLATION LEVEL
</term>
<listitem> <listitem>
<para> <para>
Sets the isolation level for the current transaction. Sets the isolation level for the current transaction.
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>READ COMMITTED</term>
READ COMMITTED
</term>
<listitem> <listitem>
<para> <para>
The current transaction queries read only rows committed The current transaction queries read only rows committed
...@@ -367,9 +319,7 @@ READ COMMITTED ...@@ -367,9 +319,7 @@ READ COMMITTED
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>SERIALIZABLE</term>
SERIALIZABLE
</term>
<listitem> <listitem>
<para> <para>
The current transaction queries read only rows committed The current transaction queries read only rows committed
...@@ -394,18 +344,14 @@ SERIALIZABLE ...@@ -394,18 +344,14 @@ SERIALIZABLE
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>COST_HEAP</term>
COST_HEAP
</term>
<listitem> <listitem>
<para> <para>
Sets the default cost of a heap scan for use by the optimizer. Sets the default cost of a heap scan for use by the optimizer.
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term><replaceable class="parameter">float4</replaceable></term>
<replaceable class="parameter">float4</replaceable>
</term>
<listitem> <listitem>
<para> <para>
Set the cost of a heap scan to the specified floating point value. Set the cost of a heap scan to the specified floating point value.
...@@ -414,9 +360,7 @@ COST_HEAP ...@@ -414,9 +360,7 @@ COST_HEAP
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>DEFAULT</term>
DEFAULT
</term>
<listitem> <listitem>
<para> <para>
Sets the cost of a heap scan to the default value. Sets the cost of a heap scan to the default value.
...@@ -433,18 +377,14 @@ DEFAULT ...@@ -433,18 +377,14 @@ DEFAULT
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>COST_INDEX</term>
COST_INDEX
</term>
<listitem> <listitem>
<para> <para>
Sets the default cost of an index scan for use by the optimizer. Sets the default cost of an index scan for use by the optimizer.
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term><replaceable class="parameter">float4</replaceable></term>
<replaceable class="parameter">float4</replaceable>
</term>
<listitem> <listitem>
<para> <para>
Set the cost of an index scan to the specified floating point value. Set the cost of an index scan to the specified floating point value.
...@@ -453,9 +393,7 @@ COST_INDEX ...@@ -453,9 +393,7 @@ COST_INDEX
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>DEFAULT</term>
DEFAULT
</term>
<listitem> <listitem>
<para> <para>
Sets the cost of an index scan to the default value. Sets the cost of an index scan to the default value.
...@@ -473,18 +411,14 @@ DEFAULT ...@@ -473,18 +411,14 @@ DEFAULT
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>GEQO</term>
GEQO
</term>
<listitem> <listitem>
<para> <para>
Sets the threshold for using the genetic optimizer algorithm. Sets the threshold for using the genetic optimizer algorithm.
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>ON</term>
ON
</term>
<listitem> <listitem>
<para> <para>
enables the genetic optimizer algorithm enables the genetic optimizer algorithm
...@@ -492,10 +426,9 @@ ON ...@@ -492,10 +426,9 @@ ON
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>ON=<replaceable class="parameter">#</replaceable></term>
ON=<replaceable class="parameter">#</replaceable>
</term>
<listitem> <listitem>
<para> <para>
Takes an integer argument to enable the genetic optimizer algorithm Takes an integer argument to enable the genetic optimizer algorithm
...@@ -504,10 +437,9 @@ ON=<replaceable class="parameter">#</replaceable> ...@@ -504,10 +437,9 @@ ON=<replaceable class="parameter">#</replaceable>
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>OFF</term>
OFF
</term>
<listitem> <listitem>
<para> <para>
disables the genetic optimizer algorithm. disables the genetic optimizer algorithm.
...@@ -515,9 +447,7 @@ OFF ...@@ -515,9 +447,7 @@ OFF
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>DEFAULT</term>
DEFAULT
</term>
<listitem> <listitem>
<para> <para>
Equivalent to specifying <command>SET GEQO='ON'</command> Equivalent to specifying <command>SET GEQO='ON'</command>
...@@ -546,9 +476,7 @@ DEFAULT ...@@ -546,9 +476,7 @@ DEFAULT
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>KSQO</term>
KSQO
</term>
<listitem> <listitem>
<para> <para>
<firstterm>Key Set Query Optimizer</firstterm> forces the query optimizer <firstterm>Key Set Query Optimizer</firstterm> forces the query optimizer
...@@ -557,9 +485,7 @@ KSQO ...@@ -557,9 +485,7 @@ KSQO
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term>ON</term>
ON
</term>
<listitem> <listitem>
<para> <para>
enables this optimization. enables this optimization.
...@@ -568,9 +494,7 @@ ON ...@@ -568,9 +494,7 @@ ON
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>OFF</term>
OFF
</term>
<listitem> <listitem>
<para> <para>
disables this optimization. disables this optimization.
...@@ -579,9 +503,7 @@ OFF ...@@ -579,9 +503,7 @@ OFF
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term>DEFAULT</term>
DEFAULT
</term>
<listitem> <listitem>
<para> <para>
Equivalent to specifying <command>SET KSQO='OFF'</command>. Equivalent to specifying <command>SET KSQO='OFF'</command>.
...@@ -618,9 +540,9 @@ DEFAULT ...@@ -618,9 +540,9 @@ DEFAULT
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term> <term><computeroutput>
<returnvalue>SET VARIABLE</returnvalue> SET VARIABLE
</term> </computeroutput></term>
<listitem> <listitem>
<para> <para>
Message returned if successfully. Message returned if successfully.
...@@ -629,9 +551,9 @@ DEFAULT ...@@ -629,9 +551,9 @@ DEFAULT
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term> <term><computeroutput>
<returnvalue>WARN: Bad value for <replaceable class="parameter">variable</replaceable> (<replaceable class="parameter">value</replaceable>)</returnvalue> WARN: Bad value for <replaceable class="parameter">variable</replaceable> (<replaceable class="parameter">value</replaceable>)
</term> </computeroutput></term>
<listitem> <listitem>
<para> <para>
If the command fails to set the specified variable. If the command fails to set the specified variable.
...@@ -697,26 +619,26 @@ DEFAULT ...@@ -697,26 +619,26 @@ DEFAULT
Set the style of date to ISO: Set the style of date to ISO:
<programlisting> <programlisting>
SET DATESTYLE TO 'ISO'; SET DATESTYLE TO 'ISO';
</programlisting> </programlisting>
Enable GEQO for queries with 4 or more tables: Enable GEQO for queries with 4 or more tables:
<programlisting> <programlisting>
SET GEQO ON=4; SET GEQO ON=4;
</programlisting> </programlisting>
Set GEQO to default: Set GEQO to default:
<programlisting> <programlisting>
SET GEQO = DEFAULT; SET GEQO = DEFAULT;
</programlisting> </programlisting>
Set the timezone for Berkeley, California: Set the timezone for Berkeley, California:
<programlisting> <programlisting>
SET TIME ZONE 'PST8PDT'; SET TIME ZONE 'PST8PDT';
SELECT CURRENT_TIMESTAMP AS today; SELECT CURRENT_TIMESTAMP AS today;
today today
---------------------- ----------------------
...@@ -726,8 +648,8 @@ DEFAULT ...@@ -726,8 +648,8 @@ DEFAULT
Set the timezone for Italy: Set the timezone for Italy:
<programlisting> <programlisting>
SET TIME ZONE 'Europe/Rome'; SET TIME ZONE 'Europe/Rome';
SELECT CURRENT_TIMESTAMP AS today; SELECT CURRENT_TIMESTAMP AS today;
today today
---------------------- ----------------------
...@@ -751,17 +673,18 @@ DEFAULT ...@@ -751,17 +673,18 @@ DEFAULT
SQL92 SQL92
</title> </title>
<para> <para>
There is no There is no general
<command>SET <replaceable class="parameter">variable</replaceable></command> <command>SET <replaceable class="parameter">variable</replaceable></command>
in <acronym>SQL92</acronym> (except for SET TRANSACTION ISOLATION LEVEL). in <acronym>SQL92</acronym> (with the exception of
<command>SET TRANSACTION ISOLATION LEVEL</command>).
The <acronym>SQL92</acronym> syntax for <command>SET TIME ZONE</command> The <acronym>SQL92</acronym> syntax for <command>SET TIME ZONE</command>
is slightly different, is slightly different,
allowing only a single integer value for time zone specification: allowing only a single integer value for time zone specification:
<programlisting> <synopsis>
SET TIME ZONE { interval_value_expression | LOCAL } SET TIME ZONE { interval_value_expression | LOCAL }
</programlisting> </synopsis>
</para> </para>
</refsect2> </refsect2>
</refsect1> </refsect1>
...@@ -779,7 +702,7 @@ sgml-indent-data:t ...@@ -779,7 +702,7 @@ sgml-indent-data:t
sgml-parent-document:nil sgml-parent-document:nil
sgml-default-dtd-file:"../reference.ced" sgml-default-dtd-file:"../reference.ced"
sgml-exposed-tags:nil sgml-exposed-tags:nil
sgml-local-catalogs:"/usr/lib/sgml/CATALOG" sgml-local-catalogs:"/usr/lib/sgml/catalog"
sgml-local-ecat-files:nil sgml-local-ecat-files:nil
End: End:
--> -->
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment