2000-03-31 05:27:42 +02:00
|
|
|
<!--
|
2003-03-28 21:17:13 +01:00
|
|
|
$Header: /cvsroot/pgsql/doc/src/sgml/runtime.sgml,v 1.175 2003/03/28 20:17:13 tgl Exp $
|
2000-03-31 05:27:42 +02:00
|
|
|
-->
|
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<Chapter Id="runtime">
|
2002-03-22 20:20:45 +01:00
|
|
|
<Title>Server Run-time Environment</Title>
|
2000-06-18 23:24:54 +02:00
|
|
|
|
|
|
|
<Para>
|
|
|
|
This chapter discusses how to set up and run the database server
|
|
|
|
and the interactions with the operating system.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<sect1 id="postgres-user">
|
2002-11-11 21:14:04 +01:00
|
|
|
<title>The <productname>PostgreSQL</productname> User Account</title>
|
2000-06-18 23:24:54 +02:00
|
|
|
|
2001-05-13 00:51:36 +02:00
|
|
|
<indexterm>
|
|
|
|
<primary>postgres user</primary>
|
|
|
|
</indexterm>
|
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
As with any other server daemon that is connected to outside world,
|
|
|
|
it is advisable to run <productname>PostgreSQL</productname> under a
|
|
|
|
separate user account. This user account should only own the data
|
|
|
|
that is managed by the server, and should not be shared with other
|
2003-03-24 15:32:51 +01:00
|
|
|
daemons. (For example, using the user <literal>nobody</literal> is a bad
|
2002-03-09 06:11:38 +01:00
|
|
|
idea.) It is not advisable to install executables owned by
|
|
|
|
this user because compromised systems could then modify their own
|
|
|
|
binaries.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
1999-05-20 07:39:29 +02:00
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
To add a Unix user account to your system, look for a command
|
2000-06-18 23:24:54 +02:00
|
|
|
<command>useradd</command> or <command>adduser</command>. The user
|
2002-03-09 06:11:38 +01:00
|
|
|
name <systemitem>postgres</systemitem> is often used but is by no
|
|
|
|
means required.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
|
|
|
</sect1>
|
|
|
|
|
|
|
|
<sect1 id="creating-cluster">
|
2002-11-11 21:14:04 +01:00
|
|
|
<title>Creating a Database Cluster</title>
|
2000-06-18 23:24:54 +02:00
|
|
|
|
2001-05-13 00:51:36 +02:00
|
|
|
<indexterm>
|
|
|
|
<primary>database cluster</primary>
|
|
|
|
</indexterm>
|
|
|
|
|
|
|
|
<indexterm>
|
|
|
|
<primary>data area</primary>
|
|
|
|
<see>database cluster</see>
|
|
|
|
</indexterm>
|
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<para>
|
|
|
|
Before you can do anything, you must initialize a database storage
|
2001-11-28 01:13:30 +01:00
|
|
|
area on disk. We call this a <firstterm>database cluster</firstterm>.
|
2002-03-09 06:11:38 +01:00
|
|
|
(<acronym>SQL</acronym> uses the term catalog cluster instead.) A
|
|
|
|
database cluster is a collection of databases is accessible by a
|
|
|
|
single instance of a running database server. After initialization, a
|
|
|
|
database cluster will contain a database named
|
2001-11-28 01:13:30 +01:00
|
|
|
<literal>template1</literal>. As the name suggests, this will be used
|
2001-12-27 22:37:34 +01:00
|
|
|
as a template for subsequently created databases; it should not be
|
2002-09-25 23:16:10 +02:00
|
|
|
used for actual work. (See <xref linkend="managing-databases"> for information
|
|
|
|
about creating databases.)
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<para>
|
|
|
|
In file system terms, a database cluster will be a single directory
|
2001-11-28 01:13:30 +01:00
|
|
|
under which all data will be stored. We call this the <firstterm>data
|
|
|
|
directory</firstterm> or <firstterm>data area</firstterm>. It is
|
2001-12-27 22:37:34 +01:00
|
|
|
completely up to you where you choose to store your data. There is no
|
2001-11-28 01:13:30 +01:00
|
|
|
default, although locations such as
|
2000-06-18 23:24:54 +02:00
|
|
|
<filename>/usr/local/pgsql/data</filename> or
|
2001-11-28 01:13:30 +01:00
|
|
|
<filename>/var/lib/pgsql/data</filename> are popular. To initialize a
|
|
|
|
database cluster, use the command <command>initdb</command>, which is
|
|
|
|
installed with <productname>PostgreSQL</productname>. The desired
|
|
|
|
file system location of your database system is indicated by the
|
|
|
|
<option>-D</option> option, for example
|
2000-06-18 23:24:54 +02:00
|
|
|
<screen>
|
2001-11-28 21:49:10 +01:00
|
|
|
<prompt>$</> <userinput>initdb -D /usr/local/pgsql/data</userinput>
|
2000-06-18 23:24:54 +02:00
|
|
|
</screen>
|
2002-03-09 06:11:38 +01:00
|
|
|
Note that you must execute this command while logged into the
|
|
|
|
<productname>PostgreSQL</productname> user account, which is
|
|
|
|
described in the previous section.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
1999-05-20 07:39:29 +02:00
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<tip>
|
1999-05-20 07:39:29 +02:00
|
|
|
<para>
|
2000-06-18 23:24:54 +02:00
|
|
|
As an alternative to the <option>-D</option> option, you can set
|
|
|
|
the environment variable <envar>PGDATA</envar>.
|
2003-03-24 15:32:51 +01:00
|
|
|
<indexterm><primary><envar>PGDATA</envar></primary></indexterm>
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
2000-06-18 23:24:54 +02:00
|
|
|
</tip>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
<command>initdb</command> will attempt to create the directory you
|
2002-03-09 06:11:38 +01:00
|
|
|
specify if it does not already exist. It is likely that it will not
|
|
|
|
have the permission to do so (if you followed our advice and created
|
|
|
|
an unprivileged account). In that case you should create the
|
|
|
|
directory yourself (as root) and change the owner to be the
|
|
|
|
<productname>PostgreSQL</productname> user. Here is how this might
|
|
|
|
be done:
|
2000-06-18 23:24:54 +02:00
|
|
|
<screen>
|
|
|
|
root# <userinput>mkdir /usr/local/pgsql/data</userinput>
|
|
|
|
root# <userinput>chown postgres /usr/local/pgsql/data</userinput>
|
|
|
|
root# <userinput>su postgres</userinput>
|
2001-11-28 21:49:10 +01:00
|
|
|
postgres$ <userinput>initdb -D /usr/local/pgsql/data</userinput>
|
2000-06-18 23:24:54 +02:00
|
|
|
</screen>
|
|
|
|
</para>
|
1999-05-20 07:39:29 +02:00
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<para>
|
|
|
|
<command>initdb</command> will refuse to run if the data directory
|
2002-03-09 06:11:38 +01:00
|
|
|
looks like it it has already been initialized.</para>
|
2000-06-18 23:24:54 +02:00
|
|
|
|
|
|
|
<para>
|
|
|
|
Because the data directory contains all the data stored in the
|
2002-03-09 06:11:38 +01:00
|
|
|
database, it is essential that it be secured from unauthorized
|
2000-06-18 23:24:54 +02:00
|
|
|
access. <command>initdb</command> therefore revokes access
|
2002-03-09 06:11:38 +01:00
|
|
|
permissions from everyone but the
|
|
|
|
<productname>PostgreSQL</productname> user.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
2000-11-25 21:33:54 +01:00
|
|
|
|
2001-11-28 01:13:30 +01:00
|
|
|
<para>
|
|
|
|
However, while the directory contents are secure, the default
|
2002-09-25 23:16:10 +02:00
|
|
|
client authentication setup allows any local user to connect to the
|
2003-02-19 05:06:28 +01:00
|
|
|
database and even become the database superuser. If you do not trust
|
2002-03-09 06:11:38 +01:00
|
|
|
other local users, we recommend you use <command>initdb</command>'s
|
|
|
|
<option>-W</option> or <option>--pwprompt</option> option to assign a
|
|
|
|
password to the database superuser. After <command>initdb</command>,
|
2002-09-25 23:16:10 +02:00
|
|
|
modify the <filename>pg_hba.conf</filename> file to use <literal>md5</> or
|
2002-03-09 06:11:38 +01:00
|
|
|
<literal>password</> instead of <literal>trust</> authentication
|
2003-03-24 15:32:51 +01:00
|
|
|
<emphasis>before</> you start the server for the first time. (Other
|
2002-03-09 06:11:38 +01:00
|
|
|
approaches include using <literal>ident</literal> authentication or
|
|
|
|
file system permissions to restrict connections. See <xref
|
2002-09-25 23:16:10 +02:00
|
|
|
linkend="client-authentication"> for more information.)
|
2001-11-28 01:13:30 +01:00
|
|
|
</para>
|
|
|
|
|
2000-11-25 21:33:54 +01:00
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
<command>initdb</command> also initializes the default locale<indexterm><primary>locale</></> for
|
2002-04-03 07:39:33 +02:00
|
|
|
the database cluster. Normally, it will just take the locale
|
|
|
|
settings in the environment and apply them to the initialized
|
|
|
|
database. It is possible to specify a different locale for the
|
|
|
|
database; more information about that can be found in <xref
|
|
|
|
linkend="locale">. One surprise you might encounter while running
|
2002-03-09 06:11:38 +01:00
|
|
|
<command>initdb</command> is a notice similar to this:
|
2000-11-25 21:33:54 +01:00
|
|
|
<screen>
|
2002-05-09 15:30:24 +02:00
|
|
|
The database cluster will be initialized with locale de_DE.
|
|
|
|
This locale setting will prevent the use of indexes for pattern matching
|
|
|
|
operations. If that is a concern, rerun initdb with the collation order
|
2003-03-25 17:15:44 +01:00
|
|
|
set to "C". For more information see the documentation.
|
2000-11-25 21:33:54 +01:00
|
|
|
</screen>
|
2002-04-03 07:39:33 +02:00
|
|
|
This is intended to warn you that the currently selected locale
|
|
|
|
will cause indexes to be sorted in an order that prevents them from
|
2002-11-11 21:14:04 +01:00
|
|
|
being used for <literal>LIKE</> and regular-expression searches. If you need
|
2002-04-03 07:39:33 +02:00
|
|
|
good performance in such searches, you should set your current
|
|
|
|
locale to <literal>C</> and re-run <command>initdb</command>, e.g.,
|
|
|
|
by running <literal>initdb --lc-collate=C</literal>. The sort
|
|
|
|
order used within a particular database cluster is set by
|
|
|
|
<command>initdb</command> and cannot be changed later, short of
|
|
|
|
dumping all data, rerunning <command>initdb</command>, and
|
|
|
|
reloading the data. So it's important to make this choice correctly
|
|
|
|
the first time.
|
2000-11-25 21:33:54 +01:00
|
|
|
</para>
|
2000-06-18 23:24:54 +02:00
|
|
|
</sect1>
|
|
|
|
|
|
|
|
<sect1 id="postmaster-start">
|
2002-11-11 21:14:04 +01:00
|
|
|
<title>Starting the Database Server</title>
|
2000-06-18 23:24:54 +02:00
|
|
|
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
Before anyone can access the database, you must start the database
|
2003-03-24 15:32:51 +01:00
|
|
|
server. The database server program is called
|
|
|
|
<command>postmaster</command>.<indexterm><primary>postmaster</></>
|
|
|
|
The <command>postmaster</command> must know where to
|
2002-03-09 06:11:38 +01:00
|
|
|
find the data it is supposed to use. This is done with the
|
|
|
|
<option>-D</option> option. Thus, the simplest way to start the
|
|
|
|
server is:
|
2000-06-18 23:24:54 +02:00
|
|
|
<screen>
|
2001-11-28 21:49:10 +01:00
|
|
|
$ <userinput>postmaster -D /usr/local/pgsql/data</userinput>
|
2000-06-18 23:24:54 +02:00
|
|
|
</screen>
|
2002-03-09 06:11:38 +01:00
|
|
|
which will leave the server running in the foreground. This must be
|
|
|
|
done while logged into the <productname>PostgreSQL</productname> user
|
|
|
|
account. Without <option>-D</option>, the server will try to use
|
|
|
|
the data directory in the environment variable <envar>PGDATA</envar>.
|
|
|
|
If neither of these succeed, it will fail.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
To start the <command>postmaster</command> in the
|
2000-06-18 23:24:54 +02:00
|
|
|
background, use the usual shell syntax:
|
|
|
|
<screen>
|
2001-11-28 21:49:10 +01:00
|
|
|
$ <userinput>postmaster -D /usr/local/pgsql/data > logfile 2>&1 &</userinput>
|
2000-06-18 23:24:54 +02:00
|
|
|
</screen>
|
2002-03-09 06:11:38 +01:00
|
|
|
It is an important to store the server's <systemitem>stdout</> and
|
|
|
|
<systemitem>stderr</> output somewhere, as shown above. It will help
|
|
|
|
for auditing purposes and to diagnose problems. (See <xref
|
|
|
|
linkend="logfile-maintenance"> for a more thorough discussion of log
|
|
|
|
file handling.)
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
The <command>postmaster</command> also takes a number of other
|
|
|
|
command line options. For more information, see the reference page
|
|
|
|
and <xref linkend="runtime-config"> below. In particular, in order
|
|
|
|
for the server to accept
|
|
|
|
TCP/IP<indexterm><primary>TCP/IP</primary></indexterm> connections
|
|
|
|
(rather than just Unix-domain socket ones), you must specify the
|
|
|
|
<option>-i</option> option.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
|
|
|
|
2001-02-10 01:50:18 +01:00
|
|
|
<para>
|
2001-03-24 01:24:26 +01:00
|
|
|
This shell syntax can get tedious quickly. Therefore the shell
|
2003-03-24 15:32:51 +01:00
|
|
|
script wrapper
|
|
|
|
<command>pg_ctl</command><indexterm><primary>pg_ctl</primary></indexterm>
|
|
|
|
is provided to simplify some tasks. For example:
|
2001-02-10 01:50:18 +01:00
|
|
|
<programlisting>
|
|
|
|
pg_ctl start -l logfile
|
|
|
|
</programlisting>
|
|
|
|
will start the server in the background and put the output into the
|
2002-03-09 06:11:38 +01:00
|
|
|
named log file. The <option>-D</option> option has the same meaning
|
2003-03-24 15:32:51 +01:00
|
|
|
here as in the <command>postmaster</command>. <command>pg_ctl</command> is also
|
2002-03-09 06:11:38 +01:00
|
|
|
capable of stopping the server.
|
2001-02-10 01:50:18 +01:00
|
|
|
</para>
|
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<para>
|
|
|
|
Normally, you will want to start the database server when the
|
2002-11-11 21:14:04 +01:00
|
|
|
computer boots. Autostart scripts are operating system-specific.
|
2002-03-09 06:11:38 +01:00
|
|
|
There are a few distributed with
|
|
|
|
<productname>PostgreSQL</productname> in the
|
2003-03-24 15:32:51 +01:00
|
|
|
<filename>contrib/start-scripts</> directory. This may require root
|
2002-03-09 06:11:38 +01:00
|
|
|
privileges.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
Different systems have different conventions for starting up daemons
|
|
|
|
at boot time. Many systems have a file
|
2000-06-18 23:24:54 +02:00
|
|
|
<filename>/etc/rc.local</filename> or
|
2002-03-09 06:11:38 +01:00
|
|
|
<filename>/etc/rc.d/rc.local</filename>. Others use
|
|
|
|
<filename>rc.d</> directories. Whatever you do, the server must be
|
|
|
|
run by the <productname>PostgreSQL</productname> user account
|
|
|
|
<emphasis>and not by root</emphasis> or any other user. Therefore you
|
|
|
|
probably should form your commands using <literal>su -c '...'
|
|
|
|
postgres</literal>. For example:
|
2000-06-18 23:24:54 +02:00
|
|
|
<programlisting>
|
2001-08-09 18:20:43 +02:00
|
|
|
su -c 'pg_ctl start -D /usr/local/pgsql/data -l serverlog' postgres
|
2000-06-18 23:24:54 +02:00
|
|
|
</programlisting>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
Here are a few more operating system specific suggestions. (Always
|
|
|
|
replace these with the proper installation directory and the user
|
|
|
|
name.)
|
2000-06-18 23:24:54 +02:00
|
|
|
|
|
|
|
<itemizedlist>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
For <productname>FreeBSD</productname>, look at the file
|
2001-02-10 01:50:18 +01:00
|
|
|
<filename>contrib/start-scripts/freebsd</filename> in the
|
|
|
|
<productname>PostgreSQL</productname> source distribution.
|
2001-11-12 20:19:39 +01:00
|
|
|
<indexterm><primary>FreeBSD</></>
|
2001-02-10 01:50:18 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
On <productname>OpenBSD</productname>, add the following lines
|
|
|
|
to the file <filename>/etc/rc.local</filename>:
|
2001-11-12 20:19:39 +01:00
|
|
|
<indexterm><primary>OpenBSD</></>
|
2000-06-18 23:24:54 +02:00
|
|
|
<programlisting>
|
2001-02-10 01:50:18 +01:00
|
|
|
if [ -x /usr/local/pgsql/bin/pg_ctl -a -x /usr/local/pgsql/bin/postmaster ]; then
|
|
|
|
su - -c '/usr/local/pgsql/bin/pg_ctl start -l /var/postgresql/log -s' postgres
|
|
|
|
echo -n ' postgresql'
|
|
|
|
fi
|
2000-06-18 23:24:54 +02:00
|
|
|
</programlisting>
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2001-02-10 01:50:18 +01:00
|
|
|
On <productname>Linux</productname> systems either add
|
2001-11-12 20:19:39 +01:00
|
|
|
<indexterm><primary>Linux</></>
|
2000-06-18 23:24:54 +02:00
|
|
|
<programlisting>
|
2001-02-10 01:50:18 +01:00
|
|
|
/usr/local/pgsql/bin/pg_ctl start -l logfile -D /usr/local/pgsql/data
|
2000-06-18 23:24:54 +02:00
|
|
|
</programlisting>
|
2002-03-09 06:11:38 +01:00
|
|
|
to <filename>/etc/rc.d/rc.local</filename> or look at the file
|
2001-02-10 01:50:18 +01:00
|
|
|
<filename>contrib/start-scripts/linux</filename> in the
|
2002-03-09 06:11:38 +01:00
|
|
|
<productname>PostgreSQL</productname> source distribution.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2001-02-10 01:50:18 +01:00
|
|
|
On <productname>NetBSD</productname>, either use the
|
|
|
|
<productname>FreeBSD</productname> or
|
|
|
|
<productname>Linux</productname> start scripts, depending on
|
2002-03-09 06:11:38 +01:00
|
|
|
preference. <indexterm><primary>NetBSD</></>
|
2001-02-10 01:50:18 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2001-05-07 17:55:27 +02:00
|
|
|
On <productname>Solaris</productname>, create a file called
|
2003-03-24 15:32:51 +01:00
|
|
|
<filename>/etc/init.d/postgresql</filename> that contains
|
2002-03-09 06:11:38 +01:00
|
|
|
the following line:
|
2001-11-12 20:19:39 +01:00
|
|
|
<indexterm><primary>Solaris</></>
|
2001-02-10 01:50:18 +01:00
|
|
|
<programlisting>
|
|
|
|
su - postgres -c "/usr/local/pgsql/bin/pg_ctl start -l logfile -D /usr/local/pgsql/data"
|
|
|
|
</programlisting>
|
2001-09-10 01:52:12 +02:00
|
|
|
Then, create a symbolic link to it in <filename>/etc/rc3.d</> as
|
2003-03-24 15:32:51 +01:00
|
|
|
<filename>S99postgresql</>.
|
2001-02-10 01:50:18 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</itemizedlist>
|
|
|
|
|
|
|
|
</para>
|
1999-05-20 07:39:29 +02:00
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
While the <command>postmaster</command> is running, its
|
|
|
|
<acronym>PID</acronym> is stored in the file
|
2002-03-09 06:11:38 +01:00
|
|
|
<filename>postmaster.pid</filename> in the data directory. This is
|
2003-03-24 15:32:51 +01:00
|
|
|
used to prevent multiple <command>postmaster</command> processes
|
|
|
|
running in the same data directory and can also be used for
|
|
|
|
shutting down the <command>postmaster</command> process.
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<sect2 id="postmaster-start-failures">
|
2000-08-29 22:02:09 +02:00
|
|
|
<title>Server Start-up Failures</title>
|
2000-06-18 23:24:54 +02:00
|
|
|
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
There are several common reasons the server might fail to
|
|
|
|
start. Check the server's log file, or start it by hand (without
|
|
|
|
redirecting standard output or standard error) and see what error
|
|
|
|
messages appear. Below we explain some of the most common error
|
|
|
|
messages in more detail.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
<screen>
|
|
|
|
FATAL: StreamServerPort: bind() failed: Address already in use
|
2003-03-24 15:32:51 +01:00
|
|
|
Is another postmaster already running on port 5432?
|
|
|
|
If not, wait a few seconds an retry.
|
2000-06-18 23:24:54 +02:00
|
|
|
</screen>
|
2002-03-09 06:11:38 +01:00
|
|
|
This usually means just what it suggests: you tried to start
|
2003-03-24 15:32:51 +01:00
|
|
|
another <command>postmaster</command> on the same port where one is already running.
|
2002-03-09 06:11:38 +01:00
|
|
|
However, if the kernel error message is not <computeroutput>Address
|
|
|
|
already in use</computeroutput> or some variant of that, there may
|
2003-03-24 15:32:51 +01:00
|
|
|
be a different problem. For example, trying to start a <command>postmaster</command>
|
2002-03-09 06:11:38 +01:00
|
|
|
on a reserved port number may draw something like:
|
2000-06-18 23:24:54 +02:00
|
|
|
<screen>
|
2001-11-28 21:49:10 +01:00
|
|
|
$ <userinput>postmaster -i -p 666</userinput>
|
2000-06-18 23:24:54 +02:00
|
|
|
FATAL: StreamServerPort: bind() failed: Permission denied
|
2003-03-24 15:32:51 +01:00
|
|
|
Is another postmaster already running on port 666?
|
|
|
|
If not, wait a few seconds an retry.
|
2000-06-18 23:24:54 +02:00
|
|
|
</screen>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
A message like
|
2000-06-18 23:24:54 +02:00
|
|
|
<screen>
|
2000-07-22 16:49:01 +02:00
|
|
|
IpcMemoryCreate: shmget(key=5440001, size=83918612, 01600) failed: Invalid argument
|
2000-06-18 23:24:54 +02:00
|
|
|
FATAL 1: ShmemCreate: cannot create region
|
|
|
|
</screen>
|
2002-03-09 06:11:38 +01:00
|
|
|
probably means your kernel's limit on the size of shared memory is
|
|
|
|
smaller than the buffer area <productname>PostgreSQL</productname>
|
|
|
|
is trying to create (83918612 bytes in this example). Or it could
|
2003-02-19 05:06:28 +01:00
|
|
|
mean that you do not have System-V-style shared memory support
|
2002-03-09 06:11:38 +01:00
|
|
|
configured into your kernel at all. As a temporary workaround, you
|
2003-03-24 15:32:51 +01:00
|
|
|
can try starting the server with a smaller-than-normal number
|
2002-03-09 06:11:38 +01:00
|
|
|
of buffers (<option>-B</option> switch). You will eventually want
|
|
|
|
to reconfigure your kernel to increase the allowed shared memory
|
2003-03-24 15:32:51 +01:00
|
|
|
size. You may also see this message when trying to start multiple
|
|
|
|
servers on the same machine if their total space requested
|
2002-03-09 06:11:38 +01:00
|
|
|
exceeds the kernel limit.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
An error like
|
2000-06-18 23:24:54 +02:00
|
|
|
<screen>
|
2000-07-22 16:49:01 +02:00
|
|
|
IpcSemaphoreCreate: semget(key=5440026, num=16, 01600) failed: No space left on device
|
2000-06-18 23:24:54 +02:00
|
|
|
</screen>
|
2003-01-11 06:04:14 +01:00
|
|
|
does <emphasis>not</emphasis> mean you've run out of disk
|
|
|
|
space. It means your kernel's limit on the number of <systemitem
|
|
|
|
class="osname">System V</> semaphores is smaller than the number
|
|
|
|
<productname>PostgreSQL</productname> wants to create. As above,
|
|
|
|
you may be able to work around the problem by starting the
|
2003-03-24 15:32:51 +01:00
|
|
|
server with a reduced number of allowed connections
|
2000-06-18 23:24:54 +02:00
|
|
|
(<option>-N</option> switch), but you'll eventually want to
|
|
|
|
increase the kernel limit.
|
|
|
|
</para>
|
2000-07-22 16:49:01 +02:00
|
|
|
|
2000-08-26 21:34:24 +02:00
|
|
|
<para>
|
2002-11-11 21:14:04 +01:00
|
|
|
If you get an <quote>illegal system call</> error, it is likely that
|
2002-03-09 06:11:38 +01:00
|
|
|
shared memory or semaphores are not supported in your kernel at
|
|
|
|
all. In that case your only option is to reconfigure the kernel to
|
|
|
|
enable these features.
|
2000-08-26 21:34:24 +02:00
|
|
|
</para>
|
|
|
|
|
2000-07-22 16:49:01 +02:00
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
Details about configuring <systemitem class="osname">System V</>
|
|
|
|
<acronym>IPC</> facilities are given in <xref linkend="sysvipc">.
|
2000-07-22 16:49:01 +02:00
|
|
|
</para>
|
2000-06-18 23:24:54 +02:00
|
|
|
</sect2>
|
|
|
|
|
|
|
|
<sect2 id="client-connection-problems">
|
|
|
|
<title>Client Connection Problems</title>
|
|
|
|
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
Although the error conditions possible on the client side are quite
|
|
|
|
varied and application-dependent, a few of them might be directly
|
|
|
|
related to how the server was started up. Conditions other than
|
|
|
|
those shown below should be documented with the respective client
|
|
|
|
application.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
<screen>
|
2001-07-15 15:45:04 +02:00
|
|
|
psql: could not connect to server: Connection refused
|
|
|
|
Is the server running on host server.joe.com and accepting
|
|
|
|
TCP/IP connections on port 5432?
|
2000-06-18 23:24:54 +02:00
|
|
|
</screen>
|
|
|
|
This is the generic <quote>I couldn't find a server to talk
|
|
|
|
to</quote> failure. It looks like the above when TCP/IP
|
2003-03-24 15:32:51 +01:00
|
|
|
communication is attempted. A common mistake is to forget to
|
|
|
|
configure the server to allow TCP/IP connections.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Alternatively, you'll get this when attempting Unix-domain socket
|
|
|
|
communication to a local server:
|
2000-06-18 23:24:54 +02:00
|
|
|
<screen>
|
2001-07-15 15:45:04 +02:00
|
|
|
psql: could not connect to server: Connection refused
|
|
|
|
Is the server running locally and accepting
|
|
|
|
connections on Unix domain socket "/tmp/.s.PGSQL.5432"?
|
2000-06-18 23:24:54 +02:00
|
|
|
</screen>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
The last line is useful in verifying that the client is trying to
|
2003-03-24 15:32:51 +01:00
|
|
|
connect to the right place. If there is in fact no server
|
2002-03-09 06:11:38 +01:00
|
|
|
running there, the kernel error message will typically be either
|
|
|
|
<computeroutput>Connection refused</computeroutput> or
|
2000-06-18 23:24:54 +02:00
|
|
|
<computeroutput>No such file or directory</computeroutput>, as
|
2002-03-09 06:11:38 +01:00
|
|
|
illustrated. (It is important to realize that
|
|
|
|
<computeroutput>Connection refused</computeroutput> in this context
|
2003-03-24 15:32:51 +01:00
|
|
|
does <emphasis>not</emphasis> mean that the server got your
|
|
|
|
connection request and rejected it. That case will produce a
|
2002-03-09 06:11:38 +01:00
|
|
|
different message, as shown in <xref
|
2000-06-18 23:24:54 +02:00
|
|
|
linkend="client-authentication-problems">.) Other error messages
|
|
|
|
such as <computeroutput>Connection timed out</computeroutput> may
|
|
|
|
indicate more fundamental problems, like lack of network
|
|
|
|
connectivity.
|
|
|
|
</para>
|
|
|
|
</sect2>
|
1999-05-20 07:39:29 +02:00
|
|
|
</sect1>
|
|
|
|
|
2000-09-29 22:21:34 +02:00
|
|
|
<sect1 id="runtime-config">
|
2002-11-11 21:14:04 +01:00
|
|
|
<Title>Run-time Configuration</Title>
|
1999-05-20 07:39:29 +02:00
|
|
|
|
2001-05-13 00:51:36 +02:00
|
|
|
<indexterm>
|
|
|
|
<primary>configuration</primary>
|
|
|
|
<secondary>server</secondary>
|
|
|
|
</indexterm>
|
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
There are a lot of configuration parameters that affect the behavior
|
|
|
|
of the database system. Here we describe how to set them and the
|
|
|
|
following subsections will discuss each in detail.
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2000-06-18 23:24:54 +02:00
|
|
|
All parameter names are case-insensitive. Every parameter takes a
|
2002-03-22 20:20:45 +01:00
|
|
|
value of one of the four types: Boolean, integer, floating point,
|
2002-03-09 06:11:38 +01:00
|
|
|
and string. Boolean values are <literal>ON</literal>,
|
|
|
|
<literal>OFF</literal>, <literal>TRUE</literal>,
|
|
|
|
<literal>FALSE</literal>, <literal>YES</literal>,
|
|
|
|
<literal>NO</literal>, <literal>1</literal>, <literal>0</literal>
|
|
|
|
(case-insensitive) or any non-ambiguous prefix of these.
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<para>
|
2001-10-09 20:46:00 +02:00
|
|
|
One way to set these options is to edit the file
|
2002-03-09 06:11:38 +01:00
|
|
|
<filename>postgresql.conf</filename> in the data directory. (A
|
|
|
|
default file is installed there.) An example of what this file might
|
|
|
|
look like is:
|
2000-06-18 23:24:54 +02:00
|
|
|
<programlisting>
|
|
|
|
# This is a comment
|
|
|
|
log_connections = yes
|
|
|
|
syslog = 2
|
2002-05-17 03:19:19 +02:00
|
|
|
search_path = '$user, public'
|
2000-06-18 23:24:54 +02:00
|
|
|
</programlisting>
|
|
|
|
As you see, options are one per line. The equal sign between name
|
2002-03-09 06:11:38 +01:00
|
|
|
and value is optional. Whitespace is insignificant and blank lines
|
2003-03-24 15:32:51 +01:00
|
|
|
are ignored. Hash marks (<literal>#</literal>) introduce comments
|
2002-05-17 03:19:19 +02:00
|
|
|
anywhere. Parameter values that are not simple identifiers or
|
|
|
|
numbers should be single-quoted.
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2001-05-13 00:51:36 +02:00
|
|
|
<indexterm>
|
|
|
|
<primary>SIGHUP</primary>
|
|
|
|
</indexterm>
|
2003-03-24 15:32:51 +01:00
|
|
|
The configuration file is reread whenever the <command>postmaster</command> process receives a
|
2002-03-09 06:11:38 +01:00
|
|
|
<systemitem>SIGHUP</> signal (which is most easily sent by means of
|
2003-03-24 15:32:51 +01:00
|
|
|
<literal>pg_ctl reload</>). The <command>postmaster</command> also propagates this
|
|
|
|
signal to all currently running server processes so that existing
|
2002-03-09 06:11:38 +01:00
|
|
|
sessions also get the new value. Alternatively, you can send the
|
2003-03-24 15:32:51 +01:00
|
|
|
signal to a single server process directly.
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2000-06-18 23:24:54 +02:00
|
|
|
A second way to set these configuration parameters is to give them
|
2003-03-24 15:32:51 +01:00
|
|
|
as a command line option to the <command>postmaster</command>, such as:
|
2000-06-18 23:24:54 +02:00
|
|
|
<programlisting>
|
2000-11-08 18:57:46 +01:00
|
|
|
postmaster -c log_connections=yes -c syslog=2
|
2000-06-18 23:24:54 +02:00
|
|
|
</programlisting>
|
2001-03-24 01:24:26 +01:00
|
|
|
Command-line options override any conflicting settings in
|
|
|
|
<filename>postgresql.conf</filename>.
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<para>
|
|
|
|
Occasionally it is also useful to give a command line option to
|
2003-03-24 15:32:51 +01:00
|
|
|
one particular session only. The environment variable
|
2000-06-18 23:24:54 +02:00
|
|
|
<envar>PGOPTIONS</envar> can be used for this purpose on the
|
|
|
|
client side:
|
|
|
|
<programlisting>
|
2000-11-08 18:57:46 +01:00
|
|
|
env PGOPTIONS='-c geqo=off' psql
|
2000-06-18 23:24:54 +02:00
|
|
|
</programlisting>
|
2002-09-21 20:32:54 +02:00
|
|
|
(This works for any <application>libpq</>-based client application, not just
|
2000-06-18 23:24:54 +02:00
|
|
|
<application>psql</application>.) Note that this won't work for
|
2002-03-09 06:11:38 +01:00
|
|
|
options that are fixed when the server is started, such as the port
|
|
|
|
number.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
1999-05-20 07:39:29 +02:00
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<para>
|
2002-03-01 23:45:19 +01:00
|
|
|
Some options can be changed in individual SQL sessions with the
|
2002-03-09 06:11:38 +01:00
|
|
|
<command>SET</command> command, for example:
|
2000-06-18 23:24:54 +02:00
|
|
|
<screen>
|
2003-03-24 15:32:51 +01:00
|
|
|
SET ENABLE_SEQSCAN TO OFF;
|
2000-06-18 23:24:54 +02:00
|
|
|
</screen>
|
|
|
|
See the SQL command language reference for details on the syntax.
|
2002-05-17 03:19:19 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2002-03-01 23:45:19 +01:00
|
|
|
Furthermore, it is possible to assign a set of option settings to
|
|
|
|
a user or a database. Whenever a session is started, the default
|
|
|
|
settings for the user and database involved are loaded. The
|
|
|
|
commands <literal>ALTER DATABASE</literal> and <literal>ALTER
|
2003-03-24 15:32:51 +01:00
|
|
|
USER</literal>, respectively, are used to configure these
|
|
|
|
settings. Such per-database settings override anything received
|
|
|
|
from the <command>postmaster</command> command-line or the
|
|
|
|
configuration file, and in turn are overridden by per-user
|
2002-05-17 03:19:19 +02:00
|
|
|
settings.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
1999-05-20 07:39:29 +02:00
|
|
|
|
2003-03-24 15:32:51 +01:00
|
|
|
<para>
|
|
|
|
The virtual table <structname>pg_settings</structname> allows
|
|
|
|
displaying and updating session run-time parameters. It contains one
|
|
|
|
row for each configuration parameter; the columns are shown in
|
|
|
|
<xref linkend="runtime-pgsettings-table">. This form allows the
|
|
|
|
configuration data to be joined with other tables and have a
|
|
|
|
selection criteria applied.
|
|
|
|
</para>
|
2002-09-02 07:52:34 +02:00
|
|
|
|
|
|
|
<para>
|
|
|
|
An <command>UPDATE</command> performed on <structname>pg_settings</structname>
|
|
|
|
is equivalent to executing the <command>SET</command> command on that named
|
|
|
|
parameter. The change only affects the value used by the current session. If
|
|
|
|
an <command>UPDATE</command> is issued within a transaction that is later
|
|
|
|
aborted, the effects of the <command>UPDATE</command> command disappear when
|
|
|
|
the transaction is rolled back. Once the surrounding transaction is
|
|
|
|
committed, the effects will persist until the end of the session, unless
|
|
|
|
overridden by another <command>UPDATE</command> or <command>SET</command>.
|
|
|
|
</para>
|
|
|
|
|
2003-03-24 15:32:51 +01:00
|
|
|
<table id="runtime-pgsettings-table">
|
|
|
|
<title><literal>pg_settings</> Columns</title>
|
2002-09-02 07:52:34 +02:00
|
|
|
|
2002-11-11 21:14:04 +01:00
|
|
|
<tgroup cols=3>
|
2002-09-02 07:52:34 +02:00
|
|
|
<thead>
|
|
|
|
<row>
|
|
|
|
<entry>Name</entry>
|
2003-03-24 15:32:51 +01:00
|
|
|
<entry>Data Type</entry>
|
2002-09-02 07:52:34 +02:00
|
|
|
<entry>Description</entry>
|
|
|
|
</row>
|
|
|
|
</thead>
|
|
|
|
|
|
|
|
<tbody>
|
|
|
|
<row>
|
2002-11-11 21:14:04 +01:00
|
|
|
<entry><literal>name</literal></entry>
|
2002-09-02 07:52:34 +02:00
|
|
|
<entry><type>text</type></entry>
|
2003-03-24 15:32:51 +01:00
|
|
|
<entry>The name of the run-time configuration parameter</entry>
|
2002-09-02 07:52:34 +02:00
|
|
|
</row>
|
|
|
|
|
|
|
|
<row>
|
2002-11-11 21:14:04 +01:00
|
|
|
<entry><literal>setting</literal></entry>
|
2002-09-02 07:52:34 +02:00
|
|
|
<entry><type>text</type></entry>
|
2003-03-24 15:32:51 +01:00
|
|
|
<entry>The current value of the run-time configuration parameter</entry>
|
2002-09-02 07:52:34 +02:00
|
|
|
</row>
|
|
|
|
</tbody>
|
|
|
|
</tgroup>
|
2002-09-02 15:45:30 +02:00
|
|
|
</table>
|
2002-09-02 07:52:34 +02:00
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<sect2 id="runtime-config-optimizer">
|
|
|
|
<title>Planner and Optimizer Tuning</title>
|
1999-05-20 07:39:29 +02:00
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>CPU_INDEX_TUPLE_COST</varname> (<type>floating point</type>)</term>
|
2000-06-18 23:24:54 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Sets the query planner's estimate of the cost of processing
|
2000-06-18 23:24:54 +02:00
|
|
|
each index tuple during an index scan. This is measured as a
|
|
|
|
fraction of the cost of a sequential page fetch.
|
|
|
|
</para>
|
1999-05-20 07:39:29 +02:00
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2000-06-18 23:24:54 +02:00
|
|
|
|
1999-05-20 07:39:29 +02:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>CPU_OPERATOR_COST</varname> (<type>floating point</type>)</term>
|
1999-05-20 07:39:29 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Sets the planner's estimate of the cost of processing each
|
2002-11-11 21:14:04 +01:00
|
|
|
operator in a <literal>WHERE</> clause. This is measured as a fraction of
|
2000-06-18 23:24:54 +02:00
|
|
|
the cost of a sequential page fetch.
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
2000-06-18 23:24:54 +02:00
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>CPU_TUPLE_COST</varname> (<type>floating point</type>)</term>
|
2000-06-18 23:24:54 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Sets the query planner's estimate of the cost of processing
|
2000-06-18 23:24:54 +02:00
|
|
|
each tuple during a query. This is measured as a fraction of
|
|
|
|
the cost of a sequential page fetch.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2002-07-31 19:19:54 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><varname>DEFAULT_STATISTICS_TARGET</varname> (<type>integer</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Sets the default statistics target for table columns that have not
|
|
|
|
had a column-specific target set via <command>ALTER TABLE SET
|
|
|
|
STATISTICS</>. Larger values increase the time needed to do
|
|
|
|
<command>ANALYZE</>, but may improve the quality of the planner's
|
2002-12-06 06:18:57 +01:00
|
|
|
estimates. The default value is 10.
|
2002-07-31 19:19:54 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>EFFECTIVE_CACHE_SIZE</varname> (<type>floating point</type>)</term>
|
2000-06-18 23:24:54 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Sets the planner's assumption about the effective size of the
|
2002-03-09 06:11:38 +01:00
|
|
|
disk cache (that is, the portion of the kernel's disk cache that
|
|
|
|
will be used for <productname>PostgreSQL</productname> data
|
|
|
|
files). This is measured in disk pages, which are normally 8 kB
|
|
|
|
each.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
1999-05-20 07:39:29 +02:00
|
|
|
|
2002-11-21 01:42:20 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><varname>ENABLE_HASHAGG</varname> (<type>boolean</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Enables or disables the query planner's use of hashed aggregation
|
|
|
|
plan types. The default is on. This is used for debugging the query
|
|
|
|
planner.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>ENABLE_HASHJOIN</varname> (<type>boolean</type>)</term>
|
2000-06-18 23:24:54 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Enables or disables the query planner's use of hash-join plan
|
2002-03-09 06:11:38 +01:00
|
|
|
types. The default is on. This is used for debugging the
|
2000-06-18 23:24:54 +02:00
|
|
|
query planner.
|
|
|
|
</para>
|
1999-05-20 07:39:29 +02:00
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2001-05-13 00:51:36 +02:00
|
|
|
<indexterm>
|
|
|
|
<primary>index scan</primary>
|
|
|
|
</indexterm>
|
|
|
|
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>ENABLE_INDEXSCAN</varname> (<type>boolean</type>)</term>
|
1999-05-20 07:39:29 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2001-11-28 21:49:10 +01:00
|
|
|
Enables or disables the query planner's use of index-scan plan
|
2002-03-09 06:11:38 +01:00
|
|
|
types. The default is on. This is used to debugging the
|
2000-06-18 23:24:54 +02:00
|
|
|
query planner.
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>ENABLE_MERGEJOIN</varname> (<type>boolean</type>)</term>
|
1999-05-20 07:39:29 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2000-06-18 23:24:54 +02:00
|
|
|
Enables or disables the query planner's use of merge-join plan
|
2002-03-09 06:11:38 +01:00
|
|
|
types. The default is on. This is used for debugging the
|
2000-06-18 23:24:54 +02:00
|
|
|
query planner.
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>ENABLE_NESTLOOP</varname> (<type>boolean</type>)</term>
|
1999-05-20 07:39:29 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
Enables or disables the query planner's use of nested-loop join
|
|
|
|
plans. It's not possible to suppress nested-loop joins entirely,
|
|
|
|
but turning this variable off discourages the planner from using
|
|
|
|
one if there are other methods available. The default is
|
|
|
|
on. This is used for debugging the query planner.
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2000-04-23 02:25:06 +02:00
|
|
|
<varlistentry>
|
2001-05-13 00:51:36 +02:00
|
|
|
<indexterm>
|
|
|
|
<primary>sequential scan</primary>
|
|
|
|
</indexterm>
|
|
|
|
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>ENABLE_SEQSCAN</varname> (<type>boolean</type>)</term>
|
2000-04-23 02:25:06 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2000-06-18 23:24:54 +02:00
|
|
|
Enables or disables the query planner's use of sequential scan
|
2002-03-09 06:11:38 +01:00
|
|
|
plan types. It's not possible to suppress sequential scans
|
|
|
|
entirely, but turning this variable off discourages the planner
|
|
|
|
from using one if there are other methods available. The
|
|
|
|
default is on. This is used for debugging the query planner.
|
2000-04-23 02:25:06 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>ENABLE_SORT</varname> (<type>boolean</type>)</term>
|
2000-04-23 02:25:06 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2000-06-18 23:24:54 +02:00
|
|
|
Enables or disables the query planner's use of explicit sort
|
|
|
|
steps. It's not possible to suppress explicit sorts entirely,
|
|
|
|
but turning this variable off discourages the planner from
|
2002-03-09 06:11:38 +01:00
|
|
|
using one if there are other methods available. The default
|
|
|
|
is on. This is used for debugging the query planner.
|
2000-04-23 02:25:06 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>ENABLE_TIDSCAN</varname> (<type>boolean</type>)</term>
|
2000-04-23 02:25:06 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2001-09-10 01:52:12 +02:00
|
|
|
Enables or disables the query planner's use of <acronym>TID</> scan plan
|
2002-03-09 06:11:38 +01:00
|
|
|
types. The default is on. This is used for debugging the
|
2000-06-18 23:24:54 +02:00
|
|
|
query planner.
|
2000-04-23 02:25:06 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2003-01-26 00:10:30 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><varname>FROM_COLLAPSE_LIMIT</varname> (<type>integer</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The planner will merge sub-queries into upper queries if the resulting
|
|
|
|
FROM list would have no more than this many items. Smaller values
|
|
|
|
reduce planning time but may yield inferior query plans.
|
|
|
|
The default is 8. It is usually wise to keep this less than
|
|
|
|
<literal>GEQO_THRESHOLD</>.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
1999-05-20 07:39:29 +02:00
|
|
|
<varlistentry>
|
2001-05-13 00:51:36 +02:00
|
|
|
<indexterm>
|
|
|
|
<primary>genetic query optimization</primary>
|
|
|
|
</indexterm>
|
|
|
|
<indexterm>
|
|
|
|
<primary>GEQO</primary>
|
|
|
|
<see>genetic query optimization</see>
|
|
|
|
</indexterm>
|
|
|
|
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>GEQO</varname> (<type>boolean</type>)</term>
|
1999-05-20 07:39:29 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2000-06-18 23:24:54 +02:00
|
|
|
Enables or disables genetic query optimization, which is an
|
2002-03-09 06:11:38 +01:00
|
|
|
algorithm that attempts to do query planning without exhaustive
|
|
|
|
searching. This is on by default. See also the various other
|
|
|
|
<varname>GEQO_</varname> settings.
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>GEQO_EFFORT</varname> (<type>integer</type>)</term>
|
|
|
|
<term><varname>GEQO_GENERATIONS</varname> (<type>integer</type>)</term>
|
|
|
|
<term><varname>GEQO_POOL_SIZE</varname> (<type>integer</type>)</term>
|
|
|
|
<term><varname>GEQO_RANDOM_SEED</varname> (<type>integer</type>)</term>
|
|
|
|
<term><varname>GEQO_SELECTION_BIAS</varname> (<type>floating point</type>)</term>
|
1999-05-20 07:39:29 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2000-06-18 23:24:54 +02:00
|
|
|
Various tuning parameters for the genetic query optimization
|
|
|
|
algorithm: The pool size is the number of individuals in one
|
2002-03-09 06:11:38 +01:00
|
|
|
population. Valid values are between 128 and 1024. If it is set
|
|
|
|
to 0 (the default) a pool size of 2^(QS+1), where QS is the
|
2003-03-24 15:32:51 +01:00
|
|
|
number of <literal>FROM</> items in the query, is taken. The effort is used
|
2002-03-09 06:11:38 +01:00
|
|
|
to calculate a default for generations. Valid values are between
|
|
|
|
1 and 80, 40 being the default. Generations specifies the number
|
|
|
|
of iterations in the algorithm. The number must be a positive
|
|
|
|
integer. If 0 is specified then <literal>Effort *
|
|
|
|
Log2(PoolSize)</literal> is used. The run time of the algorithm
|
|
|
|
is roughly proportional to the sum of pool size and generations.
|
|
|
|
The selection bias is the selective pressure within the
|
|
|
|
population. Values can be from 1.50 to 2.00; the latter is the
|
|
|
|
default. The random seed can be set to get reproducible results
|
|
|
|
from the algorithm. If it is set to -1 then the algorithm
|
|
|
|
behaves non-deterministically.
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>GEQO_THRESHOLD</varname> (<type>integer</type>)</term>
|
1999-05-20 07:39:29 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2001-02-15 05:28:50 +01:00
|
|
|
Use genetic query optimization to plan queries with at least
|
2003-01-26 00:10:30 +01:00
|
|
|
this many <literal>FROM</> items involved. (Note that an outer
|
2002-03-09 06:11:38 +01:00
|
|
|
<literal>JOIN</> construct counts as only one <literal>FROM</>
|
|
|
|
item.) The default is 11. For simpler queries it is usually best
|
2003-01-26 00:10:30 +01:00
|
|
|
to use the deterministic, exhaustive planner, but for queries with
|
|
|
|
many tables the deterministic planner takes too long.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><varname>JOIN_COLLAPSE_LIMIT</varname> (<type>integer</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The planner will flatten explicit inner <literal>JOIN</> constructs
|
|
|
|
into lists of <literal>FROM</> items whenever a list of no more than
|
|
|
|
this many items would result. Usually this is set the same as
|
|
|
|
<literal>FROM_COLLAPSE_LIMIT</>. Setting it to 1 prevents any
|
|
|
|
flattening of inner <literal>JOIN</>s, allowing explicit
|
|
|
|
<literal>JOIN</> syntax to be used to control the join order.
|
|
|
|
Intermediate values might be useful to trade off planning time
|
|
|
|
against quality of plan.
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>RANDOM_PAGE_COST</varname> (<type>floating point</type>)</term>
|
1999-05-20 07:39:29 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Sets the query planner's estimate of the cost of a
|
2002-03-09 06:11:38 +01:00
|
|
|
nonsequentially fetched disk page. This is measured as a
|
2002-12-06 06:17:03 +01:00
|
|
|
multiple of the cost of a sequential page fetch. A higher
|
|
|
|
value makes it more likely a sequential scan will be used,
|
|
|
|
a lower value makes it more likely an index scan will be used.
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2000-06-18 23:24:54 +02:00
|
|
|
</variablelist>
|
|
|
|
|
|
|
|
<note>
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
Unfortunately, there is no well-defined method for determining
|
2003-03-24 15:32:51 +01:00
|
|
|
ideal values for the family of <quote>cost</quote> variables that
|
2000-06-18 23:24:54 +02:00
|
|
|
were just described. You are encouraged to experiment and share
|
|
|
|
your findings.
|
|
|
|
</para>
|
|
|
|
</note>
|
|
|
|
|
|
|
|
</sect2>
|
1999-05-20 07:39:29 +02:00
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<sect2 id="logging">
|
|
|
|
<title>Logging and Debugging</title>
|
|
|
|
|
|
|
|
<variablelist>
|
Commit to match discussed elog() changes. Only update is that LOG is
now just below FATAL in server_min_messages. Added more text to
highlight ordering difference between it and client_min_messages.
---------------------------------------------------------------------------
REALLYFATAL => PANIC
STOP => PANIC
New INFO level the prints to client by default
New LOG level the prints to server log by default
Cause VACUUM information to print only to the client
NOTICE => INFO where purely information messages are sent
DEBUG => LOG for purely server status messages
DEBUG removed, kept as backward compatible
DEBUG5, DEBUG4, DEBUG3, DEBUG2, DEBUG1 added
DebugLvl removed in favor of new DEBUG[1-5] symbols
New server_min_messages GUC parameter with values:
DEBUG[5-1], INFO, NOTICE, ERROR, LOG, FATAL, PANIC
New client_min_messages GUC parameter with values:
DEBUG[5-1], LOG, INFO, NOTICE, ERROR, FATAL, PANIC
Server startup now logged with LOG instead of DEBUG
Remove debug_level GUC parameter
elog() numbers now start at 10
Add test to print error message if older elog() values are passed to elog()
Bootstrap mode now has a -d that requires an argument, like postmaster
2002-03-02 22:39:36 +01:00
|
|
|
<varlistentry>
|
2002-11-15 00:53:27 +01:00
|
|
|
<term><varname>CLIENT_MIN_MESSAGES</varname> (<type>string</type>)</term>
|
Commit to match discussed elog() changes. Only update is that LOG is
now just below FATAL in server_min_messages. Added more text to
highlight ordering difference between it and client_min_messages.
---------------------------------------------------------------------------
REALLYFATAL => PANIC
STOP => PANIC
New INFO level the prints to client by default
New LOG level the prints to server log by default
Cause VACUUM information to print only to the client
NOTICE => INFO where purely information messages are sent
DEBUG => LOG for purely server status messages
DEBUG removed, kept as backward compatible
DEBUG5, DEBUG4, DEBUG3, DEBUG2, DEBUG1 added
DebugLvl removed in favor of new DEBUG[1-5] symbols
New server_min_messages GUC parameter with values:
DEBUG[5-1], INFO, NOTICE, ERROR, LOG, FATAL, PANIC
New client_min_messages GUC parameter with values:
DEBUG[5-1], LOG, INFO, NOTICE, ERROR, FATAL, PANIC
Server startup now logged with LOG instead of DEBUG
Remove debug_level GUC parameter
elog() numbers now start at 10
Add test to print error message if older elog() values are passed to elog()
Bootstrap mode now has a -d that requires an argument, like postmaster
2002-03-02 22:39:36 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
This controls which message levels are send to the client.
|
2002-11-15 00:53:27 +01:00
|
|
|
client. Valid values are <literal>DEBUG5</>,
|
Commit to match discussed elog() changes. Only update is that LOG is
now just below FATAL in server_min_messages. Added more text to
highlight ordering difference between it and client_min_messages.
---------------------------------------------------------------------------
REALLYFATAL => PANIC
STOP => PANIC
New INFO level the prints to client by default
New LOG level the prints to server log by default
Cause VACUUM information to print only to the client
NOTICE => INFO where purely information messages are sent
DEBUG => LOG for purely server status messages
DEBUG removed, kept as backward compatible
DEBUG5, DEBUG4, DEBUG3, DEBUG2, DEBUG1 added
DebugLvl removed in favor of new DEBUG[1-5] symbols
New server_min_messages GUC parameter with values:
DEBUG[5-1], INFO, NOTICE, ERROR, LOG, FATAL, PANIC
New client_min_messages GUC parameter with values:
DEBUG[5-1], LOG, INFO, NOTICE, ERROR, FATAL, PANIC
Server startup now logged with LOG instead of DEBUG
Remove debug_level GUC parameter
elog() numbers now start at 10
Add test to print error message if older elog() values are passed to elog()
Bootstrap mode now has a -d that requires an argument, like postmaster
2002-03-02 22:39:36 +01:00
|
|
|
<literal>DEBUG4</>, <literal>DEBUG3</>, <literal>DEBUG2</>,
|
2002-11-15 00:53:27 +01:00
|
|
|
<literal>DEBUG1</>, <literal>LOG</>, <literal>NOTICE</>,
|
2003-03-24 15:32:51 +01:00
|
|
|
<literal>WARNING</>, and <literal>ERROR</>. Each level
|
|
|
|
includes all the levels that follow it. The later the level,
|
|
|
|
the fewer messages are sent. The default is
|
2002-11-15 00:53:27 +01:00
|
|
|
<literal>NOTICE</>. Note that <literal>LOG</> has a different
|
2003-03-24 15:32:51 +01:00
|
|
|
rank here than in <literal>LOG_MIN_MESSAGES</>.
|
Commit to match discussed elog() changes. Only update is that LOG is
now just below FATAL in server_min_messages. Added more text to
highlight ordering difference between it and client_min_messages.
---------------------------------------------------------------------------
REALLYFATAL => PANIC
STOP => PANIC
New INFO level the prints to client by default
New LOG level the prints to server log by default
Cause VACUUM information to print only to the client
NOTICE => INFO where purely information messages are sent
DEBUG => LOG for purely server status messages
DEBUG removed, kept as backward compatible
DEBUG5, DEBUG4, DEBUG3, DEBUG2, DEBUG1 added
DebugLvl removed in favor of new DEBUG[1-5] symbols
New server_min_messages GUC parameter with values:
DEBUG[5-1], INFO, NOTICE, ERROR, LOG, FATAL, PANIC
New client_min_messages GUC parameter with values:
DEBUG[5-1], LOG, INFO, NOTICE, ERROR, FATAL, PANIC
Server startup now logged with LOG instead of DEBUG
Remove debug_level GUC parameter
elog() numbers now start at 10
Add test to print error message if older elog() values are passed to elog()
Bootstrap mode now has a -d that requires an argument, like postmaster
2002-03-02 22:39:36 +01:00
|
|
|
</para>
|
2002-11-11 21:14:04 +01:00
|
|
|
|
2002-07-05 03:17:20 +02:00
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Here is a list of the various message types:
|
2002-07-05 03:17:20 +02:00
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
2002-11-11 21:14:04 +01:00
|
|
|
<term><literal>DEBUG[1-5]</literal></term>
|
2002-07-05 03:17:20 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-11-11 21:14:04 +01:00
|
|
|
Provides information for use by developers.
|
2002-07-05 03:17:20 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2002-11-11 21:14:04 +01:00
|
|
|
|
2002-07-05 03:17:20 +02:00
|
|
|
<varlistentry>
|
2002-11-11 21:14:04 +01:00
|
|
|
<term><literal>INFO</literal></term>
|
2002-07-05 03:17:20 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-11-11 21:14:04 +01:00
|
|
|
Provides information implicitly requested by the user,
|
|
|
|
e.g., during <command>VACUUM VERBOSE</>.
|
2002-07-05 03:17:20 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2002-11-11 21:14:04 +01:00
|
|
|
|
2002-07-05 03:17:20 +02:00
|
|
|
<varlistentry>
|
2002-11-11 21:14:04 +01:00
|
|
|
<term><literal>NOTICE</literal></term>
|
2002-07-05 03:17:20 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-11-11 21:14:04 +01:00
|
|
|
Provides information that may be helpful to users, e.g.,
|
2003-03-24 15:32:51 +01:00
|
|
|
truncation of long identifiers and the creation of indexes as part
|
2002-11-11 21:14:04 +01:00
|
|
|
of primary keys.
|
2002-07-05 03:17:20 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2002-11-11 21:14:04 +01:00
|
|
|
|
2002-07-05 03:17:20 +02:00
|
|
|
<varlistentry>
|
2002-11-11 21:14:04 +01:00
|
|
|
<term><literal>WARNING</literal></term>
|
2002-07-05 03:17:20 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-11-11 21:14:04 +01:00
|
|
|
Provides warnings to the user, e.g., <command>COMMIT</>
|
2003-03-24 15:32:51 +01:00
|
|
|
outside a transaction block.
|
2002-07-05 03:17:20 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2002-11-11 21:14:04 +01:00
|
|
|
|
2002-07-05 03:17:20 +02:00
|
|
|
<varlistentry>
|
2002-11-11 21:14:04 +01:00
|
|
|
<term><literal>ERROR</literal></term>
|
2002-07-05 03:17:20 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Reports an error that caused the current transaction to abort.
|
2002-07-05 03:17:20 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-11-11 21:14:04 +01:00
|
|
|
<term><literal>LOG</literal></term>
|
2002-07-05 03:17:20 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-11-11 21:14:04 +01:00
|
|
|
Reports information of interest to administrators, e.g.,
|
2002-07-05 03:17:20 +02:00
|
|
|
checkpoint activity.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2002-11-11 21:14:04 +01:00
|
|
|
|
2002-07-05 03:17:20 +02:00
|
|
|
<varlistentry>
|
2002-11-11 21:14:04 +01:00
|
|
|
<term><literal>FATAL</literal></term>
|
2002-07-05 03:17:20 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Reports an error that caused the current session to abort.
|
2002-07-05 03:17:20 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2002-11-11 21:14:04 +01:00
|
|
|
|
2002-07-05 03:17:20 +02:00
|
|
|
<varlistentry>
|
2002-11-11 21:14:04 +01:00
|
|
|
<term><literal>PANIC</literal></term>
|
2002-07-05 03:17:20 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Reports an error that caused all sessions to abort.
|
2002-07-05 03:17:20 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</para>
|
Commit to match discussed elog() changes. Only update is that LOG is
now just below FATAL in server_min_messages. Added more text to
highlight ordering difference between it and client_min_messages.
---------------------------------------------------------------------------
REALLYFATAL => PANIC
STOP => PANIC
New INFO level the prints to client by default
New LOG level the prints to server log by default
Cause VACUUM information to print only to the client
NOTICE => INFO where purely information messages are sent
DEBUG => LOG for purely server status messages
DEBUG removed, kept as backward compatible
DEBUG5, DEBUG4, DEBUG3, DEBUG2, DEBUG1 added
DebugLvl removed in favor of new DEBUG[1-5] symbols
New server_min_messages GUC parameter with values:
DEBUG[5-1], INFO, NOTICE, ERROR, LOG, FATAL, PANIC
New client_min_messages GUC parameter with values:
DEBUG[5-1], LOG, INFO, NOTICE, ERROR, FATAL, PANIC
Server startup now logged with LOG instead of DEBUG
Remove debug_level GUC parameter
elog() numbers now start at 10
Add test to print error message if older elog() values are passed to elog()
Bootstrap mode now has a -d that requires an argument, like postmaster
2002-03-02 22:39:36 +01:00
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2000-07-12 19:38:53 +02:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>DEBUG_ASSERTIONS</varname> (<type>boolean</type>)</term>
|
2000-07-12 19:38:53 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Turns on various assertion checks. This is a debugging aid. If
|
2002-03-09 06:11:38 +01:00
|
|
|
you are experiencing strange problems or crashes you might want
|
|
|
|
to turn this on, as it might expose programming mistakes. To use
|
|
|
|
this option, the macro <literal>USE_ASSERT_CHECKING</literal>
|
|
|
|
must be defined when <productname>PostgreSQL</productname> is
|
2002-11-11 21:14:04 +01:00
|
|
|
built (accomplished by the <command>configure</command> option
|
2002-09-18 22:09:32 +02:00
|
|
|
<option>--enable-cassert</option>). Note that
|
2002-03-09 06:11:38 +01:00
|
|
|
<literal>DEBUG_ASSERTIONS</literal> defaults to on if
|
2002-08-30 02:28:41 +02:00
|
|
|
<productname>PostgreSQL</productname> has been built with
|
|
|
|
assertions enabled.
|
2000-07-12 19:38:53 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2000-06-18 23:24:54 +02:00
|
|
|
|
1999-05-20 07:39:29 +02:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>DEBUG_PRINT_PARSE</varname> (<type>boolean</type>)</term>
|
|
|
|
<term><varname>DEBUG_PRINT_REWRITTEN</varname> (<type>boolean</type>)</term>
|
|
|
|
<term><varname>DEBUG_PRINT_PLAN</varname> (<type>boolean</type>)</term>
|
|
|
|
<term><varname>DEBUG_PRETTY_PRINT</varname> (<type>boolean</type>)</term>
|
1999-05-20 07:39:29 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
These options enable various debugging output to be sent to the
|
|
|
|
server log. For each executed query, they print the resulting parse
|
2002-12-04 22:43:07 +01:00
|
|
|
tree, the query rewriter output, or the execution plan.
|
|
|
|
<option>DEBUG_PRETTY_PRINT</option> indents these displays to
|
|
|
|
produce a more readable but much longer output format.
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2003-03-24 15:32:51 +01:00
|
|
|
|
2002-03-24 05:31:09 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><varname>EXPLAIN_PRETTY_PRINT</varname> (<type>boolean</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Determines whether <command>EXPLAIN VERBOSE</> uses the indented
|
2002-09-21 20:32:54 +02:00
|
|
|
or non-indented format for displaying detailed query-tree dumps.
|
2002-03-24 05:31:09 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
1999-05-20 07:39:29 +02:00
|
|
|
<varlistentry>
|
2002-11-15 02:57:28 +01:00
|
|
|
<term><varname>LOG_HOSTNAME</varname> (<type>boolean</type>)</term>
|
1999-05-20 07:39:29 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2000-06-18 23:24:54 +02:00
|
|
|
By default, connection logs only show the IP address of the
|
|
|
|
connecting host. If you want it to show the host name you can
|
|
|
|
turn this on, but depending on your host name resolution setup
|
|
|
|
it might impose a non-negligible performance penalty. This
|
|
|
|
option can only be set at server start.
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>LOG_CONNECTIONS</varname> (<type>boolean</type>)</term>
|
1999-05-20 07:39:29 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
This outputs a line to the server logs detailing each successful
|
|
|
|
connection. This is off by default, although it is probably very
|
|
|
|
useful. This option can only be set at server start or in the
|
|
|
|
<filename>postgresql.conf</filename> configuration file.
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2002-11-11 21:14:04 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><varname>LOG_DURATION</varname> (<type>boolean</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Causes the duration of every completed statement to be logged.
|
|
|
|
To use this option, enable <varname>LOG_STATEMENT</> and
|
|
|
|
<varname>LOG_PID</> so you can link the statement to the
|
|
|
|
duration using the process ID.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2002-09-02 07:42:54 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><varname>LOG_MIN_ERROR_STATEMENT</varname> (<type>string</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-12-10 02:57:46 +01:00
|
|
|
Controls whether or not the SQL statement that causes an error
|
|
|
|
condition will also be recorded in the server log. All SQL
|
|
|
|
statements that cause an error of the specified level, or a
|
|
|
|
higher level, are logged. The default is
|
|
|
|
<literal>PANIC</literal> (effectively turning this feature
|
|
|
|
off). Valid values are <literal>DEBUG5</literal>,
|
|
|
|
<literal>DEBUG4</literal>, <literal>DEBUG3</literal>,
|
|
|
|
<literal>DEBUG2</literal>, <literal>DEBUG1</literal>,
|
|
|
|
<literal>INFO</literal>, <literal>NOTICE</literal>,
|
|
|
|
<literal>WARNING</literal>, <literal>ERROR</literal>,
|
|
|
|
<literal>FATAL</literal>, and <literal>PANIC</literal>. For
|
|
|
|
example, if you set this to <literal>ERROR</literal> then all
|
|
|
|
SQL statements causing errors, fatal errors, or panics will be
|
|
|
|
logged. Enabling this option can be helpful in tracking down
|
|
|
|
the source of any errors that appear in the server log.
|
2002-09-02 07:42:54 +02:00
|
|
|
</para>
|
2002-11-11 21:14:04 +01:00
|
|
|
|
2002-09-02 07:42:54 +02:00
|
|
|
<para>
|
2002-11-11 21:14:04 +01:00
|
|
|
It is recommended you enable <varname>LOG_PID</varname> as well
|
2002-09-02 07:42:54 +02:00
|
|
|
so you can more easily match the error statement with the error
|
|
|
|
message.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2002-11-15 00:53:27 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><varname>LOG_MIN_MESSAGES</varname> (<type>string</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
This controls which message levels are written to the server
|
|
|
|
log. Valid values are <literal>DEBUG5</>, <literal>DEBUG4</>,
|
|
|
|
<literal>DEBUG3</>, <literal>DEBUG2</>, <literal>DEBUG1</>,
|
|
|
|
<literal>INFO</>, <literal>NOTICE</>, <literal>WARNING</>,
|
|
|
|
<literal>ERROR</>, <literal>LOG</>, <literal>FATAL</>, and
|
|
|
|
<literal>PANIC</>. Each level includes all the levels that
|
|
|
|
follow it. The later the level, the fewer messages are sent
|
|
|
|
to the log. The default is <literal>NOTICE</>. Note that
|
|
|
|
<literal>LOG</> has a different rank here than in
|
|
|
|
<literal>CLIENT_MIN_MESSAGES</>. Also see that section for an
|
|
|
|
explanation of the various values.
|
2002-11-15 00:53:27 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
1999-05-20 07:39:29 +02:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>LOG_PID</varname> (<type>boolean</type>)</term>
|
1999-05-20 07:39:29 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Prefixes each message in the server log file with the process ID of
|
|
|
|
the server process. This is useful to sort out which messages
|
2002-06-15 21:58:53 +02:00
|
|
|
pertain to which connection. The default is off. This parameter
|
2002-09-21 20:32:54 +02:00
|
|
|
does not affect messages logged via <application>syslog</>, which always contain
|
2002-06-15 21:58:53 +02:00
|
|
|
the process ID.
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2002-09-02 01:26:06 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><varname>LOG_STATEMENT</varname> (<type>boolean</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-11-11 21:14:04 +01:00
|
|
|
Causes each SQL statement to be logged.
|
2002-09-02 01:26:06 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
1999-05-20 07:39:29 +02:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>LOG_TIMESTAMP</varname> (<type>boolean</type>)</term>
|
1999-05-20 07:39:29 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2001-09-10 01:52:12 +02:00
|
|
|
Prefixes each server log message with a time stamp. The default
|
2000-06-18 23:24:54 +02:00
|
|
|
is off.
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-11-15 01:47:22 +01:00
|
|
|
<term><varname>LOG_STATEMENT_STATS</varname> (<type>boolean</type>)</term>
|
|
|
|
<term><varname>LOG_PARSER_STATS</varname> (<type>boolean</type>)</term>
|
|
|
|
<term><varname>LOG_PLANNER_STATS</varname> (<type>boolean</type>)</term>
|
|
|
|
<term><varname>LOG_EXECUTOR_STATS</varname> (<type>boolean</type>)</term>
|
1999-05-20 07:39:29 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2000-06-18 23:24:54 +02:00
|
|
|
For each query, write performance statistics of the respective
|
|
|
|
module to the server log. This is a crude profiling
|
|
|
|
instrument.
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-11-15 02:40:20 +01:00
|
|
|
<term><varname>LOG_SOURCE_PORT</varname> (<type>boolean</type>)</term>
|
1999-05-20 07:39:29 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2000-12-03 15:36:47 +01:00
|
|
|
Shows the outgoing port number of the connecting host in the
|
|
|
|
connection log messages. You could trace back the port number
|
|
|
|
to find out what user initiated the connection. Other than
|
2002-03-09 06:11:38 +01:00
|
|
|
that, it's pretty useless and therefore off by default. This
|
2000-12-03 15:36:47 +01:00
|
|
|
option can only be set at server start.
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2001-09-23 23:52:36 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><varname>STATS_COMMAND_STRING</varname> (<type>boolean</type>)</term>
|
2003-03-20 04:34:57 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Enables the collection of statistics on the currently
|
2003-03-24 15:32:51 +01:00
|
|
|
executing command of each session, along with the time at
|
|
|
|
which that command began execution. This option is off by
|
2003-03-20 04:34:57 +01:00
|
|
|
default. Note that even when enabled, this information is only
|
|
|
|
visible to the superuser, so it should not represent a
|
|
|
|
security risk. This data can be accessed via the
|
|
|
|
<structname>pg_stat_activity</structname> system view; refer
|
2003-03-25 17:15:44 +01:00
|
|
|
to <xref linkend="monitoring"> for more information.
|
2003-03-20 04:34:57 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2001-09-23 23:52:36 +02:00
|
|
|
<term><varname>STATS_BLOCK_LEVEL</varname> (<type>boolean</type>)</term>
|
|
|
|
<term><varname>STATS_ROW_LEVEL</varname> (<type>boolean</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
These enable the collection of block-level and row-level statistics
|
2003-03-20 04:34:57 +01:00
|
|
|
on database activity, respectively. These options are off by
|
|
|
|
default. This data can be accessed via the
|
|
|
|
<structname>pg_stat</structname> and
|
|
|
|
<structname>pg_statio</structname> family of system views;
|
2003-03-25 17:15:44 +01:00
|
|
|
refer to <xref linkend="monitoring"> for more information.
|
2001-09-23 23:52:36 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><varname>STATS_RESET_ON_SERVER_START</varname> (<type>boolean</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
If on, collected statistics are zeroed out whenever the server
|
2002-03-09 06:11:38 +01:00
|
|
|
is restarted. If off, statistics are accumulated across server
|
|
|
|
restarts. The default is on. This option can only be set at
|
|
|
|
server start.
|
2001-09-23 23:52:36 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><varname>STATS_START_COLLECTOR</varname> (<type>boolean</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-12-10 02:57:46 +01:00
|
|
|
Controls whether the server should start the
|
|
|
|
statistics-collection subprocess. This is on by default, but
|
|
|
|
may be turned off if you know you have no interest in
|
|
|
|
collecting statistics. This option can only be set at server
|
|
|
|
start.
|
2001-09-23 23:52:36 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
1999-05-20 07:39:29 +02:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>SYSLOG</varname> (<type>integer</type>)</term>
|
1999-05-20 07:39:29 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2001-11-21 07:09:45 +01:00
|
|
|
<productname>PostgreSQL</productname> allows the use of
|
2002-03-09 06:11:38 +01:00
|
|
|
<systemitem>syslog</systemitem> for logging. If this option is
|
|
|
|
set to 1, messages go both to <systemitem>syslog</> and the
|
|
|
|
standard output. A setting of 2 sends output only to
|
|
|
|
<systemitem>syslog</>. (Some messages will still go to the
|
|
|
|
standard output/error.) The default is 0, which means
|
|
|
|
<systemitem>syslog</> is off. This option must be set at server
|
|
|
|
start.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
1999-05-20 07:39:29 +02:00
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2000-11-13 22:35:03 +01:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>SYSLOG_FACILITY</varname> (<type>string</type>)</term>
|
2000-11-13 22:35:03 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2000-11-14 20:13:27 +01:00
|
|
|
This option determines the <application>syslog</application>
|
2002-12-10 02:57:46 +01:00
|
|
|
<quote>facility</quote> to be used when logging via
|
2002-03-09 06:11:38 +01:00
|
|
|
<application>syslog</application> is enabled. You may choose
|
2002-11-11 21:14:04 +01:00
|
|
|
from <literal>LOCAL0</>, <literal>LOCAL1</>,
|
|
|
|
<literal>LOCAL2</>, <literal>LOCAL3</>, <literal>LOCAL4</>,
|
|
|
|
<literal>LOCAL5</>, <literal>LOCAL6</>, <literal>LOCAL7</>;
|
|
|
|
the default is <literal>LOCAL0</>. See also the
|
|
|
|
documentation of your system's
|
|
|
|
<application>syslog</application>.
|
2000-11-13 22:35:03 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>SYSLOG_IDENT</varname> (<type>string</type>)</term>
|
2000-11-13 22:35:03 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
If logging to <application>syslog</> is enabled, this option
|
|
|
|
determines the program name used to identify
|
2000-11-14 20:13:27 +01:00
|
|
|
<productname>PostgreSQL</productname> messages in
|
2002-03-09 06:11:38 +01:00
|
|
|
<application>syslog</application> log messages. The default is
|
|
|
|
<literal>postgres</literal>.
|
2000-11-13 22:35:03 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
1999-05-20 07:39:29 +02:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>TRACE_NOTIFY</varname> (<type>boolean</type>)</term>
|
1999-05-20 07:39:29 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2000-06-18 23:24:54 +02:00
|
|
|
Generates a great amount of debugging output for the
|
|
|
|
<command>LISTEN</command> and <command>NOTIFY</command>
|
|
|
|
commands.
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
2000-06-18 23:24:54 +02:00
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</sect2>
|
1999-05-20 07:39:29 +02:00
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<sect2 id="runtime-config-general">
|
2002-11-11 21:14:04 +01:00
|
|
|
<title>General Operation</title>
|
1999-05-20 07:39:29 +02:00
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<variablelist>
|
2002-08-31 00:18:07 +02:00
|
|
|
<varlistentry>
|
2002-11-11 21:14:04 +01:00
|
|
|
<term><varname>AUTOCOMMIT</varname> (<type>boolean</type>)</term>
|
2002-08-31 00:18:07 +02:00
|
|
|
<indexterm><primary>autocommit</></>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
If set to true, <productname>PostgreSQL</productname> will
|
|
|
|
automatically do a <command>COMMIT</> after each successful command
|
|
|
|
that is not inside an explicit transaction block (that is, unless a
|
|
|
|
<command>BEGIN</> with no matching <command>COMMIT</> has been
|
|
|
|
given).
|
2002-10-09 06:59:38 +02:00
|
|
|
If set to false, <productname>PostgreSQL</productname> will
|
2002-10-13 18:55:05 +02:00
|
|
|
commit only upon receiving an explicit
|
2002-10-09 06:59:38 +02:00
|
|
|
<command>COMMIT</> command. This mode can also be thought of as
|
|
|
|
implicitly issuing <command>BEGIN</> whenever a command is
|
|
|
|
received that is not already inside a transaction block. The
|
|
|
|
default is true, for compatibility with historical
|
|
|
|
<productname>PostgreSQL</productname> behavior. However, for
|
|
|
|
maximum compatibility with the SQL specification, set it to
|
|
|
|
false.
|
2002-08-31 00:18:07 +02:00
|
|
|
</para>
|
2002-10-20 03:43:32 +02:00
|
|
|
|
2002-10-09 06:59:38 +02:00
|
|
|
<note>
|
|
|
|
<para>
|
2002-10-13 18:55:05 +02:00
|
|
|
Even with <varname>autocommit</> set to false, <command>SET</>,
|
2002-10-09 06:59:38 +02:00
|
|
|
<command>SHOW</>, and <command>RESET</> do not start new
|
|
|
|
transaction blocks. They are run in their own transactions.
|
2002-10-13 18:55:05 +02:00
|
|
|
Once another command is issued, a transaction block
|
|
|
|
begins and any <command>SET</>, <command>SHOW</>, or
|
2002-10-09 06:59:38 +02:00
|
|
|
<command>RESET</> commands are considered to be part of the
|
2002-11-11 21:14:04 +01:00
|
|
|
transaction, i.e., they are committed or rolled back depending
|
2002-10-13 18:55:05 +02:00
|
|
|
on the completion status of the transaction. To execute a
|
|
|
|
<command>SET</>, <command>SHOW</>, or <command>RESET</>
|
|
|
|
command at the start of a transaction block, use <command>BEGIN</>
|
2002-10-09 06:59:38 +02:00
|
|
|
first.
|
|
|
|
</para>
|
|
|
|
</note>
|
|
|
|
|
2002-10-20 03:43:32 +02:00
|
|
|
<note>
|
|
|
|
<para>
|
|
|
|
As of <productname>PostgreSQL</productname> 7.3, setting
|
|
|
|
<varname>autocommit</> to false is not well-supported.
|
|
|
|
This is a new feature and is not yet handled by all client
|
|
|
|
libraries and applications. Before making it the default
|
|
|
|
setting in your installation, test carefully.
|
|
|
|
</para>
|
|
|
|
</note>
|
|
|
|
|
2002-08-31 00:18:07 +02:00
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2001-08-15 20:42:16 +02:00
|
|
|
<varlistentry>
|
2002-11-11 21:14:04 +01:00
|
|
|
<term><varname>AUSTRALIAN_TIMEZONES</varname> (<type>boolean</type>)</term>
|
2001-11-12 20:19:39 +01:00
|
|
|
<indexterm><primary>Australian time zones</></>
|
2001-08-15 20:42:16 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
If set to true, <literal>ACST</literal>,
|
|
|
|
<literal>CST</literal>, <literal>EST</literal>, and
|
|
|
|
<literal>SAT</literal> are interpreted as Australian time
|
|
|
|
zones rather than as North/South American time zones and
|
|
|
|
Saturday. The default is false.
|
2001-08-15 20:42:16 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2001-09-21 19:06:12 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><varname>AUTHENTICATION_TIMEOUT</varname> (<type>integer</type>)</term>
|
2001-11-12 20:19:39 +01:00
|
|
|
<indexterm><primary>timeout</><secondary>authentication</></indexterm>
|
2001-09-21 19:06:12 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
Maximum time to complete client authentication, in seconds. If a
|
|
|
|
would-be client has not completed the authentication protocol in
|
|
|
|
this much time, the server breaks the connection. This prevents
|
|
|
|
hung clients from occupying a connection indefinitely. This
|
|
|
|
option can only be set at server start or in the
|
|
|
|
<filename>postgresql.conf</filename> file.
|
2001-09-21 19:06:12 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2002-05-17 03:19:19 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><varname>CLIENT_ENCODING</varname> (<type>string</type>)</term>
|
|
|
|
<indexterm><primary>character set encoding</></>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Sets the client-side encoding (character set).
|
2002-05-17 03:19:19 +02:00
|
|
|
The default is to use the database encoding.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><varname>DATESTYLE</varname> (<type>string</type>)</term>
|
|
|
|
<indexterm><primary>date style</></>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Sets the display format for date and time values, as well as the rules for
|
|
|
|
interpreting ambiguous date input values.
|
2002-05-17 03:19:19 +02:00
|
|
|
The default is <literal>ISO, US</>.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2002-08-18 05:03:26 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><varname>DB_USER_NAMESPACE</varname> (<type>boolean</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-11-11 21:14:04 +01:00
|
|
|
This allows per-database user names. It is off by default.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
If this is on, you should create users as <literal>username@dbname</>.
|
2002-11-11 21:14:04 +01:00
|
|
|
When <literal>username</> is passed by a connecting client,
|
|
|
|
<literal>@</> and the database name is appended to the user
|
|
|
|
name and that database-specific user name is looked up by the
|
|
|
|
server. Note that when you create users with names containing
|
|
|
|
<literal>@</> within the SQL environment, you will need to
|
|
|
|
quote the user name.
|
2002-08-18 05:03:26 +02:00
|
|
|
</para>
|
2002-11-11 21:14:04 +01:00
|
|
|
|
2002-08-18 05:03:26 +02:00
|
|
|
<para>
|
2002-11-11 21:14:04 +01:00
|
|
|
With this option enabled, you can still create ordinary global
|
|
|
|
users. Simply append <literal>@</> when specifying the user
|
|
|
|
name in the client. The <literal>@</> will be stripped off
|
|
|
|
before the user name is looked up by the server.
|
2002-08-18 05:03:26 +02:00
|
|
|
</para>
|
2002-11-11 21:14:04 +01:00
|
|
|
|
|
|
|
<note>
|
|
|
|
<para>
|
|
|
|
This feature is intended as a temporary measure until a
|
|
|
|
complete solution is found. At that time, this option will
|
|
|
|
be removed.
|
|
|
|
</para>
|
|
|
|
</note>
|
2002-08-18 05:03:26 +02:00
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<varlistentry>
|
2001-05-13 00:51:36 +02:00
|
|
|
<indexterm>
|
|
|
|
<primary>deadlock</primary>
|
|
|
|
<secondary>timeout</secondary>
|
|
|
|
</indexterm>
|
2001-11-12 20:19:39 +01:00
|
|
|
<indexterm>
|
|
|
|
<primary>timeout</primary>
|
|
|
|
<secondary>deadlock</secondary>
|
|
|
|
</indexterm>
|
2001-05-13 00:51:36 +02:00
|
|
|
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>DEADLOCK_TIMEOUT</varname> (<type>integer</type>)</term>
|
2000-06-18 23:24:54 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2000-07-18 00:32:44 +02:00
|
|
|
This is the amount of time, in milliseconds, to wait on a lock
|
2002-03-09 06:11:38 +01:00
|
|
|
before checking to see if there is a deadlock condition. The
|
|
|
|
check for deadlock is relatively slow, so the server doesn't run
|
|
|
|
it every time it waits for a lock. We (optimistically?) assume
|
|
|
|
that deadlocks are not common in production applications and
|
2003-03-24 15:32:51 +01:00
|
|
|
just wait on the lock for a while before starting the check for a
|
2002-03-09 06:11:38 +01:00
|
|
|
deadlock. Increasing this value reduces the amount of time
|
|
|
|
wasted in needless deadlock checks, but slows down reporting of
|
|
|
|
real deadlock errors. The default is 1000 (i.e., one second),
|
|
|
|
which is probably about the smallest value you would want in
|
|
|
|
practice. On a heavily loaded server you might want to raise it.
|
|
|
|
Ideally the setting should exceed your typical transaction time,
|
2003-03-24 15:32:51 +01:00
|
|
|
so as to improve the odds that a lock will be released before
|
2003-02-06 21:25:33 +01:00
|
|
|
the waiter decides to check for deadlock.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2001-07-01 00:03:26 +02:00
|
|
|
<varlistentry>
|
|
|
|
<indexterm>
|
|
|
|
<primary>transaction isolation level</primary>
|
|
|
|
</indexterm>
|
|
|
|
|
2001-09-21 05:32:36 +02:00
|
|
|
<term><varname>DEFAULT_TRANSACTION_ISOLATION</varname> (<type>string</type>)</term>
|
2001-07-01 00:03:26 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
Each SQL transaction has an isolation level, which can be either
|
|
|
|
<quote>read committed</quote> or <quote>serializable</quote>.
|
|
|
|
This parameter controls the default isolation level of each new
|
2002-03-11 06:03:52 +01:00
|
|
|
transaction. The default is <quote>read committed</quote>.
|
2001-07-01 00:03:26 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2003-03-25 17:15:44 +01:00
|
|
|
Consult <xref linkend="mvcc"> and <xref linkend="sql-set-transaction"> for more
|
2001-07-01 00:03:26 +02:00
|
|
|
information.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2001-05-17 19:44:18 +02:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>DYNAMIC_LIBRARY_PATH</varname> (<type>string</type>)</term>
|
2001-11-12 20:19:39 +01:00
|
|
|
<indexterm><primary>dynamic_library_path</></>
|
|
|
|
<indexterm><primary>dynamic loading</></>
|
2001-05-17 19:44:18 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
If a dynamically loadable module needs to be opened and the
|
2002-03-09 06:11:38 +01:00
|
|
|
specified name does not have a directory component (i.e. the
|
2001-05-17 19:44:18 +02:00
|
|
|
name does not contain a slash), the system will search this
|
|
|
|
path for the specified file. (The name that is used is the
|
|
|
|
name specified in the <command>CREATE FUNCTION</command> or
|
|
|
|
<command>LOAD</command> command.)
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
The value for <varname>DYNAMIC_LIBRARY_PATH</varname> has to be a colon-separated
|
2002-03-09 06:11:38 +01:00
|
|
|
list of absolute directory names. If a directory name starts
|
2001-05-17 19:44:18 +02:00
|
|
|
with the special value <literal>$libdir</literal>, the
|
2002-03-09 06:11:38 +01:00
|
|
|
compiled-in <productname>PostgreSQL</productname> package
|
|
|
|
library directory is substituted. This where the modules
|
|
|
|
provided by the <productname>PostgreSQL</productname>
|
|
|
|
distribution are installed. (Use <literal>pg_config
|
|
|
|
--pkglibdir</literal> to print the name of this directory.) For
|
|
|
|
example:
|
2001-05-17 19:44:18 +02:00
|
|
|
<programlisting>
|
2001-09-16 18:11:11 +02:00
|
|
|
dynamic_library_path = '/usr/local/lib/postgresql:/home/my_project/lib:$libdir'
|
2001-05-17 19:44:18 +02:00
|
|
|
</programlisting>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
The default value for this parameter is
|
2002-04-01 05:34:27 +02:00
|
|
|
<literal>'$libdir'</literal>. If the value is set to an empty
|
2001-05-17 19:44:18 +02:00
|
|
|
string, the automatic path search is turned off.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
This parameter can be changed at run time by superusers, but a
|
|
|
|
setting done that way will only persist until the end of the
|
|
|
|
client connection, so this method should be reserved for
|
|
|
|
development purposes. The recommended way to set this parameter
|
|
|
|
is in the <filename>postgresql.conf</filename> configuration
|
|
|
|
file.
|
2001-05-17 19:44:18 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2002-11-08 18:37:52 +01:00
|
|
|
<varlistentry>
|
|
|
|
<indexterm>
|
|
|
|
<primary>significant digits</primary>
|
|
|
|
</indexterm>
|
|
|
|
<indexterm>
|
|
|
|
<primary>display</primary>
|
|
|
|
<secondary>of float numbers</secondary>
|
|
|
|
</indexterm>
|
|
|
|
|
|
|
|
<term><varname>EXTRA_FLOAT_DIGITS</varname> (<type>integer</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
This parameter adjusts the number of digits displayed for
|
|
|
|
floating-point values, including <type>float4</>, <type>float8</>,
|
|
|
|
and geometric datatypes. The parameter value is added to the
|
|
|
|
standard number of digits (<literal>FLT_DIG</> or <literal>DBL_DIG</>
|
|
|
|
as appropriate). The value can be set as high as 2, to include
|
|
|
|
partially-significant digits; this is especially useful for dumping
|
|
|
|
float data that needs to be restored exactly. Or it can be set
|
|
|
|
negative to suppress unwanted digits.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2002-04-01 05:34:27 +02:00
|
|
|
<varlistentry>
|
2002-08-15 16:26:15 +02:00
|
|
|
<term><varname>KRB_SERVER_KEYFILE</varname> (<type>string</type>)</term>
|
2002-04-01 05:34:27 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-08-15 16:26:15 +02:00
|
|
|
Sets the location of the Kerberos server key file. See
|
|
|
|
<xref linkend="kerberos-auth"> for details.
|
2002-04-26 03:24:08 +02:00
|
|
|
</para>
|
2002-04-01 05:34:27 +02:00
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<varlistentry>
|
2001-05-13 00:51:36 +02:00
|
|
|
<indexterm>
|
|
|
|
<primary>fsync</primary>
|
|
|
|
</indexterm>
|
|
|
|
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>FSYNC</varname> (<type>boolean</type>)</term>
|
2000-06-18 23:24:54 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
If this option is on, the <productname>PostgreSQL</> server
|
2002-03-09 06:11:38 +01:00
|
|
|
will use the <function>fsync()</> system call in several places
|
|
|
|
to make sure that updates are physically written to disk. This
|
2003-03-24 15:32:51 +01:00
|
|
|
insures that a database cluster will recover to a
|
2002-03-09 06:11:38 +01:00
|
|
|
consistent state after an operating system or hardware crash.
|
|
|
|
(Crashes of the database server itself are <emphasis>not</>
|
|
|
|
related to this.)
|
2000-07-16 16:47:57 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
However, this operation does slow down
|
|
|
|
<productname>PostgreSQL</> because at transaction commit it has
|
|
|
|
wait for the operating system to flush the write-ahead log.
|
|
|
|
Without <function>fsync</>, the operating system is allowed to
|
|
|
|
do its best in buffering, sorting, and delaying writes, which
|
|
|
|
can considerably increase performance. However, if the system
|
|
|
|
crashes, the results of the last few committed transactions may
|
|
|
|
be lost in part or whole. In the worst case, unrecoverable data
|
|
|
|
corruption may occur.
|
2000-07-16 16:47:57 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
For the above reasons, everyone can decide for himself what to
|
|
|
|
do with the <varname>fsync</> option. Some administrators
|
|
|
|
always leave it off, some turn it off only for bulk loads,
|
|
|
|
where there is a clear restart point if something goes wrong,
|
|
|
|
and some leave it on just to be on the safe side. The default
|
|
|
|
is on so that you are on the safe side. If you trust your
|
|
|
|
operating system, your hardware, and your utility company (or
|
|
|
|
better your battery backup), you can consider disabling
|
|
|
|
<varname>fsync</varname>.
|
2001-02-18 06:30:12 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
It should be noted that the performance penalty of having
|
2003-03-28 21:17:13 +01:00
|
|
|
<varname>fsync</> on is considerably less in
|
2002-03-09 06:11:38 +01:00
|
|
|
<productname>PostgreSQL</> version 7.1 and later. If you
|
2003-03-24 15:32:51 +01:00
|
|
|
previously suppressed <function>fsync</> for performance
|
2002-03-09 06:11:38 +01:00
|
|
|
reasons, you may wish to reconsider your choice.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
XLOG (and related) changes:
* Store two past checkpoint locations, not just one, in pg_control.
On startup, we fall back to the older checkpoint if the newer one
is unreadable. Also, a physical copy of the newest checkpoint record
is kept in pg_control for possible use in disaster recovery (ie,
complete loss of pg_xlog). Also add a version number for pg_control
itself. Remove archdir from pg_control; it ought to be a GUC
parameter, not a special case (not that it's implemented yet anyway).
* Suppress successive checkpoint records when nothing has been entered
in the WAL log since the last one. This is not so much to avoid I/O
as to make it actually useful to keep track of the last two
checkpoints. If the things are right next to each other then there's
not a lot of redundancy gained...
* Change CRC scheme to a true 64-bit CRC, not a pair of 32-bit CRCs
on alternate bytes. Polynomial borrowed from ECMA DLT1 standard.
* Fix XLOG record length handling so that it will work at BLCKSZ = 32k.
* Change XID allocation to work more like OID allocation. (This is of
dubious necessity, but I think it's a good idea anyway.)
* Fix a number of minor bugs, such as off-by-one logic for XLOG file
wraparound at the 4 gig mark.
* Add documentation and clean up some coding infelicities; move file
format declarations out to include files where planned contrib
utilities can get at them.
* Checkpoint will now occur every CHECKPOINT_SEGMENTS log segments or
every CHECKPOINT_TIMEOUT seconds, whichever comes first. It is also
possible to force a checkpoint by sending SIGUSR1 to the postmaster
(undocumented feature...)
* Defend against kill -9 postmaster by storing shmem block's key and ID
in postmaster.pid lockfile, and checking at startup to ensure that no
processes are still connected to old shmem block (if it still exists).
* Switch backends to accept SIGQUIT rather than SIGUSR1 for emergency
stop, for symmetry with postmaster and xlog utilities. Clean up signal
handling in bootstrap.c so that xlog utilities launched by postmaster
will react to signals better.
* Standalone bootstrap now grabs lockfile in target directory, as added
insurance against running it in parallel with live postmaster.
2001-03-13 02:17:06 +01:00
|
|
|
|
|
|
|
<para>
|
|
|
|
This option can only be set at server start or in the
|
|
|
|
<filename>postgresql.conf</filename> file.
|
|
|
|
</para>
|
2000-06-18 23:24:54 +02:00
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
1999-05-20 07:39:29 +02:00
|
|
|
|
2002-04-03 07:39:33 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><varname>LC_MESSAGES</varname> (<type>string</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Sets the language in which messages are displayed. Acceptable
|
|
|
|
values are system-dependent; see <xref linkend="locale"> for
|
|
|
|
more information. If this variable is set to the empty string
|
|
|
|
(which is the default) then the value is inherited from the
|
|
|
|
execution environment of the server in a system-dependent way.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
On some systems, this locale category does not exist. Setting
|
|
|
|
this variable will still work, but there will be no effect.
|
|
|
|
Also, there is a chance that no translated messages for the
|
|
|
|
desired language exist. In that case you will continue to see
|
|
|
|
the English messages.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><varname>LC_MONETARY</varname> (<type>string</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-08-10 00:52:04 +02:00
|
|
|
Sets the locale to use for formatting monetary amounts, for
|
2003-03-24 15:32:51 +01:00
|
|
|
example with the <function>to_char</function> family of
|
2002-08-10 00:52:04 +02:00
|
|
|
functions. Acceptable values are system-dependent; see <xref
|
2002-04-03 07:39:33 +02:00
|
|
|
linkend="locale"> for more information. If this variable is
|
|
|
|
set to the empty string (which is the default) then the value
|
|
|
|
is inherited from the execution environment of the server in a
|
|
|
|
system-dependent way.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><varname>LC_NUMERIC</varname> (<type>string</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Sets the locale to use for formatting numbers, for example
|
|
|
|
with the <function>to_char()</function> family of
|
|
|
|
functions. Acceptable values are system-dependent; see <xref
|
|
|
|
linkend="locale"> for more information. If this variable is
|
|
|
|
set to the empty string (which is the default) then the value
|
|
|
|
is inherited from the execution environment of the server in a
|
|
|
|
system-dependent way.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><varname>LC_TIME</varname> (<type>string</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-08-10 00:52:04 +02:00
|
|
|
Sets the locale to use for formatting date and time values.
|
|
|
|
(Currently, this setting does nothing, but it may in the
|
|
|
|
future.) Acceptable values are system-dependent; see <xref
|
2002-04-03 07:39:33 +02:00
|
|
|
linkend="locale"> for more information. If this variable is
|
|
|
|
set to the empty string (which is the default) then the value
|
|
|
|
is inherited from the execution environment of the server in a
|
|
|
|
system-dependent way.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>MAX_CONNECTIONS</varname> (<type>integer</type>)</term>
|
2000-06-18 23:24:54 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
Determines the maximum number of concurrent connections to the
|
|
|
|
database server. The default is 32 (unless altered while
|
|
|
|
building the server). This parameter can only be set at server
|
|
|
|
start.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
1999-05-20 07:39:29 +02:00
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>MAX_EXPR_DEPTH</varname> (<type>integer</type>)</term>
|
2000-06-18 23:24:54 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
Sets the maximum expression nesting depth of the parser. The
|
|
|
|
default value is high enough for any normal query, but you can
|
|
|
|
raise it if needed. (But if you raise it too high, you run
|
2003-03-24 15:32:51 +01:00
|
|
|
the risk of server crashes due to stack overflow.)
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
1999-05-20 07:39:29 +02:00
|
|
|
</listitem>
|
2001-09-30 20:57:45 +02:00
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><varname>MAX_FILES_PER_PROCESS</varname> (<type>integer</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Sets the maximum number of simultaneously open files allowed to each
|
2002-03-09 06:11:38 +01:00
|
|
|
server subprocess. The default is 1000. The limit actually used
|
|
|
|
by the code is the smaller of this setting and the result of
|
|
|
|
<literal>sysconf(_SC_OPEN_MAX)</literal>. Therefore, on systems
|
|
|
|
where <function>sysconf</> returns a reasonable limit, you don't
|
|
|
|
need to worry about this setting. But on some platforms
|
|
|
|
(notably, most BSD systems), <function>sysconf</> returns a
|
|
|
|
value that is much larger than the system can really support
|
|
|
|
when a large number of processes all try to open that many
|
|
|
|
files. If you find yourself seeing <quote>Too many open files</>
|
|
|
|
failures, try reducing this setting. This option can only be set
|
|
|
|
at server start or in the <filename>postgresql.conf</filename>
|
|
|
|
configuration file; if changed in the configuration file, it
|
|
|
|
only affects subsequently-started server subprocesses.
|
2001-09-30 20:57:45 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
1999-05-20 07:39:29 +02:00
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-12-10 02:57:46 +01:00
|
|
|
<term><varname>MAX_FSM_PAGES</varname> (<type>integer</type>)</term>
|
2001-06-28 01:31:40 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-12-10 02:57:46 +01:00
|
|
|
Sets the maximum number of disk pages for which free space will
|
2003-03-04 22:51:22 +01:00
|
|
|
be tracked in the shared free-space map. Six bytes of shared memory
|
|
|
|
are consumed for each page slot. This setting must be more than
|
|
|
|
16 * <varname>max_fsm_relations</varname>. The default is 20000.
|
2002-12-10 02:57:46 +01:00
|
|
|
This option can only be set at server start.
|
2001-06-28 01:31:40 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2002-12-10 02:57:46 +01:00
|
|
|
<term><varname>MAX_FSM_RELATIONS</varname> (<type>integer</type>)</term>
|
2001-06-28 01:31:40 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-04 22:51:22 +01:00
|
|
|
Sets the maximum number of relations (tables and indexes) for which
|
|
|
|
free space will be tracked in the shared free-space map. Roughly
|
|
|
|
fifty bytes of shared memory are consumed for each slot.
|
|
|
|
The default is 1000.
|
|
|
|
This option can only be set at server start.
|
2001-06-28 01:31:40 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2001-09-12 16:06:37 +02:00
|
|
|
<term><varname>MAX_LOCKS_PER_TRANSACTION</varname> (<type>integer</type>)</term>
|
2001-06-28 01:31:40 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The shared lock table is sized on the assumption that at most
|
2002-03-09 06:11:38 +01:00
|
|
|
<varname>max_locks_per_transaction</> *
|
|
|
|
<varname>max_connections</varname> distinct objects will need to
|
2002-12-10 02:57:46 +01:00
|
|
|
be locked at any one time. The default, 64, has historically
|
2002-03-09 06:11:38 +01:00
|
|
|
proven sufficient, but you might need to raise this value if you
|
|
|
|
have clients that touch many different tables in a single
|
|
|
|
transaction. This option can only be set at server start.
|
2001-06-28 01:31:40 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2001-09-21 05:32:36 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><varname>PASSWORD_ENCRYPTION</varname> (<type>boolean</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
When a password is specified in <command>CREATE USER</> or
|
2002-11-11 21:14:04 +01:00
|
|
|
<command>ALTER USER</> without writing either <literal>ENCRYPTED</> or
|
2003-03-24 15:32:51 +01:00
|
|
|
<literal>UNENCRYPTED</>, this option determines whether the password is to be
|
2002-06-15 03:29:50 +02:00
|
|
|
encrypted. The default is on (encrypt the password).
|
2001-09-21 05:32:36 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2001-06-28 01:31:40 +02:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>PORT</varname> (<type>integer</type>)</term>
|
2001-11-12 20:19:39 +01:00
|
|
|
<indexterm><primary>port</></>
|
1999-05-20 07:39:29 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2000-06-18 23:24:54 +02:00
|
|
|
The TCP port the server listens on; 5432 by default. This
|
|
|
|
option can only be set at server start.
|
1999-05-20 07:39:29 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
> I can see a couple possible downsides: (a) the library might have some
> weird behavior across fork boundaries; (b) the additional memory space
> that has to be duplicated into child processes will cost something per
> child launch, even if the child never uses it. But these are only
> arguments that it might not *always* be a prudent thing to do, not that
> we shouldn't give the DBA the tool to do it if he wants. So fire away.
Here is a patch for the above, including a documentation update. It
creates a new GUC variable "preload_libraries", that accepts a list in
the form:
preload_libraries = '$libdir/mylib1:initfunc,$libdir/mylib2'
If ":initfunc" is omitted or not found, no initialization function is
executed, but the library is still preloaded. If "$libdir/mylib" isn't
found, the postmaster refuses to start.
In my testing with PL/R, it reduces the first call to a PL/R function
(after connecting) from almost 2 seconds, down to about 8 ms.
Joe Conway
2003-03-20 05:51:44 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><varname>PRELOAD_LIBRARIES</varname> (<type>string</type>)</term>
|
|
|
|
<indexterm><primary>preload_libraries</></>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
This variable specifies one or more shared libraries that are to be
|
|
|
|
preloaded at Postmaster start. An initialization function can also be
|
|
|
|
optionally specified by adding a colon followed by the name of the
|
|
|
|
initialization function after the library name. For example
|
|
|
|
<literal>'$libdir/mylib:init_mylib'</literal> would cause <literal>mylib</>
|
|
|
|
to be preloaded and <literal>init_mylib</> to be executed. If more than
|
|
|
|
one library is to be loaded, they must be delimited with a comma.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
If <literal>mylib</> is not found, the postmaster will fail to start.
|
|
|
|
However, if <literal>init_mylib</> is not found, <literal>mylib</> will
|
|
|
|
still be preloaded without executing the initialization function.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
By preloading a shared library (and initializing it if applicable),
|
|
|
|
the library startup time is avoided when the library is used later in a
|
|
|
|
specific backend. However there is a cost in terms of memory duplication
|
|
|
|
as every backend is forked, whether or not the library is used.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2003-02-06 21:25:33 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><varname>REGEX_FLAVOR</varname> (<type>string</type>)</term>
|
|
|
|
<indexterm><primary>regular expressions</></>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The regular expression <quote>flavor</> can be set to
|
|
|
|
<literal>advanced</>, <literal>extended</>, or <literal>basic</>.
|
|
|
|
The usual default is <literal>advanced</>. The <literal>extended</>
|
|
|
|
setting may be useful for exact backwards compatibility with
|
|
|
|
pre-7.4 releases of <productname>PostgreSQL</>.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2002-08-15 16:26:15 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><varname>SEARCH_PATH</varname> (<type>string</type>)</term>
|
|
|
|
<indexterm><primary>search_path</></>
|
2003-03-24 15:32:51 +01:00
|
|
|
<indexterm><primary>path</><secondary>for schemas</></>
|
2002-08-15 16:26:15 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-11-11 21:14:04 +01:00
|
|
|
This variable specifies the order in which schemas are searched
|
|
|
|
when an object (table, data type, function, etc.) is referenced by a
|
2002-08-15 16:26:15 +02:00
|
|
|
simple name with no schema component. When there are objects of
|
2002-11-11 21:14:04 +01:00
|
|
|
identical names in different schemas, the one found first
|
2002-08-15 16:26:15 +02:00
|
|
|
in the search path is used. An object that is not in any of the
|
2002-11-11 21:14:04 +01:00
|
|
|
schemas in the search path can only be referenced by specifying
|
|
|
|
its containing schema with a qualified (dotted) name.
|
2002-08-15 16:26:15 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2002-11-11 21:14:04 +01:00
|
|
|
The value for <varname>search_path</varname> has to be a comma-separated
|
|
|
|
list of schema names. If one of the list items is
|
|
|
|
the special value <literal>$user</literal>, then the schema
|
2003-03-24 15:32:51 +01:00
|
|
|
having the name returned by <function>SESSION_USER</> is substituted, if there
|
2002-11-11 21:14:04 +01:00
|
|
|
is such a schema. (If not, <literal>$user</literal> is ignored.)
|
2002-08-15 16:26:15 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2002-11-11 21:14:04 +01:00
|
|
|
The system catalog schema, <literal>pg_catalog</>, is always
|
2002-08-15 16:26:15 +02:00
|
|
|
searched, whether it is mentioned in the path or not. If it is
|
|
|
|
mentioned in the path then it will be searched in the specified
|
|
|
|
order. If <literal>pg_catalog</> is not in the path then it will
|
|
|
|
be searched <emphasis>before</> searching any of the path items.
|
2002-11-11 21:14:04 +01:00
|
|
|
It should also be noted that the temporary-table schema,
|
|
|
|
<literal>pg_temp_<replaceable>nnn</></>, is implicitly searched before any of
|
2002-08-15 16:26:15 +02:00
|
|
|
these.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
When objects are created without specifying a particular target
|
2002-11-11 21:14:04 +01:00
|
|
|
schema, they will be placed in the first schema listed
|
2002-08-15 16:26:15 +02:00
|
|
|
in the search path. An error is reported if the search path is
|
|
|
|
empty.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
The default value for this parameter is
|
|
|
|
<literal>'$user, public'</literal> (where the second part will be
|
2002-11-11 21:14:04 +01:00
|
|
|
ignored if there is no schema named <literal>public</>).
|
2002-08-15 16:26:15 +02:00
|
|
|
This supports shared use of a database (where no users
|
2002-11-11 21:14:04 +01:00
|
|
|
have private schemas, and all share use of <literal>public</>),
|
|
|
|
private per-user schemas, and combinations of these. Other
|
2002-08-15 16:26:15 +02:00
|
|
|
effects can be obtained by altering the default search path
|
|
|
|
setting, either globally or per-user.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
The current effective value of the search path can be examined
|
|
|
|
via the SQL function <function>current_schemas()</>. This is not
|
|
|
|
quite the same as examining the value of
|
|
|
|
<varname>search_path</varname>, since <function>current_schemas()</>
|
|
|
|
shows how the requests appearing in <varname>search_path</varname>
|
|
|
|
were resolved.
|
|
|
|
</para>
|
2002-11-11 21:14:04 +01:00
|
|
|
|
|
|
|
<para>
|
2003-03-25 17:15:44 +01:00
|
|
|
For more information on schema handling, see <xref linkend="ddl-schemas">.
|
2002-11-11 21:14:04 +01:00
|
|
|
</para>
|
2002-08-15 16:26:15 +02:00
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2002-07-13 03:02:14 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><varname>STATEMENT_TIMEOUT</varname> (<type>integer</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Aborts any statement that takes over the specified number of
|
2002-08-29 21:53:58 +02:00
|
|
|
milliseconds. A value of zero turns off the timer.
|
2002-07-13 03:02:14 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
1999-05-20 07:39:29 +02:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>SHARED_BUFFERS</varname> (<type>integer</type>)</term>
|
2000-04-09 01:12:01 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
Sets the number of shared memory buffers used by the database
|
2003-01-11 06:04:14 +01:00
|
|
|
server. The default is 64. Each buffer is typically 8192
|
|
|
|
bytes. This must be greater than 16, as well as at least twice
|
|
|
|
the value of <varname>MAX_CONNECTIONS</varname>; however, a
|
2003-01-26 00:10:30 +01:00
|
|
|
higher value can often improve performance.
|
|
|
|
Values of a few thousand are recommended
|
2003-01-11 06:04:14 +01:00
|
|
|
for production installations. This option can only be set at
|
|
|
|
server start.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
Increasing this parameter may cause <productname>PostgreSQL</>
|
|
|
|
to request more <systemitem class="osname">System V</> shared
|
|
|
|
memory than your operating system's default configuration
|
|
|
|
allows. See <xref linkend="sysvipc"> for information on how to
|
|
|
|
adjust these parameters, if necessary.
|
2000-04-09 01:12:01 +02:00
|
|
|
</para>
|
2000-10-08 11:25:38 +02:00
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2003-03-24 15:32:51 +01:00
|
|
|
<term><varname>SILENT_MODE</varname> (<type>boolean</type>)</term>
|
2000-10-08 11:25:38 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-11-11 21:14:04 +01:00
|
|
|
Runs the server silently. If this option is set, the server
|
2003-03-24 15:32:51 +01:00
|
|
|
will automatically run in background and any controlling terminals
|
|
|
|
are disassociated. Thus, no messages are written to standard
|
2002-11-11 21:14:04 +01:00
|
|
|
output or standard error (same effect as <command>postmaster</>'s <option>-S</option>
|
2002-03-09 06:11:38 +01:00
|
|
|
option). Unless some logging system such as
|
|
|
|
<application>syslog</> is enabled, using this option is
|
|
|
|
discouraged since it makes it impossible to see error messages.
|
2000-10-08 11:25:38 +02:00
|
|
|
</para>
|
2000-04-09 01:12:01 +02:00
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>SORT_MEM</varname> (<type>integer</type>)</term>
|
2000-06-18 23:24:54 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Specifies the amount of memory to be used by internal sort operations and
|
2003-01-26 00:10:30 +01:00
|
|
|
hash tables before switching to temporary disk files. The value is
|
2002-11-11 21:14:04 +01:00
|
|
|
specified in kilobytes, and defaults to 1024 kilobytes (1 MB).
|
2003-03-24 15:32:51 +01:00
|
|
|
Note that for a complex query, several sort or hash operations might be
|
2003-01-26 00:10:30 +01:00
|
|
|
running in parallel; each one will be allowed to use as much memory
|
|
|
|
as this value specifies before it starts to put data into temporary
|
2003-03-24 15:32:51 +01:00
|
|
|
files. Also, several running sessions could be doing
|
|
|
|
sort operations simultaneously. So the total memory used could be many
|
|
|
|
times the value of <varname>SORT_MEM</varname>. Sort operations are used
|
2002-11-11 21:14:04 +01:00
|
|
|
by <literal>ORDER BY</>, merge joins, and <command>CREATE INDEX</>.
|
2003-01-26 00:10:30 +01:00
|
|
|
Hash tables are used in hash joins, hash-based aggregation, and
|
2003-03-24 15:32:51 +01:00
|
|
|
hash-based processing of <literal>IN</> subqueries.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2000-06-23 00:31:24 +02:00
|
|
|
|
|
|
|
<varlistentry>
|
2003-03-24 15:32:51 +01:00
|
|
|
<term><varname>SQL_INHERITANCE</varname> (<type>boolean</type>)</term>
|
2001-11-12 20:19:39 +01:00
|
|
|
<indexterm><primary>inheritance</></>
|
2000-06-23 00:31:24 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
This controls the inheritance semantics, in particular whether
|
2002-03-09 06:11:38 +01:00
|
|
|
subtables are included by various commands by default. They were
|
|
|
|
not included in versions prior to 7.1. If you need the old
|
|
|
|
behavior you can set this variable to off, but in the long run
|
|
|
|
you are encouraged to change your applications to use the
|
2003-03-25 17:15:44 +01:00
|
|
|
<literal>ONLY</literal> key word to exclude subtables. See
|
|
|
|
<xref linkend="sql"> for more information about inheritance.
|
2000-06-23 00:31:24 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2000-09-06 21:54:52 +02:00
|
|
|
|
|
|
|
<varlistentry>
|
2001-05-13 00:51:36 +02:00
|
|
|
<indexterm>
|
|
|
|
<primary>SSL</primary>
|
|
|
|
</indexterm>
|
|
|
|
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>SSL</varname> (<type>boolean</type>)</term>
|
2000-09-06 21:54:52 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Enables <acronym>SSL</> connections. Please read
|
2000-10-20 16:00:49 +02:00
|
|
|
<xref linkend="ssl-tcp"> before using this. The default
|
2000-09-06 21:54:52 +02:00
|
|
|
is off.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2002-11-21 07:36:08 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><varname>SUPERUSER_RESERVED_CONNECTIONS</varname>
|
|
|
|
(<type>integer</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Determines the number of <quote>connection slots</quote> that
|
|
|
|
are reserved for connections by <productname>PostgreSQL</>
|
|
|
|
superusers. At most <varname>max_connections</> connections can
|
|
|
|
ever be active simultaneously. Whenever the number of active
|
|
|
|
concurrent connections is at least <varname>max_connections</> minus
|
|
|
|
<varname>superuser_reserved_connections</varname>, new connections
|
2003-03-24 15:32:51 +01:00
|
|
|
will be accepted only for superusers.
|
2002-11-21 07:36:08 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
The default value is 2. The value must be less than the value of
|
|
|
|
<varname>max_connections</varname>. This parameter can only be
|
|
|
|
set at server start.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2000-09-06 21:54:52 +02:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>TCPIP_SOCKET</varname> (<type>boolean</type>)</term>
|
2000-09-06 21:54:52 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
If this is true, then the server will accept TCP/IP connections.
|
|
|
|
Otherwise only local Unix domain socket connections are
|
|
|
|
accepted. It is off by default. This option can only be set at
|
|
|
|
server start.
|
2000-09-06 21:54:52 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2000-11-01 22:14:03 +01:00
|
|
|
|
2002-05-17 03:19:19 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><varname>TIMEZONE</varname> (<type>string</type>)</term>
|
|
|
|
<indexterm><primary>time zone</></>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Sets the time zone for displaying and interpreting time stamps.
|
2002-05-17 03:19:19 +02:00
|
|
|
The default is to use whatever the system environment
|
2002-11-11 21:14:04 +01:00
|
|
|
specifies as the time zone.
|
2002-05-17 03:19:19 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2001-09-23 23:52:36 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><varname>TRANSFORM_NULL_EQUALS</varname> (<type>boolean</type>)</term>
|
2001-11-12 20:19:39 +01:00
|
|
|
<indexterm><primary>IS NULL</></>
|
2001-09-23 23:52:36 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
When turned on, expressions of the form
|
2002-03-09 06:11:38 +01:00
|
|
|
<literal><replaceable>expr</> = NULL</literal> (or <literal>NULL
|
|
|
|
= <replaceable>expr</></literal>) are treated as
|
2001-09-23 23:52:36 +02:00
|
|
|
<literal><replaceable>expr</> IS NULL</literal>, that is, they
|
2002-11-11 21:14:04 +01:00
|
|
|
return true if <replaceable>expr</> evaluates to the null value,
|
2002-03-09 06:11:38 +01:00
|
|
|
and false otherwise. The correct behavior of
|
2001-09-23 23:52:36 +02:00
|
|
|
<literal><replaceable>expr</> = NULL</literal> is to always
|
2002-11-11 21:14:04 +01:00
|
|
|
return null (unknown). Therefore this option defaults to off.
|
2001-09-23 23:52:36 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
However, filtered forms in <productname>Microsoft
|
|
|
|
Access</productname> generate queries that appear to use
|
|
|
|
<literal><replaceable>expr</> = NULL</literal> to test for
|
2002-09-21 20:32:54 +02:00
|
|
|
null values, so if you use that interface to access the database you
|
2001-09-23 23:52:36 +02:00
|
|
|
might want to turn this option on. Since expressions of the
|
|
|
|
form <literal><replaceable>expr</> = NULL</literal> always
|
2002-11-11 21:14:04 +01:00
|
|
|
return the null value (using the correct interpretation) they are not
|
2001-09-23 23:52:36 +02:00
|
|
|
very useful and do not appear often in normal applications, so
|
|
|
|
this option does little harm in practice. But new users are
|
|
|
|
frequently confused about the semantics of expressions
|
2002-11-11 21:14:04 +01:00
|
|
|
involving null values, so this option is not on by default.
|
2001-09-23 23:52:36 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
Note that this option only affects the literal <literal>=</>
|
|
|
|
operator, not other comparison operators or other expressions
|
|
|
|
that are computationally equivalent to some expression
|
|
|
|
involving the equals operator (such as <literal>IN</literal>).
|
|
|
|
Thus, this option is not a general fix for bad programming.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2003-03-25 17:15:44 +01:00
|
|
|
Refer to <xref linkend="functions-comparison"> for related information.
|
2001-09-23 23:52:36 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2000-11-14 19:11:32 +01:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>UNIX_SOCKET_DIRECTORY</varname> (<type>string</type>)</term>
|
2000-11-14 19:11:32 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2000-12-01 00:20:51 +01:00
|
|
|
Specifies the directory of the Unix-domain socket on which the
|
2002-11-11 21:14:04 +01:00
|
|
|
server is to listen for
|
2000-12-01 00:20:51 +01:00
|
|
|
connections from client applications. The default is normally
|
|
|
|
<filename>/tmp</filename>, but can be changed at build time.
|
2000-11-14 19:11:32 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2000-11-01 22:14:03 +01:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>UNIX_SOCKET_GROUP</varname> (<type>string</type>)</term>
|
2000-11-01 22:14:03 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Sets the group owner of the Unix domain socket. (The owning
|
|
|
|
user of the socket is always the user that starts the
|
2002-11-11 21:14:04 +01:00
|
|
|
server.) In combination with the option
|
2003-03-24 15:32:51 +01:00
|
|
|
<varname>UNIX_SOCKET_PERMISSIONS</varname> this can be used as
|
2000-11-01 22:14:03 +01:00
|
|
|
an additional access control mechanism for this socket type.
|
|
|
|
By default this is the empty string, which uses the default
|
|
|
|
group for the current user. This option can only be set at
|
|
|
|
server start.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>UNIX_SOCKET_PERMISSIONS</varname> (<type>integer</type>)</term>
|
2000-11-01 22:14:03 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Sets the access permissions of the Unix domain socket. Unix
|
|
|
|
domain sockets use the usual Unix file system permission set.
|
|
|
|
The option value is expected to be an numeric mode
|
|
|
|
specification in the form accepted by the
|
|
|
|
<function>chmod</function> and <function>umask</function>
|
|
|
|
system calls. (To use the customary octal format the number
|
|
|
|
must start with a <literal>0</literal> (zero).)
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
The default permissions are <literal>0777</literal>, meaning
|
2002-03-09 06:11:38 +01:00
|
|
|
anyone can connect. Reasonable alternatives are
|
2000-11-01 22:14:03 +01:00
|
|
|
<literal>0770</literal> (only user and group, see also under
|
2003-03-24 15:32:51 +01:00
|
|
|
<varname>UNIX_SOCKET_GROUP</varname>) and <literal>0700</literal>
|
2002-11-11 21:14:04 +01:00
|
|
|
(only user). (Note that actually for a Unix domain socket, only write
|
2002-03-09 06:11:38 +01:00
|
|
|
permission matters and there is no point in setting or revoking
|
|
|
|
read or execute permissions.)
|
2000-11-01 22:14:03 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
This access control mechanism is independent of the one
|
2000-11-01 22:14:03 +01:00
|
|
|
described in <xref linkend="client-authentication">.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
This option can only be set at server start.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2001-09-21 05:32:36 +02:00
|
|
|
<varlistentry>
|
|
|
|
<term><varname>VACUUM_MEM</varname> (<type>integer</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Specifies the maximum amount of memory to be used by
|
2002-03-09 06:11:38 +01:00
|
|
|
<command>VACUUM</command> to keep track of to-be-reclaimed
|
|
|
|
tuples. The value is specified in kilobytes, and defaults to
|
|
|
|
8192 kilobytes. Larger settings may improve the speed of
|
|
|
|
vacuuming large tables that have many deleted tuples.
|
2001-09-21 05:32:36 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2000-11-15 19:36:06 +01:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>VIRTUAL_HOST</varname> (<type>string</type>)</term>
|
2000-11-15 19:36:06 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Specifies the host name or IP address on which the server is
|
|
|
|
to listen for connections from client applications. The
|
|
|
|
default is to listening on all configured addresses (including
|
|
|
|
<systemitem class="systemname">localhost</>).
|
2000-11-15 19:36:06 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2003-03-28 21:17:13 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><varname>ZERO_DAMAGED_PAGES</varname> (<type>boolean</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Detection of a damaged page header normally causes
|
|
|
|
<productname>PostgreSQL</> to report an error, aborting the current
|
|
|
|
transaction. Setting <varname>zero_damaged_pages</> to true causes
|
|
|
|
the system to instead report a warning, zero out the damaged page,
|
|
|
|
and continue processing. This behavior <emphasis>will lose data</>,
|
|
|
|
namely all the rows on the damaged page. But it allows you to get
|
|
|
|
past the error and retrieve rows from any undamaged pages that may
|
|
|
|
be present in the table. So it is useful for recovering data if
|
|
|
|
corruption has occurred due to hardware or software error. The
|
|
|
|
default setting is off, and it can only be changed by a superuser.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
1999-05-20 07:39:29 +02:00
|
|
|
</variablelist>
|
|
|
|
</sect2>
|
2000-06-18 23:24:54 +02:00
|
|
|
|
2001-01-25 00:15:19 +01:00
|
|
|
<sect2 id="runtime-config-wal">
|
|
|
|
<title>WAL</title>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
See also <xref linkend="wal-configuration"> for details on WAL
|
|
|
|
tuning.
|
|
|
|
|
|
|
|
<variablelist>
|
XLOG (and related) changes:
* Store two past checkpoint locations, not just one, in pg_control.
On startup, we fall back to the older checkpoint if the newer one
is unreadable. Also, a physical copy of the newest checkpoint record
is kept in pg_control for possible use in disaster recovery (ie,
complete loss of pg_xlog). Also add a version number for pg_control
itself. Remove archdir from pg_control; it ought to be a GUC
parameter, not a special case (not that it's implemented yet anyway).
* Suppress successive checkpoint records when nothing has been entered
in the WAL log since the last one. This is not so much to avoid I/O
as to make it actually useful to keep track of the last two
checkpoints. If the things are right next to each other then there's
not a lot of redundancy gained...
* Change CRC scheme to a true 64-bit CRC, not a pair of 32-bit CRCs
on alternate bytes. Polynomial borrowed from ECMA DLT1 standard.
* Fix XLOG record length handling so that it will work at BLCKSZ = 32k.
* Change XID allocation to work more like OID allocation. (This is of
dubious necessity, but I think it's a good idea anyway.)
* Fix a number of minor bugs, such as off-by-one logic for XLOG file
wraparound at the 4 gig mark.
* Add documentation and clean up some coding infelicities; move file
format declarations out to include files where planned contrib
utilities can get at them.
* Checkpoint will now occur every CHECKPOINT_SEGMENTS log segments or
every CHECKPOINT_TIMEOUT seconds, whichever comes first. It is also
possible to force a checkpoint by sending SIGUSR1 to the postmaster
(undocumented feature...)
* Defend against kill -9 postmaster by storing shmem block's key and ID
in postmaster.pid lockfile, and checking at startup to ensure that no
processes are still connected to old shmem block (if it still exists).
* Switch backends to accept SIGQUIT rather than SIGUSR1 for emergency
stop, for symmetry with postmaster and xlog utilities. Clean up signal
handling in bootstrap.c so that xlog utilities launched by postmaster
will react to signals better.
* Standalone bootstrap now grabs lockfile in target directory, as added
insurance against running it in parallel with live postmaster.
2001-03-13 02:17:06 +01:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>CHECKPOINT_SEGMENTS</varname> (<type>integer</type>)</term>
|
XLOG (and related) changes:
* Store two past checkpoint locations, not just one, in pg_control.
On startup, we fall back to the older checkpoint if the newer one
is unreadable. Also, a physical copy of the newest checkpoint record
is kept in pg_control for possible use in disaster recovery (ie,
complete loss of pg_xlog). Also add a version number for pg_control
itself. Remove archdir from pg_control; it ought to be a GUC
parameter, not a special case (not that it's implemented yet anyway).
* Suppress successive checkpoint records when nothing has been entered
in the WAL log since the last one. This is not so much to avoid I/O
as to make it actually useful to keep track of the last two
checkpoints. If the things are right next to each other then there's
not a lot of redundancy gained...
* Change CRC scheme to a true 64-bit CRC, not a pair of 32-bit CRCs
on alternate bytes. Polynomial borrowed from ECMA DLT1 standard.
* Fix XLOG record length handling so that it will work at BLCKSZ = 32k.
* Change XID allocation to work more like OID allocation. (This is of
dubious necessity, but I think it's a good idea anyway.)
* Fix a number of minor bugs, such as off-by-one logic for XLOG file
wraparound at the 4 gig mark.
* Add documentation and clean up some coding infelicities; move file
format declarations out to include files where planned contrib
utilities can get at them.
* Checkpoint will now occur every CHECKPOINT_SEGMENTS log segments or
every CHECKPOINT_TIMEOUT seconds, whichever comes first. It is also
possible to force a checkpoint by sending SIGUSR1 to the postmaster
(undocumented feature...)
* Defend against kill -9 postmaster by storing shmem block's key and ID
in postmaster.pid lockfile, and checking at startup to ensure that no
processes are still connected to old shmem block (if it still exists).
* Switch backends to accept SIGQUIT rather than SIGUSR1 for emergency
stop, for symmetry with postmaster and xlog utilities. Clean up signal
handling in bootstrap.c so that xlog utilities launched by postmaster
will react to signals better.
* Standalone bootstrap now grabs lockfile in target directory, as added
insurance against running it in parallel with live postmaster.
2001-03-13 02:17:06 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2001-09-10 01:52:12 +02:00
|
|
|
Maximum distance between automatic WAL checkpoints, in log file
|
XLOG (and related) changes:
* Store two past checkpoint locations, not just one, in pg_control.
On startup, we fall back to the older checkpoint if the newer one
is unreadable. Also, a physical copy of the newest checkpoint record
is kept in pg_control for possible use in disaster recovery (ie,
complete loss of pg_xlog). Also add a version number for pg_control
itself. Remove archdir from pg_control; it ought to be a GUC
parameter, not a special case (not that it's implemented yet anyway).
* Suppress successive checkpoint records when nothing has been entered
in the WAL log since the last one. This is not so much to avoid I/O
as to make it actually useful to keep track of the last two
checkpoints. If the things are right next to each other then there's
not a lot of redundancy gained...
* Change CRC scheme to a true 64-bit CRC, not a pair of 32-bit CRCs
on alternate bytes. Polynomial borrowed from ECMA DLT1 standard.
* Fix XLOG record length handling so that it will work at BLCKSZ = 32k.
* Change XID allocation to work more like OID allocation. (This is of
dubious necessity, but I think it's a good idea anyway.)
* Fix a number of minor bugs, such as off-by-one logic for XLOG file
wraparound at the 4 gig mark.
* Add documentation and clean up some coding infelicities; move file
format declarations out to include files where planned contrib
utilities can get at them.
* Checkpoint will now occur every CHECKPOINT_SEGMENTS log segments or
every CHECKPOINT_TIMEOUT seconds, whichever comes first. It is also
possible to force a checkpoint by sending SIGUSR1 to the postmaster
(undocumented feature...)
* Defend against kill -9 postmaster by storing shmem block's key and ID
in postmaster.pid lockfile, and checking at startup to ensure that no
processes are still connected to old shmem block (if it still exists).
* Switch backends to accept SIGQUIT rather than SIGUSR1 for emergency
stop, for symmetry with postmaster and xlog utilities. Clean up signal
handling in bootstrap.c so that xlog utilities launched by postmaster
will react to signals better.
* Standalone bootstrap now grabs lockfile in target directory, as added
insurance against running it in parallel with live postmaster.
2001-03-13 02:17:06 +01:00
|
|
|
segments (each segment is normally 16 megabytes).
|
|
|
|
This option can only be set at server start or in the
|
|
|
|
<filename>postgresql.conf</filename> file.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2001-01-25 00:15:19 +01:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>CHECKPOINT_TIMEOUT</varname> (<type>integer</type>)</term>
|
2001-01-25 00:15:19 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
XLOG (and related) changes:
* Store two past checkpoint locations, not just one, in pg_control.
On startup, we fall back to the older checkpoint if the newer one
is unreadable. Also, a physical copy of the newest checkpoint record
is kept in pg_control for possible use in disaster recovery (ie,
complete loss of pg_xlog). Also add a version number for pg_control
itself. Remove archdir from pg_control; it ought to be a GUC
parameter, not a special case (not that it's implemented yet anyway).
* Suppress successive checkpoint records when nothing has been entered
in the WAL log since the last one. This is not so much to avoid I/O
as to make it actually useful to keep track of the last two
checkpoints. If the things are right next to each other then there's
not a lot of redundancy gained...
* Change CRC scheme to a true 64-bit CRC, not a pair of 32-bit CRCs
on alternate bytes. Polynomial borrowed from ECMA DLT1 standard.
* Fix XLOG record length handling so that it will work at BLCKSZ = 32k.
* Change XID allocation to work more like OID allocation. (This is of
dubious necessity, but I think it's a good idea anyway.)
* Fix a number of minor bugs, such as off-by-one logic for XLOG file
wraparound at the 4 gig mark.
* Add documentation and clean up some coding infelicities; move file
format declarations out to include files where planned contrib
utilities can get at them.
* Checkpoint will now occur every CHECKPOINT_SEGMENTS log segments or
every CHECKPOINT_TIMEOUT seconds, whichever comes first. It is also
possible to force a checkpoint by sending SIGUSR1 to the postmaster
(undocumented feature...)
* Defend against kill -9 postmaster by storing shmem block's key and ID
in postmaster.pid lockfile, and checking at startup to ensure that no
processes are still connected to old shmem block (if it still exists).
* Switch backends to accept SIGQUIT rather than SIGUSR1 for emergency
stop, for symmetry with postmaster and xlog utilities. Clean up signal
handling in bootstrap.c so that xlog utilities launched by postmaster
will react to signals better.
* Standalone bootstrap now grabs lockfile in target directory, as added
insurance against running it in parallel with live postmaster.
2001-03-13 02:17:06 +01:00
|
|
|
Maximum time between automatic WAL checkpoints, in seconds.
|
|
|
|
This option can only be set at server start or in the
|
|
|
|
<filename>postgresql.conf</filename> file.
|
2001-01-25 00:15:19 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2002-11-15 03:44:57 +01:00
|
|
|
<varlistentry>
|
|
|
|
<term><varname>CHECKPOINT_WARNING</varname> (<type>integer</type>)</term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Send a message to the server logs if checkpoints caused by the
|
|
|
|
filling of checkpoint segment files happens more frequently than
|
|
|
|
this number of seconds. Zero turns off the warning.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2001-05-05 01:11:37 +02:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>COMMIT_DELAY</varname> (<type>integer</type>)</term>
|
2001-05-05 01:11:37 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Time delay between writing a commit record to the WAL buffer and
|
2002-03-09 06:11:38 +01:00
|
|
|
flushing the buffer out to disk, in microseconds. A nonzero
|
|
|
|
delay allows multiple transactions to be committed with only one
|
|
|
|
<function>fsync</function> system call, if system load is high
|
|
|
|
enough additional transactions may become ready to commit within
|
|
|
|
the given interval. But the delay is just wasted if no other
|
|
|
|
transactions become ready to commit. Therefore, the delay is
|
2002-11-11 21:14:04 +01:00
|
|
|
only performed if at least <varname>COMMIT_SIBLINGS</varname> other transactions
|
2003-03-24 15:32:51 +01:00
|
|
|
are active at the instant that a server process has written its commit
|
2002-03-09 06:11:38 +01:00
|
|
|
record.
|
2001-05-05 01:11:37 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>COMMIT_SIBLINGS</varname> (<type>integer</type>)</term>
|
2001-05-05 01:11:37 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Minimum number of concurrent open transactions to require before
|
2002-03-09 06:11:38 +01:00
|
|
|
performing the <varname>COMMIT_DELAY</> delay. A larger value
|
|
|
|
makes it more probable that at least one other transaction will
|
|
|
|
become ready to commit during the delay interval.
|
2001-05-05 01:11:37 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2001-01-25 00:15:19 +01:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>WAL_BUFFERS</varname> (<type>integer</type>)</term>
|
2001-01-25 00:15:19 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-01-11 06:04:14 +01:00
|
|
|
Number of disk-page buffers in shared memory for WAL
|
|
|
|
logging. The default is 4. This option can only be set at
|
|
|
|
server start.
|
2001-01-25 00:15:19 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>WAL_DEBUG</varname> (<type>integer</type>)</term>
|
2001-01-25 00:15:19 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
If nonzero, turn on WAL-related debugging output to the server log.
|
2001-01-25 00:15:19 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2001-03-16 06:44:33 +01:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><varname>WAL_SYNC_METHOD</varname> (<type>string</type>)</term>
|
2001-03-16 06:44:33 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Method used for forcing WAL updates out to disk. Possible
|
|
|
|
values are
|
2002-01-20 23:19:57 +01:00
|
|
|
<literal>FSYNC</> (call <function>fsync()</> at each commit),
|
|
|
|
<literal>FDATASYNC</> (call <function>fdatasync()</> at each commit),
|
2003-03-24 15:32:51 +01:00
|
|
|
<literal>OPEN_SYNC</> (write WAL files with <function>open()</> option <symbol>O_SYNC</>), and
|
2002-01-20 23:19:57 +01:00
|
|
|
<literal>OPEN_DATASYNC</> (write WAL files with <function>open()</> option <symbol>O_DSYNC</>).
|
2001-03-16 06:44:33 +01:00
|
|
|
Not all of these choices are available on all platforms.
|
|
|
|
This option can only be set at server start or in the
|
|
|
|
<filename>postgresql.conf</filename> file.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2001-01-25 00:15:19 +01:00
|
|
|
</variablelist>
|
|
|
|
</para>
|
|
|
|
</sect2>
|
|
|
|
|
|
|
|
|
2002-11-11 21:14:04 +01:00
|
|
|
<sect2 id="runtime-config-short">
|
|
|
|
<title>Short Options</title>
|
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
For convenience there are also single letter command-line option switches
|
|
|
|
available for some parameters. They are described in <xref
|
2002-11-11 21:14:04 +01:00
|
|
|
linkend="runtime-config-short-table">.
|
|
|
|
</para>
|
2000-06-18 23:24:54 +02:00
|
|
|
|
2002-11-11 21:14:04 +01:00
|
|
|
<table id="runtime-config-short-table">
|
2000-06-18 23:24:54 +02:00
|
|
|
<title>Short option key</title>
|
2002-11-11 21:14:04 +01:00
|
|
|
<tgroup cols="2">
|
2000-06-18 23:24:54 +02:00
|
|
|
<thead>
|
|
|
|
<row>
|
|
|
|
<entry>Short option</entry>
|
|
|
|
<entry>Equivalent</entry>
|
|
|
|
</row>
|
|
|
|
</thead>
|
2002-11-11 21:14:04 +01:00
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<tbody>
|
|
|
|
<row>
|
2001-09-10 01:52:12 +02:00
|
|
|
<entry><option>-B <replaceable>x</replaceable></option></entry>
|
|
|
|
<entry><literal>shared_buffers = <replaceable>x</replaceable></></entry>
|
2000-06-18 23:24:54 +02:00
|
|
|
</row>
|
|
|
|
<row>
|
2001-09-10 01:52:12 +02:00
|
|
|
<entry><option>-d <replaceable>x</replaceable></option></entry>
|
2002-11-15 00:53:27 +01:00
|
|
|
<entry><literal>log_min_messages = DEBUG<replaceable>x</replaceable></></entry>
|
2000-06-18 23:24:54 +02:00
|
|
|
</row>
|
|
|
|
<row>
|
2001-09-10 01:52:12 +02:00
|
|
|
<entry><option>-F</option></entry>
|
|
|
|
<entry><literal>fsync = off</></entry>
|
2000-06-18 23:24:54 +02:00
|
|
|
</row>
|
2000-11-15 19:36:06 +01:00
|
|
|
<row>
|
2001-09-10 01:52:12 +02:00
|
|
|
<entry><option>-h <replaceable>x</replaceable></option></entry>
|
|
|
|
<entry><literal>virtual_host = <replaceable>x</replaceable></></entry>
|
2000-11-15 19:36:06 +01:00
|
|
|
</row>
|
2000-06-18 23:24:54 +02:00
|
|
|
<row>
|
2001-09-10 01:52:12 +02:00
|
|
|
<entry><option>-i</option></entry>
|
|
|
|
<entry><literal>tcpip_socket = on</></entry>
|
2000-12-01 00:20:51 +01:00
|
|
|
</row>
|
|
|
|
<row>
|
2001-09-10 01:52:12 +02:00
|
|
|
<entry><option>-k <replaceable>x</replaceable></option></entry>
|
|
|
|
<entry><literal>unix_socket_directory = <replaceable>x</replaceable></></entry>
|
2000-06-18 23:24:54 +02:00
|
|
|
</row>
|
2000-09-06 21:54:52 +02:00
|
|
|
<row>
|
2001-09-10 01:52:12 +02:00
|
|
|
<entry><option>-l</option></entry>
|
|
|
|
<entry><literal>ssl = on</></entry>
|
2000-09-06 21:54:52 +02:00
|
|
|
</row>
|
2000-06-18 23:24:54 +02:00
|
|
|
<row>
|
2001-09-10 01:52:12 +02:00
|
|
|
<entry><option>-N <replaceable>x</replaceable></option></entry>
|
|
|
|
<entry><literal>max_connections = <replaceable>x</replaceable></></entry>
|
2000-06-18 23:24:54 +02:00
|
|
|
</row>
|
|
|
|
<row>
|
2001-09-10 01:52:12 +02:00
|
|
|
<entry><option>-p <replaceable>x</replaceable></option></entry>
|
|
|
|
<entry><literal>port = <replaceable>x</replaceable></></entry>
|
2000-06-18 23:24:54 +02:00
|
|
|
</row>
|
|
|
|
|
|
|
|
<row>
|
2002-11-11 21:14:04 +01:00
|
|
|
<entry>
|
|
|
|
<option>-fi</option>, <option>-fh</option>,
|
|
|
|
<option>-fm</option>, <option>-fn</option>,
|
|
|
|
<option>-fs</option>, <option>-ft</option><footnote
|
|
|
|
id="fn.runtime-config-short">
|
|
|
|
<para>
|
|
|
|
For historical reasons, these options must be passed to
|
2003-03-24 15:32:51 +01:00
|
|
|
the individual server process via the <option>-o</option>
|
|
|
|
<command>postmaster</command> option, for example,
|
2002-11-11 21:14:04 +01:00
|
|
|
<screen>
|
|
|
|
$ <userinput>postmaster -o '-S 1024 -s'</userinput>
|
|
|
|
</screen>
|
|
|
|
or via <envar>PGOPTIONS</envar> from the client side, as
|
|
|
|
explained above.
|
|
|
|
</para>
|
|
|
|
</footnote>
|
|
|
|
</entry>
|
|
|
|
<entry>
|
|
|
|
<literal>enable_indexscan=off</>,
|
|
|
|
<literal>enable_hashjoin=off</>,
|
|
|
|
<literal>enable_mergejoin=off</>,
|
|
|
|
<literal>enable_nestloop=off</>,
|
|
|
|
<literal>enable_seqscan=off</>,
|
|
|
|
<literal>enable_tidscan=off</>
|
|
|
|
</entry>
|
2000-06-18 23:24:54 +02:00
|
|
|
</row>
|
2002-11-11 21:14:04 +01:00
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<row>
|
2002-11-11 21:14:04 +01:00
|
|
|
<entry><option>-s</option><footnoteref linkend="fn.runtime-config-short"></entry>
|
|
|
|
<entry><literal>show_statement_stats = on</></entry>
|
2000-06-18 23:24:54 +02:00
|
|
|
</row>
|
2002-11-11 21:14:04 +01:00
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<row>
|
2002-11-11 21:14:04 +01:00
|
|
|
<entry><option>-S <replaceable>x</replaceable></option><footnoteref linkend="fn.runtime-config-short">
|
|
|
|
</entry>
|
|
|
|
<entry><literal>sort_mem = <replaceable>x</replaceable></></entry>
|
2000-06-18 23:24:54 +02:00
|
|
|
</row>
|
2002-11-11 21:14:04 +01:00
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<row>
|
2002-11-11 21:14:04 +01:00
|
|
|
<entry><option>-tpa</option>, <option>-tpl</option>, <option>-te</option><footnoteref linkend="fn.runtime-config-short"></entry>
|
2002-11-15 01:47:22 +01:00
|
|
|
<entry><literal>log_parser_stats=on</>,
|
|
|
|
<literal>log_planner_stats=on</>,
|
|
|
|
<literal>log_executor_stats=on</></entry>
|
2000-06-18 23:24:54 +02:00
|
|
|
</row>
|
|
|
|
</tbody>
|
|
|
|
</tgroup>
|
|
|
|
</table>
|
|
|
|
|
2002-11-11 21:14:04 +01:00
|
|
|
</sect2>
|
2000-06-18 23:24:54 +02:00
|
|
|
</sect1>
|
|
|
|
|
2000-07-15 23:35:47 +02:00
|
|
|
|
2000-07-22 16:49:01 +02:00
|
|
|
<sect1 id="kernel-resources">
|
|
|
|
<title>Managing Kernel Resources</title>
|
|
|
|
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
A large <productname>PostgreSQL</> installation can quickly exhaust
|
2000-07-22 16:49:01 +02:00
|
|
|
various operating system resource limits. (On some systems, the
|
|
|
|
factory defaults are so low that you don't even need a really
|
|
|
|
<quote>large</> installation.) If you have encountered this kind of
|
2002-03-09 06:11:38 +01:00
|
|
|
problem, keep reading.
|
2000-07-22 16:49:01 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<sect2 id="sysvipc">
|
|
|
|
<title>Shared Memory and Semaphores</title>
|
|
|
|
|
2001-05-13 00:51:36 +02:00
|
|
|
<indexterm zone="sysvipc">
|
|
|
|
<primary>shared memory</primary>
|
|
|
|
</indexterm>
|
|
|
|
|
|
|
|
<indexterm zone="sysvipc">
|
|
|
|
<primary>semaphores</primary>
|
|
|
|
</indexterm>
|
|
|
|
|
2000-07-22 16:49:01 +02:00
|
|
|
<para>
|
|
|
|
Shared memory and semaphores are collectively referred to as
|
2002-03-09 06:11:38 +01:00
|
|
|
<quote><systemitem class="osname">System V</>
|
|
|
|
<acronym>IPC</></quote> (together with message queues, which are not
|
|
|
|
relevant for <productname>PostgreSQL</>). Almost all modern
|
2000-07-22 16:49:01 +02:00
|
|
|
operating systems provide these features, but not all of them have
|
2002-03-09 06:11:38 +01:00
|
|
|
them turned on or sufficiently sized by default, especially systems
|
|
|
|
with BSD heritage. (For the <systemitem class="osname">QNX</> and
|
|
|
|
<systemitem class="osname">BeOS</> ports, <productname>PostgreSQL</>
|
|
|
|
provides its own replacement implementation of these facilities.)
|
2000-07-22 16:49:01 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
The complete lack of these facilities is usually manifested by an
|
2003-03-24 15:32:51 +01:00
|
|
|
<errorname>Illegal system call</> error upon server start. In
|
2000-07-22 16:49:01 +02:00
|
|
|
that case there's nothing left to do but to reconfigure your
|
2003-03-24 15:32:51 +01:00
|
|
|
kernel. <productname>PostgreSQL</> won't work without them.
|
2000-07-22 16:49:01 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2001-11-21 07:09:45 +01:00
|
|
|
When <productname>PostgreSQL</> exceeds one of the various hard
|
2003-03-24 15:32:51 +01:00
|
|
|
<acronym>IPC</> limits, the server will refuse to start and
|
2002-03-09 06:11:38 +01:00
|
|
|
should leave an instructive error message describing the problem
|
|
|
|
encountered and what to do about it. (See also <xref
|
|
|
|
linkend="postmaster-start-failures">.) The relevant kernel
|
|
|
|
parameters are named consistently across different systems; <xref
|
|
|
|
linkend="sysvipc-parameters"> gives an overview. The methods to set
|
|
|
|
them, however, vary. Suggestions for some platforms are given below.
|
|
|
|
Be warned that it is often necessary to reboot your machine, and
|
|
|
|
possibly even recompile the kernel, to change these settings.
|
2000-07-22 16:49:01 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
|
|
<table id="sysvipc-parameters">
|
2001-09-10 01:52:12 +02:00
|
|
|
<title><systemitem class="osname">System V</> <acronym>IPC</> parameters</>
|
2000-07-22 16:49:01 +02:00
|
|
|
|
|
|
|
<tgroup cols="3">
|
|
|
|
<thead>
|
|
|
|
<row>
|
|
|
|
<entry>Name</>
|
|
|
|
<entry>Description</>
|
|
|
|
<entry>Reasonable values</>
|
|
|
|
</row>
|
|
|
|
</thead>
|
|
|
|
|
|
|
|
<tbody>
|
|
|
|
<row>
|
|
|
|
<entry><varname>SHMMAX</></>
|
|
|
|
<entry>Maximum size of shared memory segment (bytes)</>
|
2003-03-24 15:32:51 +01:00
|
|
|
<entry>250 kB + 8.2 kB * <varname>shared_buffers</> + 14.2 kB * <varname>max_connections</> up to infinity</entry>
|
2000-07-22 16:49:01 +02:00
|
|
|
</row>
|
|
|
|
|
|
|
|
<row>
|
|
|
|
<entry><varname>SHMMIN</></>
|
|
|
|
<entry>Minimum size of shared memory segment (bytes)</>
|
2001-05-03 19:28:13 +02:00
|
|
|
<entry>1</>
|
2000-07-22 16:49:01 +02:00
|
|
|
</row>
|
|
|
|
|
2001-05-02 19:04:53 +02:00
|
|
|
<row>
|
|
|
|
<entry><varname>SHMALL</></>
|
|
|
|
<entry>Total amount of shared memory available (bytes or pages)</>
|
2001-09-10 01:52:12 +02:00
|
|
|
<entry>if bytes, same as <varname>SHMMAX</varname>; if pages, <literal>ceil(SHMMAX/PAGE_SIZE)</literal></>
|
2001-05-02 19:04:53 +02:00
|
|
|
</row>
|
|
|
|
|
2000-07-22 16:49:01 +02:00
|
|
|
<row>
|
|
|
|
<entry><varname>SHMSEG</></>
|
|
|
|
<entry>Maximum number of shared memory segments per process</>
|
2000-12-17 12:22:00 +01:00
|
|
|
<entry>only 1 segment is needed, but the default is much higher</>
|
2000-07-22 16:49:01 +02:00
|
|
|
</row>
|
|
|
|
|
|
|
|
<row>
|
|
|
|
<entry><varname>SHMMNI</></>
|
|
|
|
<entry>Maximum number of shared memory segments system-wide</>
|
2001-05-03 19:28:13 +02:00
|
|
|
<entry>like <varname>SHMSEG</> plus room for other applications</>
|
2000-07-22 16:49:01 +02:00
|
|
|
</row>
|
|
|
|
|
|
|
|
<row>
|
|
|
|
<entry><varname>SEMMNI</></>
|
|
|
|
<entry>Maximum number of semaphore identifiers (i.e., sets)</>
|
2003-03-24 15:32:51 +01:00
|
|
|
<entry>at least <literal>ceil(max_connections / 16)</literal></>
|
2000-07-22 16:49:01 +02:00
|
|
|
</row>
|
|
|
|
|
|
|
|
<row>
|
|
|
|
<entry><varname>SEMMNS</></>
|
|
|
|
<entry>Maximum number of semaphores system-wide</>
|
2003-03-24 15:32:51 +01:00
|
|
|
<entry><literal>ceil(max_connections / 16) * 17</literal> plus room for other applications</>
|
2000-07-22 16:49:01 +02:00
|
|
|
</row>
|
|
|
|
|
|
|
|
<row>
|
|
|
|
<entry><varname>SEMMSL</></>
|
|
|
|
<entry>Maximum number of semaphores per set</>
|
2003-03-24 15:32:51 +01:00
|
|
|
<entry>at least 17</>
|
2000-07-22 16:49:01 +02:00
|
|
|
</row>
|
|
|
|
|
|
|
|
<row>
|
|
|
|
<entry><varname>SEMMAP</></>
|
|
|
|
<entry>Number of entries in semaphore map</>
|
|
|
|
<entry>see text</>
|
|
|
|
</row>
|
|
|
|
|
|
|
|
<row>
|
|
|
|
<entry><varname>SEMVMX</></>
|
|
|
|
<entry>Maximum value of semaphore</>
|
2003-03-24 15:32:51 +01:00
|
|
|
<entry>at least 255 (The default is often 32767, don't change unless asked to.)</>
|
2000-07-22 16:49:01 +02:00
|
|
|
</row>
|
|
|
|
|
|
|
|
</tbody>
|
|
|
|
</tgroup>
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
<indexterm><primary>SHMMAX</primary></indexterm> The most important
|
|
|
|
shared memory parameter is <varname>SHMMAX</>, the maximum size, in
|
|
|
|
bytes, of a shared memory segment. If you get an error message from
|
|
|
|
<function>shmget</> like <errorname>Invalid argument</>, it is
|
|
|
|
possible that this limit has been exceeded. The size of the required
|
|
|
|
shared memory segment varies both with the number of requested
|
|
|
|
buffers (<option>-B</> option) and the number of allowed connections
|
|
|
|
(<option>-N</> option), although the former is the most significant.
|
|
|
|
(You can, as a temporary solution, lower these settings to eliminate
|
|
|
|
the failure.) As a rough approximation, you can estimate the
|
|
|
|
required segment size by multiplying the number of buffers and the
|
|
|
|
block size (8 kB by default) plus ample overhead (at least half a
|
|
|
|
megabyte). Any error message you might get will contain the size of
|
|
|
|
the failed allocation request.
|
2000-07-22 16:49:01 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
Less likely to cause problems is the minimum size for shared
|
2000-12-17 12:22:00 +01:00
|
|
|
memory segments (<varname>SHMMIN</>), which should be at most
|
2002-03-09 06:11:38 +01:00
|
|
|
approximately 256 kB for <productname>PostgreSQL</> (it is
|
2000-12-17 12:22:00 +01:00
|
|
|
usually just 1). The maximum number of segments system-wide
|
|
|
|
(<varname>SHMMNI</>) or per-process (<varname>SHMSEG</>) should
|
|
|
|
not cause a problem unless your system has them set to zero. Some
|
|
|
|
systems also have a limit on the total amount of shared memory in
|
|
|
|
the system; see the platform-specific instructions below.
|
2000-07-22 16:49:01 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2001-11-21 07:09:45 +01:00
|
|
|
<productname>PostgreSQL</> uses one semaphore per allowed connection
|
2000-12-17 12:22:00 +01:00
|
|
|
(<option>-N</> option), in sets of 16. Each such set will also
|
|
|
|
contain a 17th semaphore which contains a <quote>magic
|
2001-09-07 02:46:42 +02:00
|
|
|
number</quote>, to detect collision with semaphore sets used by
|
2000-12-17 12:22:00 +01:00
|
|
|
other applications. The maximum number of semaphores in the system
|
|
|
|
is set by <varname>SEMMNS</>, which consequently must be at least
|
|
|
|
as high as the connection setting plus one extra for each 16
|
|
|
|
allowed connections (see the formula in <xref
|
2001-03-24 01:24:26 +01:00
|
|
|
linkend="sysvipc-parameters">). The parameter <varname>SEMMNI</>
|
2000-12-17 12:22:00 +01:00
|
|
|
determines the limit on the number of semaphore sets that can
|
|
|
|
exist on the system at one time. Hence this parameter must be at
|
|
|
|
least <literal>ceil(max_connections / 16)</>. Lowering the number
|
|
|
|
of allowed connections is a temporary workaround for failures,
|
2003-03-24 15:32:51 +01:00
|
|
|
which are usually confusingly worded <errorname>No space
|
|
|
|
left on device</>, from the function <function>semget</>.
|
2000-07-22 16:49:01 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
In some cases it might also be necessary to increase
|
2000-07-22 16:49:01 +02:00
|
|
|
<varname>SEMMAP</> to be at least on the order of
|
2002-03-09 06:11:38 +01:00
|
|
|
<varname>SEMMNS</>. This parameter defines the size of the semaphore
|
|
|
|
resource map, in which each contiguous block of available semaphores
|
|
|
|
needs an entry. When a semaphore set is freed it is either added to
|
|
|
|
an existing entry that is adjacent to the freed block or it is
|
|
|
|
registered under a new map entry. If the map is full, the freed
|
|
|
|
semaphores get lost (until reboot). Fragmentation of the semaphore
|
|
|
|
space could over time lead to fewer available semaphores than there
|
|
|
|
should be.
|
2000-07-22 16:49:01 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
The <varname>SEMMSL</> parameter, which determines how many
|
2000-12-17 12:22:00 +01:00
|
|
|
semaphores can be in a set, must be at least 17 for
|
2001-11-21 07:09:45 +01:00
|
|
|
<productname>PostgreSQL</>.
|
2000-07-22 16:49:01 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2000-11-10 17:32:09 +01:00
|
|
|
Various other settings related to <quote>semaphore undo</>, such as
|
|
|
|
<varname>SEMMNU</> and <varname>SEMUME</>, are not of concern
|
2001-11-21 07:09:45 +01:00
|
|
|
for <productname>PostgreSQL</>.
|
2000-07-22 16:49:01 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
|
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><systemitem class="osname">BSD/OS</></term>
|
2001-11-12 20:19:39 +01:00
|
|
|
<indexterm><primary>BSD/OS</></>
|
2000-07-22 16:49:01 +02:00
|
|
|
<listitem>
|
|
|
|
<formalpara>
|
|
|
|
<title>Shared Memory</>
|
|
|
|
<para>
|
|
|
|
By default, only 4 MB of shared memory is supported. Keep in
|
|
|
|
mind that shared memory is not pageable; it is locked in RAM.
|
2003-03-24 15:32:51 +01:00
|
|
|
To increase the amount of shared memory supported by your
|
|
|
|
system, add the following to your kernel configuration
|
2002-11-11 21:14:04 +01:00
|
|
|
file. A <varname>SHMALL</> value of 1024 represents 4 MB of
|
2002-03-09 06:11:38 +01:00
|
|
|
shared memory. The following increases the maximum shared
|
|
|
|
memory area to 32 MB:
|
2000-07-22 16:49:01 +02:00
|
|
|
<programlisting>
|
2001-05-02 19:04:53 +02:00
|
|
|
options "SHMALL=8192"
|
2001-02-16 17:10:06 +01:00
|
|
|
options "SHMMAX=\(SHMALL*PAGE_SIZE\)"
|
2000-07-22 16:49:01 +02:00
|
|
|
</programlisting>
|
2003-03-24 15:32:51 +01:00
|
|
|
For those running 4.1 or later, just make the above changes,
|
|
|
|
recompile the kernel, and reboot.
|
2000-07-22 16:49:01 +02:00
|
|
|
</para>
|
|
|
|
</formalpara>
|
|
|
|
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
For those running earlier releases, use <command>bpatch</> to
|
|
|
|
find the <varname>sysptsize</> value in the current
|
|
|
|
kernel. This is computed dynamically at boot time.
|
2000-07-22 16:49:01 +02:00
|
|
|
<screen>
|
|
|
|
$ <userinput>bpatch -r sysptsize</>
|
|
|
|
<computeroutput>0x9 = 9</>
|
|
|
|
</screen>
|
2001-05-02 19:04:53 +02:00
|
|
|
Next, add <varname>SYSPTSIZE</> as a hard-coded value in the
|
2001-09-10 01:52:12 +02:00
|
|
|
kernel configuration file. Increase the value you found using
|
2003-03-24 15:32:51 +01:00
|
|
|
<command>bpatch</>. Add 1 for every additional 4 MB of
|
2000-07-22 16:49:01 +02:00
|
|
|
shared memory you desire.
|
|
|
|
<programlisting>
|
2001-05-02 19:04:53 +02:00
|
|
|
options "SYSPTSIZE=16"
|
2000-07-22 16:49:01 +02:00
|
|
|
</programlisting>
|
2001-09-10 01:52:12 +02:00
|
|
|
<varname>sysptsize</> cannot be changed by <command>sysctl</command>.
|
2000-07-22 16:49:01 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<formalpara>
|
|
|
|
<title>Semaphores</>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
You may need to increase the number of semaphores. By
|
|
|
|
default, <productname>PostgreSQL</> allocates 34 semaphores,
|
|
|
|
which is over half the default system total of 60. Set the
|
|
|
|
values you want in your kernel configuration file, e.g.:
|
2000-07-22 16:49:01 +02:00
|
|
|
<programlisting>
|
|
|
|
options "SEMMNI=40"
|
|
|
|
options "SEMMNS=240"
|
|
|
|
</programlisting>
|
2003-03-24 15:32:51 +01:00
|
|
|
</para>
|
|
|
|
</formalpara>
|
2000-07-22 16:49:01 +02:00
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><systemitem class="osname">FreeBSD</></term>
|
|
|
|
<term><systemitem class="osname">NetBSD</></term>
|
|
|
|
<term><systemitem class="osname">OpenBSD</></term>
|
2001-11-12 20:19:39 +01:00
|
|
|
<indexterm><primary>FreeBSD</></>
|
|
|
|
<indexterm><primary>NetBSD</></>
|
|
|
|
<indexterm><primary>OpenBSD</></>
|
2000-07-22 16:49:01 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The options <varname>SYSVSHM</> and <varname>SYSVSEM</> need
|
|
|
|
to be enabled when the kernel is compiled. (They are by
|
|
|
|
default.) The maximum size of shared memory is determined by
|
|
|
|
the option <varname>SHMMAXPGS</> (in pages). The following
|
2000-11-10 17:32:09 +01:00
|
|
|
shows an example of how to set the various parameters:
|
2000-07-22 16:49:01 +02:00
|
|
|
<programlisting>
|
2001-01-08 22:01:54 +01:00
|
|
|
options SYSVSHM
|
|
|
|
options SHMMAXPGS=4096
|
|
|
|
options SHMSEG=256
|
|
|
|
|
|
|
|
options SYSVSEM
|
|
|
|
options SEMMNI=256
|
|
|
|
options SEMMNS=512
|
|
|
|
options SEMMNU=256
|
2000-07-22 16:49:01 +02:00
|
|
|
options SEMMAP=256
|
|
|
|
</programlisting>
|
2001-09-10 01:52:12 +02:00
|
|
|
(On <systemitem class="osname">NetBSD</> and <systemitem
|
|
|
|
class="osname">OpenBSD</> the key word is actually
|
2001-08-09 18:20:43 +02:00
|
|
|
<literal>option</literal> singular.)
|
2000-07-22 16:49:01 +02:00
|
|
|
</para>
|
2002-03-09 06:11:38 +01:00
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
You might also want to use the <command>sysctl</> setting to
|
2002-03-09 06:11:38 +01:00
|
|
|
lock shared memory into RAM and prevent it from being paged out
|
2002-11-21 19:19:51 +01:00
|
|
|
to swap, e.g. <literal>kern.ipc.shm_use_phys</>.
|
2002-03-11 06:03:52 +01:00
|
|
|
</para>
|
2000-07-22 16:49:01 +02:00
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><systemitem class="osname">HP-UX</></term>
|
2001-11-12 20:19:39 +01:00
|
|
|
<indexterm><primary>HP-UX</></>
|
2000-07-22 16:49:01 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The default settings tend to suffice for normal installations.
|
2000-12-17 12:22:00 +01:00
|
|
|
On <productname>HP-UX</> 10, the factory default for
|
2000-07-22 16:49:01 +02:00
|
|
|
<varname>SEMMNS</> is 128, which might be too low for larger
|
|
|
|
database sites.
|
|
|
|
</para>
|
|
|
|
<para>
|
2001-09-10 01:52:12 +02:00
|
|
|
<acronym>IPC</> parameters can be set in the <application>System
|
2000-07-22 16:49:01 +02:00
|
|
|
Administration Manager</> (<acronym>SAM</>) under
|
|
|
|
<menuchoice><guimenu>Kernel
|
2002-03-09 06:11:38 +01:00
|
|
|
Configuration</><guimenuitem>Configurable Parameters</></>. Hit
|
|
|
|
<guibutton>Create A New Kernel</> when you're done.
|
2000-07-22 16:49:01 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><systemitem class="osname">Linux</></term>
|
2001-11-12 20:19:39 +01:00
|
|
|
<indexterm><primary>Linux</></>
|
2000-07-22 16:49:01 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2000-12-17 12:22:00 +01:00
|
|
|
The default shared memory limit (both
|
|
|
|
<varname>SHMMAX</varname> and <varname>SHMALL</varname>) is 32
|
|
|
|
MB in 2.2 kernels, but it can be changed in the
|
|
|
|
<filename>proc</filename> file system (without reboot). For
|
|
|
|
example, to allow 128 MB:
|
|
|
|
<screen>
|
|
|
|
<prompt>$</prompt> <userinput>echo 134217728 >/proc/sys/kernel/shmall</userinput>
|
|
|
|
<prompt>$</prompt> <userinput>echo 134217728 >/proc/sys/kernel/shmmax</userinput>
|
|
|
|
</screen>
|
|
|
|
You could put these commands into a script run at boot-time.
|
|
|
|
</para>
|
|
|
|
|
2000-12-30 16:03:09 +01:00
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Alternatively, you can use <command>sysctl</command>, if
|
|
|
|
available, to control these parameters. Look for a file
|
|
|
|
called <filename>/etc/sysctl.conf</filename> and add lines
|
|
|
|
like the following to it:
|
2000-12-30 16:03:09 +01:00
|
|
|
<programlisting>
|
|
|
|
kernel.shmall = 134217728
|
|
|
|
kernel.shmmax = 134217728
|
|
|
|
</programlisting>
|
|
|
|
This file is usually processed at boot time, but
|
2003-03-24 15:32:51 +01:00
|
|
|
<command>sysctl</command> can also be called
|
2000-12-30 16:03:09 +01:00
|
|
|
explicitly later.
|
|
|
|
</para>
|
|
|
|
|
2000-12-17 12:22:00 +01:00
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
Other parameters are sufficiently sized for any application. If
|
|
|
|
you want to see for yourself look in
|
|
|
|
<filename>/usr/src/linux/include/asm-<replaceable>xxx</>/shmpara
|
|
|
|
m.h</> and <filename>/usr/src/linux/include/linux/sem.h</>.
|
2000-07-22 16:49:01 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
2002-11-06 00:16:56 +01:00
|
|
|
<varlistentry>
|
2002-12-09 22:03:30 +01:00
|
|
|
<term><systemitem class="osname">MacOS X</></term>
|
|
|
|
<indexterm><primary>MacOS X</></>
|
2002-11-06 00:16:56 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Edit the file
|
|
|
|
<filename>/System/Library/StartupItems/SystemTuning/SystemTuning
|
2002-12-09 22:03:30 +01:00
|
|
|
</> and change the following values:
|
2002-11-06 00:16:56 +01:00
|
|
|
<programlisting>
|
|
|
|
sysctl -w kern.sysv.shmmax
|
|
|
|
sysctl -w kern.sysv.shmmin
|
|
|
|
sysctl -w kern.sysv.shmmni
|
|
|
|
sysctl -w kern.sysv.shmseg
|
|
|
|
sysctl -w kern.sysv.shmall
|
|
|
|
</programlisting>
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
2000-07-22 16:49:01 +02:00
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><systemitem class="osname">SCO OpenServer</></term>
|
2001-11-12 20:19:39 +01:00
|
|
|
<indexterm><primary>SCO OpenServer</></>
|
2000-07-22 16:49:01 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
In the default configuration, only 512 kB of shared memory per
|
|
|
|
segment is allowed, which is about enough for <option>-B 24 -N
|
2003-03-24 15:32:51 +01:00
|
|
|
12</>. To increase the setting, first change to the directory
|
2000-07-22 16:49:01 +02:00
|
|
|
<filename>/etc/conf/cf.d</>. To display the current value of
|
2003-03-24 15:32:51 +01:00
|
|
|
<varname>SHMMAX</>, run
|
2000-07-22 16:49:01 +02:00
|
|
|
<programlisting>
|
|
|
|
./configure -y SHMMAX
|
|
|
|
</programlisting>
|
2003-03-24 15:32:51 +01:00
|
|
|
To set a new value for <varname>SHMMAX</>, run
|
2000-07-22 16:49:01 +02:00
|
|
|
<programlisting>
|
|
|
|
./configure SHMMAX=<replaceable>value</>
|
|
|
|
</programlisting>
|
|
|
|
where <replaceable>value</> is the new value you want to use
|
2003-03-24 15:32:51 +01:00
|
|
|
(in bytes). After setting <varname>SHMMAX</>, rebuild the kernel:
|
2000-07-22 16:49:01 +02:00
|
|
|
<programlisting>
|
|
|
|
./link_unix
|
|
|
|
</programlisting>
|
|
|
|
and reboot.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><systemitem class="osname">Solaris</></term>
|
2001-11-12 20:19:39 +01:00
|
|
|
<indexterm><primary>Solaris</></>
|
2000-07-22 16:49:01 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
At least in version 2.6, the default maximum size of a shared
|
|
|
|
memory segments is too low for <productname>PostgreSQL</>. The
|
2000-07-22 16:49:01 +02:00
|
|
|
relevant settings can be changed in <filename>/etc/system</>,
|
|
|
|
for example:
|
|
|
|
<programlisting>
|
|
|
|
set shmsys:shminfo_shmmax=0x2000000
|
|
|
|
set shmsys:shminfo_shmmin=1
|
|
|
|
set shmsys:shminfo_shmmni=256
|
|
|
|
set shmsys:shminfo_shmseg=256
|
|
|
|
|
|
|
|
set semsys:seminfo_semmap=256
|
|
|
|
set semsys:seminfo_semmni=512
|
|
|
|
set semsys:seminfo_semmns=512
|
|
|
|
set semsys:seminfo_semmsl=32
|
|
|
|
</programlisting>
|
2002-03-09 06:11:38 +01:00
|
|
|
You need to reboot for the changes to take effect.
|
2000-07-22 16:49:01 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
See also <ulink
|
2001-10-31 21:35:02 +01:00
|
|
|
url="http://www.sunworld.com/swol-09-1997/swol-09-insidesolaris.html"></>
|
2000-07-22 16:49:01 +02:00
|
|
|
for information on shared memory under
|
|
|
|
<productname>Solaris</>.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><systemitem class="osname">UnixWare</></term>
|
2002-01-09 01:52:38 +01:00
|
|
|
<indexterm><primary>UnixWare</></>
|
2000-07-22 16:49:01 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
On <productname>UnixWare</> 7, the maximum size for shared
|
|
|
|
memory segments is 512 kB in the default configuration. This
|
|
|
|
is enough for about <option>-B 24 -N 12</>. To display the
|
|
|
|
current value of <varname>SHMMAX</>, run
|
|
|
|
<programlisting>
|
|
|
|
/etc/conf/bin/idtune -g SHMMAX
|
|
|
|
</programlisting>
|
|
|
|
which displays the current, default, minimum, and maximum
|
2003-03-24 15:32:51 +01:00
|
|
|
values. To set a new value for <varname>SHMMAX</>,
|
|
|
|
run
|
2000-07-22 16:49:01 +02:00
|
|
|
<programlisting>
|
|
|
|
/etc/conf/bin/idtune SHMMAX <replaceable>value</>
|
|
|
|
</programlisting>
|
|
|
|
where <replaceable>value</> is the new value you want to use
|
|
|
|
(in bytes). After setting <varname>SHMMAX</>, rebuild the
|
2003-03-24 15:32:51 +01:00
|
|
|
kernel:
|
2000-07-22 16:49:01 +02:00
|
|
|
<programlisting>
|
|
|
|
/etc/conf/bin/idbuild -B
|
|
|
|
</programlisting>
|
|
|
|
and reboot.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
</variablelist>
|
|
|
|
|
|
|
|
</sect2>
|
|
|
|
|
2001-01-08 22:01:54 +01:00
|
|
|
|
|
|
|
<sect2>
|
|
|
|
<title>Resource Limits</title>
|
|
|
|
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
Unix-like operating systems enforce various kinds of resource limits
|
|
|
|
that might interfere with the operation of your
|
|
|
|
<productname>PostgreSQL</productname> server. Of particular
|
|
|
|
importance are limits on the number of processes per user, the
|
|
|
|
number of open files per process, and the amount of memory available
|
|
|
|
to each process. Each of these have a <quote>hard</quote> and a
|
|
|
|
<quote>soft</quote> limit. The soft limit is what actually counts
|
|
|
|
but it can be changed by the user up to the hard limit. The hard
|
|
|
|
limit can only be changed by the root user. The system call
|
|
|
|
<function>setrlimit</function> is responsible for setting these
|
|
|
|
parameters. The shell's built-in command <command>ulimit</command>
|
|
|
|
(Bourne shells) or <command>limit</command> (<application>csh</>) is
|
|
|
|
used to control the resource limits from the command line. On
|
|
|
|
BSD-derived systems the file <filename>/etc/login.conf</filename>
|
2003-03-24 15:32:51 +01:00
|
|
|
controls the various resource limits set during login. See the
|
|
|
|
operating system documentation for details. The relevant
|
2001-01-08 22:01:54 +01:00
|
|
|
parameters are <varname>maxproc</varname>,
|
2002-03-09 06:11:38 +01:00
|
|
|
<varname>openfiles</varname>, and <varname>datasize</varname>. For
|
|
|
|
example:
|
2001-01-08 22:01:54 +01:00
|
|
|
<programlisting>
|
|
|
|
default:\
|
|
|
|
...
|
|
|
|
:datasize-cur=256M:\
|
|
|
|
:maxproc-cur=256:\
|
|
|
|
:openfiles-cur=256:\
|
|
|
|
...
|
|
|
|
</programlisting>
|
|
|
|
(<literal>-cur</literal> is the soft limit. Append
|
|
|
|
<literal>-max</literal> to set the hard limit.)
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
Kernels can also have system-wide limits on some resources.
|
2001-02-09 21:38:15 +01:00
|
|
|
<itemizedlist>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2001-01-08 22:01:54 +01:00
|
|
|
On <productname>Linux</productname>
|
|
|
|
<filename>/proc/sys/fs/file-max</filename> determines the
|
2001-12-27 22:37:34 +01:00
|
|
|
maximum number of open files that the kernel will support. It can
|
2001-01-08 22:01:54 +01:00
|
|
|
be changed by writing a different number into the file or by
|
|
|
|
adding an assignment in <filename>/etc/sysctl.conf</filename>.
|
|
|
|
The maximum limit of files per process is fixed at the time the
|
|
|
|
kernel is compiled; see
|
|
|
|
<filename>/usr/src/linux/Documentation/proc.txt</filename> for
|
|
|
|
more information.
|
2001-02-09 21:38:15 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</itemizedlist>
|
2001-01-08 22:01:54 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2001-11-21 07:09:45 +01:00
|
|
|
The <productname>PostgreSQL</productname> server uses one process
|
2001-01-08 22:01:54 +01:00
|
|
|
per connection so you should provide for at least as many processes
|
|
|
|
as allowed connections, in addition to what you need for the rest
|
|
|
|
of your system. This is usually not a problem but if you run
|
|
|
|
several servers on one machine things might get tight.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
The factory default limit on open files is often set to
|
|
|
|
<quote>socially friendly</quote> values that allow many users to
|
|
|
|
coexist on a machine without using an inappropriate fraction of
|
|
|
|
the system resources. If you run many servers on a machine this
|
|
|
|
is perhaps what you want, but on dedicated servers you may want to
|
|
|
|
raise this limit.
|
|
|
|
</para>
|
2001-12-27 22:37:34 +01:00
|
|
|
|
|
|
|
<para>
|
|
|
|
On the other side of the coin, some systems allow individual
|
2002-03-09 06:11:38 +01:00
|
|
|
processes to open large numbers of files; if more than a few
|
|
|
|
processes do so then the system-wide limit can easily be exceeded.
|
2003-02-19 05:06:28 +01:00
|
|
|
If you find this happening, and you do not want to alter the system-wide
|
2002-03-09 06:11:38 +01:00
|
|
|
limit, you can set <productname>PostgreSQL</productname>'s
|
|
|
|
<varname>max_files_per_process</varname> configuration parameter to
|
|
|
|
limit the consumption of open files.
|
2001-12-27 22:37:34 +01:00
|
|
|
</para>
|
2001-01-08 22:01:54 +01:00
|
|
|
</sect2>
|
2000-07-22 16:49:01 +02:00
|
|
|
|
|
|
|
</sect1>
|
|
|
|
|
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<sect1 id="postmaster-shutdown">
|
2002-11-11 21:14:04 +01:00
|
|
|
<title>Shutting Down the Server</title>
|
2000-06-18 23:24:54 +02:00
|
|
|
|
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
There are several ways to shut down the database server. You control
|
|
|
|
the type of shutdown by sending different signals to the server
|
|
|
|
process.
|
2000-06-18 23:24:54 +02:00
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><systemitem>SIGTERM</systemitem></term>
|
2000-06-18 23:24:54 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
After receiving <systemitem>SIGTERM</systemitem>, the server
|
|
|
|
disallows new connections, but lets existing sessions end their
|
|
|
|
work normally. It shuts down only after all of the sessions
|
|
|
|
terminate normally. This is the <firstterm>Smart
|
2002-03-09 06:11:38 +01:00
|
|
|
Shutdown</firstterm>.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><systemitem>SIGINT</systemitem></term>
|
2000-06-18 23:24:54 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
The server disallows new connections and sends all existing
|
|
|
|
server processes <systemitem>SIGTERM</systemitem>, which will cause them
|
2002-03-09 06:11:38 +01:00
|
|
|
to abort their current transactions and exit promptly. It then
|
2003-03-24 15:32:51 +01:00
|
|
|
waits for the server processes to exit and finally shuts down. This is the
|
2002-03-09 06:11:38 +01:00
|
|
|
<firstterm>Fast Shutdown</firstterm>.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2001-09-10 01:52:12 +02:00
|
|
|
<term><systemitem>SIGQUIT</systemitem></term>
|
2000-06-18 23:24:54 +02:00
|
|
|
<listitem>
|
2003-03-24 15:32:51 +01:00
|
|
|
<para>
|
|
|
|
This is the <firstterm>Immediate Shutdown</firstterm>, which
|
|
|
|
will cause the <command>postmaster</command> process to send a
|
|
|
|
<systemitem>SIGQUIT</systemitem> to all child processes and exit
|
|
|
|
immediately (without properly shutting itself down). The child processes
|
2002-03-09 06:11:38 +01:00
|
|
|
likewise exit immediately upon receiving
|
|
|
|
<systemitem>SIGQUIT</systemitem>. This will lead to recovery (by
|
|
|
|
replaying the WAL log) upon next start-up. This is recommended
|
|
|
|
only in emergencies.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
2003-03-24 15:32:51 +01:00
|
|
|
</para>
|
2000-06-18 23:24:54 +02:00
|
|
|
|
2001-11-09 00:39:22 +01:00
|
|
|
<important>
|
2000-06-18 23:24:54 +02:00
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
It is best not to use <systemitem>SIGKILL</systemitem> to shut down
|
2003-03-24 15:32:51 +01:00
|
|
|
the server. This will prevent the server from releasing
|
2002-03-09 06:11:38 +01:00
|
|
|
shared memory and semaphores, which may then have to be done by
|
|
|
|
manually.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
2001-11-09 00:39:22 +01:00
|
|
|
</important>
|
2000-06-18 23:24:54 +02:00
|
|
|
|
2003-03-24 15:32:51 +01:00
|
|
|
<para>
|
|
|
|
The <acronym>PID</> of the <command>postmaster</command> process can be found using the
|
|
|
|
<command>ps</command> program, or from the file
|
2000-06-18 23:24:54 +02:00
|
|
|
<filename>postmaster.pid</filename> in the data directory. So for
|
|
|
|
example, to do a fast shutdown:
|
|
|
|
<screen>
|
2001-11-28 21:49:10 +01:00
|
|
|
$ <userinput>kill -INT `head -1 /usr/local/pgsql/data/postmaster.pid`</userinput>
|
2000-06-18 23:24:54 +02:00
|
|
|
</screen>
|
|
|
|
</para>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
The program <command>pg_ctl</command> is a shell script
|
2001-03-24 01:24:26 +01:00
|
|
|
that provides a more convenient interface for shutting down the
|
2003-03-24 15:32:51 +01:00
|
|
|
server.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
|
|
|
</sect1>
|
|
|
|
|
2000-10-20 16:00:49 +02:00
|
|
|
<sect1 id="ssl-tcp">
|
2000-09-06 21:54:52 +02:00
|
|
|
<title>Secure TCP/IP Connections with SSL</title>
|
2000-08-29 06:15:43 +02:00
|
|
|
|
2001-05-13 00:51:36 +02:00
|
|
|
<indexterm zone="ssl-tcp">
|
|
|
|
<primary>SSL</primary>
|
|
|
|
</indexterm>
|
|
|
|
|
2000-08-29 06:15:43 +02:00
|
|
|
<para>
|
2002-03-09 06:11:38 +01:00
|
|
|
<productname>PostgreSQL</> has native support for using
|
|
|
|
<acronym>SSL</> connections to encrypt client/server communications
|
2003-03-24 15:32:51 +01:00
|
|
|
for increased security. This requires that
|
|
|
|
<productname>OpenSSL</productname> is installed on both client and
|
|
|
|
server systems and that support in <productname>PostgreSQL</> is
|
|
|
|
enabled at build time (see <xref linkend="installation">).
|
2000-08-29 06:15:43 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2002-11-21 07:36:08 +01:00
|
|
|
With <acronym>SSL</> support compiled in, the
|
|
|
|
<productname>PostgreSQL</> server can be started with
|
2003-03-24 15:32:51 +01:00
|
|
|
<acronym>SSL</> enabled by setting the parameter
|
2002-11-21 07:36:08 +01:00
|
|
|
<varname>ssl</varname> to on in <filename>postgresql.conf</>. When
|
|
|
|
starting in <acronym>SSL</> mode, the server will look for the
|
|
|
|
files <filename>server.key</> and <filename>server.crt</> in the
|
2003-03-24 15:32:51 +01:00
|
|
|
data directory, which should contain the server private key
|
|
|
|
and certificate, respectively. These files must be set up correctly
|
2002-11-21 07:36:08 +01:00
|
|
|
before an <acronym>SSL</>-enabled server can start. If the private key is
|
|
|
|
protected with a passphrase, the server will prompt for the
|
|
|
|
passphrase and will not start until it has been entered.
|
2000-08-29 06:15:43 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2002-11-21 07:36:08 +01:00
|
|
|
The server will listen for both standard and <acronym>SSL</>
|
2003-03-24 15:32:51 +01:00
|
|
|
connections on the same TCP port, and will negotiate with any
|
2002-11-21 07:36:08 +01:00
|
|
|
connecting client on whether to use <acronym>SSL</>. See <xref
|
|
|
|
linkend="client-authentication"> about how to force the server to
|
|
|
|
require use of <acronym>SSL</> for certain connections.
|
2000-08-29 06:15:43 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
For details on how to create your server private key and certificate,
|
2002-03-09 06:11:38 +01:00
|
|
|
refer to the <productname>OpenSSL</> documentation. A simple
|
|
|
|
self-signed certificate can be used to get started for testing, but a
|
2002-11-11 21:14:04 +01:00
|
|
|
certificate signed by a certificate authority (<acronym>CA</>) (either one of the global
|
2002-03-09 06:11:38 +01:00
|
|
|
<acronym>CAs</> or a local one) should be used in production so the
|
|
|
|
client can verify the server's identity. To create a quick
|
|
|
|
self-signed certificate, use the following
|
|
|
|
<productname>OpenSSL</productname> command:
|
2001-01-08 22:01:54 +01:00
|
|
|
<programlisting>
|
2002-09-27 04:04:39 +02:00
|
|
|
openssl req -new -text -out server.req
|
2001-01-08 22:01:54 +01:00
|
|
|
</programlisting>
|
2002-03-09 06:11:38 +01:00
|
|
|
Fill out the information that <command>openssl</> asks for. Make sure
|
2003-03-24 15:32:51 +01:00
|
|
|
that you enter the local host name as <quote>Common Name</>; the challenge
|
|
|
|
password can be left blank. The programm will generate a key that is
|
2002-11-11 21:14:04 +01:00
|
|
|
passphrase protected; it will not accept a passphrase that is less
|
2002-03-09 06:11:38 +01:00
|
|
|
than four characters long. To remove the passphrase (as you must if
|
|
|
|
you want automatic start-up of the server), run the commands
|
2001-01-08 22:01:54 +01:00
|
|
|
<programlisting>
|
2002-09-27 04:04:39 +02:00
|
|
|
openssl rsa -in privkey.pem -out server.key
|
|
|
|
rm privkey.pem
|
2001-01-08 22:01:54 +01:00
|
|
|
</programlisting>
|
2000-12-21 20:08:05 +01:00
|
|
|
Enter the old passphrase to unlock the existing key. Now do
|
2001-01-08 22:01:54 +01:00
|
|
|
<programlisting>
|
2002-09-27 04:04:39 +02:00
|
|
|
openssl req -x509 -in server.req -text -key server.key -out server.crt
|
|
|
|
chmod og-rwx server.key
|
2001-01-08 22:01:54 +01:00
|
|
|
</programlisting>
|
2000-12-21 20:08:05 +01:00
|
|
|
to turn the certificate into a self-signed certificate and to copy the
|
2001-11-28 21:49:10 +01:00
|
|
|
key and certificate to where the server will look for them.
|
2000-08-29 06:15:43 +02:00
|
|
|
</para>
|
|
|
|
</sect1>
|
|
|
|
|
2000-10-20 16:00:49 +02:00
|
|
|
<sect1 id="ssh-tunnels">
|
2002-11-11 21:14:04 +01:00
|
|
|
<title>Secure TCP/IP Connections with <application>SSH</application> Tunnels</title>
|
2000-06-18 23:24:54 +02:00
|
|
|
|
2001-05-13 00:51:36 +02:00
|
|
|
<indexterm zone="ssh-tunnels">
|
|
|
|
<primary>ssh</primary>
|
|
|
|
</indexterm>
|
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
<para>
|
2002-11-11 21:14:04 +01:00
|
|
|
One can use <application>SSH</application> to encrypt the network
|
2000-06-18 23:24:54 +02:00
|
|
|
connection between clients and a
|
2001-11-21 07:09:45 +01:00
|
|
|
<productname>PostgreSQL</productname> server. Done properly, this
|
2002-11-11 21:14:04 +01:00
|
|
|
provides an adequately secure network connection.
|
2000-06-18 23:24:54 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2002-11-11 21:14:04 +01:00
|
|
|
First make sure that an <application>SSH</application> server is
|
2003-03-24 15:32:51 +01:00
|
|
|
running properly on the same machine as the
|
|
|
|
<productname>PostgreSQL</productname> server and that you can log in using
|
2002-03-09 06:11:38 +01:00
|
|
|
<command>ssh</command> as some user. Then you can establish a secure
|
|
|
|
tunnel with a command like this from the client machine:
|
2000-06-18 23:24:54 +02:00
|
|
|
<programlisting>
|
2002-11-11 21:14:04 +01:00
|
|
|
ssh -L 3333:foo.com:5432 joe@foo.com
|
2000-06-18 23:24:54 +02:00
|
|
|
</programlisting>
|
|
|
|
The first number in the <option>-L</option> argument, 3333, is the
|
|
|
|
port number of your end of the tunnel; it can be chosen freely. The
|
2003-03-24 15:32:51 +01:00
|
|
|
second number, 5432, is the remote end of the tunnel: the port
|
2001-11-28 21:49:10 +01:00
|
|
|
number your server is using. The name or the address in between
|
2000-06-18 23:24:54 +02:00
|
|
|
the port numbers is the host with the database server you are going
|
|
|
|
to connect to. In order to connect to the database server using
|
|
|
|
this tunnel, you connect to port 3333 on the local machine:
|
|
|
|
<programlisting>
|
|
|
|
psql -h localhost -p 3333 template1
|
|
|
|
</programlisting>
|
|
|
|
To the database server it will then look as though you are really
|
|
|
|
user <literal>joe@foo.com</literal> and it will use whatever
|
|
|
|
authentication procedure was set up for this user. In order for the
|
2002-03-09 06:11:38 +01:00
|
|
|
tunnel setup to succeed you must be allowed to connect via
|
2003-03-24 15:32:51 +01:00
|
|
|
<command>ssh</command> as <literal>joe@foo.com</literal>, just
|
2002-03-09 06:11:38 +01:00
|
|
|
as if you had attempted to use <command>ssh</command> to set up a
|
2000-06-18 23:24:54 +02:00
|
|
|
terminal session.
|
|
|
|
</para>
|
|
|
|
|
2000-09-06 21:54:52 +02:00
|
|
|
<tip>
|
|
|
|
<para>
|
2002-11-11 21:14:04 +01:00
|
|
|
Several other applications exist that can provide secure tunnels using
|
2000-09-06 21:54:52 +02:00
|
|
|
a procedure similar in concept to the one just described.
|
|
|
|
</para>
|
|
|
|
</tip>
|
|
|
|
|
2000-06-18 23:24:54 +02:00
|
|
|
</sect1>
|
1998-09-30 07:41:54 +02:00
|
|
|
|
|
|
|
</Chapter>
|
1999-05-20 07:39:29 +02:00
|
|
|
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
|
|
Local variables:
|
2000-03-31 05:27:42 +02:00
|
|
|
mode:sgml
|
1999-05-20 07:39:29 +02:00
|
|
|
sgml-omittag:nil
|
|
|
|
sgml-shorttag:t
|
|
|
|
sgml-minimize-attributes:nil
|
|
|
|
sgml-always-quote-attributes:t
|
|
|
|
sgml-indent-step:1
|
|
|
|
sgml-indent-data:t
|
|
|
|
sgml-parent-document:nil
|
|
|
|
sgml-default-dtd-file:"./reference.ced"
|
|
|
|
sgml-exposed-tags:nil
|
2000-03-31 05:27:42 +02:00
|
|
|
sgml-local-catalogs:("/usr/lib/sgml/catalog")
|
1999-05-20 07:39:29 +02:00
|
|
|
sgml-local-ecat-files:nil
|
|
|
|
End:
|
|
|
|
-->
|