rdelaage/postgresql
1
0
Fork 0
mirror of https://git.postgresql.org/git/postgresql.git synced 2024-10-01 09:11:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

Markup fixes.

Browse Source
This commit is contained in:
Thomas G. Lockhart 1999-05-27 15:49:15 +00:00
parent b805230906
commit 5b1b477cca
2 changed files with 489 additions and 232 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

605
doc/src/sgml/ref/postgres-ref.sgml
View File

@ -1,220 +1,479 @@
.\" This is -*-nroff-*- <refentry id="APP-POSTGRES">
.\" XXX standard disclaimer belongs here.... <refmeta>
.\" $Header: /cvsroot/pgsql/doc/src/sgml/ref/postgres-ref.sgml,v 1.1 1999/05/26 17:25:38 thomas Exp $ <refentrytitle>
.TH POSTGRESQL UNIX 05/19/99 PostgreSQL PostgreSQL <application>postgres</application>
.SH NAME </refentrytitle>
postgres - the Postgres backend server <refmiscinfo>Application</refmiscinfo>
.SH SYNOPSIS </refmeta>
.BR "postgres" <refnamediv>
[\c <refname id="postgres-ref">
.BR "-B" <application>postgres</application>
n_buffers] </refname>
[\c <refpurpose>
.BR "-C" Run a <productname>Postgres</productname> single-user backend
] </refpurpose>
[\c </refnamediv>
.BR "-D" <refsynopsisdiv>
data_directory] <refsynopsisdivinfo>
[\c <date>1999-05-19</date>
.BR "-E" </refsynopsisdivinfo>
] <synopsis>
[\c postgres [ <replaceable class="parameter">dbname</replaceable> ]
.BR "-F" postgres [ -B <replaceable class="parameter">nBuffers</replaceable> ] [ -C ] [ -D <replaceable class="parameter">DataDir</replaceable> ] [ -E ] [ -F ]
] [ -O ] [ -Q ] [ -S <replaceable class="parameter">SortSize</replaceable> ] [ -d [ <replaceable class="parameter">DebugLevel</replaceable> ] ] [ -e ]
[\c [ -o ] [ <replaceable class="parameter">OutputFile</replaceable> ] [ -s ] [ -v <replaceable class="parameter">protocol</replaceable> ] [ <replaceable class="parameter">dbname</replaceable> ]
.BR "-O" </synopsis>
]
[\c <refsect2 id="R2-APP-POSTGRES-1">
.BR "-Q" <refsect2info>
] <date>1999-05-19</date>
[\c </refsect2info>
.BR "-S kbytes" <title>
] Inputs
[\c </title>
.BR "-d" <para>
debug_level] <application>postgres</application> accepts the following command line arguments:
[\c
.BR "-e" <variablelist>
] <varlistentry>
[\c <term>
.BR "-o" <replaceable class="parameter">dbname</replaceable>
output_file] </term>
[\c <listitem>
.BR "-s" <para>
]
[\c
.BR "-v protocol"
]
[dbname]
.in -5n
.SH DESCRIPTION
The Postgres backend server can be executed directly from the user shell.
This should be done only while debugging by the DBA, and should not be
done while other Postgres backends are being managed by a
.IR postmaster
on this set of databases.
.PP
Some of the switches explained in this man page can be passed to the backend
through the "database options" field of a connection request, and thus can be
set for a particular backend without going to the trouble of restarting the
postmaster. This is particularly handy for debugging-related switches.
.PP
The optional argument The optional argument
.IR dbname <replaceable class="parameter">dbname</replaceable>
specifies the name of the database to be accessed. specifies the name of the database to be accessed.
.IR Dbname <replaceable class="parameter">dbname</replaceable>
defaults to the value of the defaults to the value of the
.SM USER <envar>USER</envar>
environment variable. environment variable.
.PP </para>
The </listitem>
.IR postgres </varlistentry>
server understands the following command-line options:
.TP <varlistentry>
.BR "-B" " n_buffers" <term>
-B <replaceable class="parameter">nBuffers</replaceable>
</term>
<listitem>
<para>
If the backend is running under the If the backend is running under the
.IR postmaster , <application>postmaster</application>,
.IR "n_buffers" <replaceable class="parameter">nBuffers</replaceable>
is the number of shared-memory buffers that the is the number of shared-memory buffers that the
.IR "postmaster" <application>postmaster</application>
has allocated for the backend server processes that it starts. If the has allocated for the backend server processes that it starts. If the
backend is running standalone, this specifies the number of buffers to backend is running standalone, this specifies the number of buffers to
allocate. This value defaults to 64 buffers, where each buffer is 8k bytes allocate. This value defaults to 64 buffers, where each buffer is 8k bytes
(or whatever BLCKSZ is set to in config.h). (or whatever BLCKSZ is set to in config.h).
.TP </para>
.BR "-C" </listitem>
Do not show server version number. </varlistentry>
.TP
.BR "-D" " data_directory"
This option specifies the pathname of the directory that contains the
database system data (the tables, the catalogs, etc.). If you don't
specify this option, Postgres uses the value of the PGDATA environment
variable. You must either specify a -D option or set PGDATA.
The data directory pathname for a database system is normally determined when <varlistentry>
the database system is created with <term>
.IR initdb , -C
with a --pgdata option to </term>
.IR initdb . <listitem>
.TP <para>
.BR "-E" Do not show the server version number.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
-D <replaceable class="parameter">DataDir</replaceable>
</term>
<listitem>
<para>
Specifies the directory to use as the root of the tree of database
directories. If -D is not given, the default data directory name is
the value of the environment variable
<envar>PGDATA</envar>.
If <envar>PGDATA</envar> is not set, then the directory used is
<filename>$POSTGRESHOME/data</filename>.
If neither environment variable is set and this command-line
option is not specified, the default directory that was
set at compile-time is used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
-E
</term>
<listitem>
<para>
Echo all queries. Echo all queries.
.TP </para>
.BR "-F" </listitem>
Disable automatic fsync() call after each transaction. </varlistentry>
<varlistentry>
<term>
-F
</term>
<listitem>
<para>
Disable an automatic <function>fsync()</function> call after each transaction.
This option improves performance, but an operating system crash This option improves performance, but an operating system crash
while a transaction is in progress will probably cause data loss. while a transaction is in progress may cause the loss of
.TP the most recently entered data. Without the <function>fsync()</function> call
.BR "-O" the data is buffered by the operating system, and written to disk sometime later.
Override restrictions, so system table structures can be modified(pg_*). </para>
.TP </listitem>
.BR "-Q" </varlistentry>
Specifies \*(lqquiet\*(rq mode.
.TP <varlistentry>
.BR "-S" " kbytes" <term>
-O
</term>
<listitem>
<para>
Override restrictions, so system table structures can be modified.
These tables are typically those with a leading "pg_" in the table name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
-Q
</term>
<listitem>
<para>
Specifies "quiet" mode.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
-S <replaceable class="parameter">SortSize</replaceable>
</term>
<listitem>
<para>
Specifies the amount of memory to be used by internal sorts and hashes Specifies the amount of memory to be used by internal sorts and hashes
before resorting to temporary disk files. The value is specified in before resorting to temporary disk files. The value is specified in
kilobytes, and defaults to 512 kilobytes. Note that for a complex query, kilobytes, and defaults to 512 kilobytes. Note that for a complex query,
several sorts and/or hashes might be running in parallel, and each one several sorts and/or hashes might be running in parallel, and each one
will be allowed to use as much as -S kilobytes before it starts to put will be allowed to use as much as
data into temporary files. <replaceable class="parameter">SortSize</replaceable> kilobytes
.TP before it starts to put data into temporary files.
.BR "-e" </para>
The </listitem>
.IR "-e" </varlistentry>
option controls how dates are input to and output from the database.
.IP <varlistentry>
If the <term>
.IR "-e" -d [ <replaceable class="parameter">DebugLevel</replaceable> ]
option is supplied, then all dates passed to and from the frontend </term>
processes will be assumed to be in <listitem>
.IR "European" <para>
format ie. The optional argument <replaceable class="parameter">DebugLevel</replaceable>
.IR "DD-MM-YYYY" determines the amount of debugging output the backend servers will
otherwise dates are input and output in produce.
.IR "American" If <replaceable class="parameter">DebugLevel</replaceable>
format ie. is one, the postmaster will trace all connection traffic,
.IR "MM-DD-YYYY" and nothing else.
.TP For levels two and higher,
.BR "-d" " debug_level" debugging is turned on in the backend process and the postmaster
Turns on debugging at the numeric level displays more information,
.IR "debug_level" . including the backend environment and process traffic.
Turning on debugging will cause query, parse trees, and query plans to Note that if no file is specified for backend servers to
be displayed. send their debugging output then this output will appear on the
.TP controlling tty of their parent <application>postmaster</application>.
.BR "-o" " output_file" </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
-e
</term>
<listitem>
<para>
This option controls how dates are interpreted upon
input to and output from the database.
If the <option>-e</option>
option is supplied, then dates passed to and from the frontend
processes will be assumed to be in "European"
format (<literal>DD-MM-YYYY</literal>),
otherwise dates are assumed to be in
"American" format (<literal>MM-DD-YYYY</literal>).
Dates are accepted by the backend in a wide variety of formats,
and for input dates this switch mostly affects the interpretation
for ambiguous cases. See <xref linkend="datatype" endterm="datatype">
for more information.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
-o <replaceable class="parameter">OutputFile</replaceable>
</term>
<listitem>
<para>
Sends all debugging and error output to Sends all debugging and error output to
.IR output_file . <replaceable class="parameter">OutputFile</replaceable>.
If the backend is running under the If the backend is running under the <application>postmaster</application>,
.IR postmaster ,
error messages are still sent to the frontend process as well as to error messages are still sent to the frontend process as well as to
.IR output_file , <replaceable class="parameter">OutputFile</replaceable>,
but debugging output is sent to the controlling tty of the but debugging output is sent to the controlling tty of the
.IR postmaster <application>postmaster</application>
(since only one file descriptor can be sent to an actual file). (since only one file descriptor can be sent to an actual file).
.TP </para>
.BR "-s" </listitem>
</varlistentry>
<varlistentry>
<term>
-s
</term>
<listitem>
<para>
Print time information and other statistics at the end of each query. Print time information and other statistics at the end of each query.
This is useful for benchmarking or for use in tuning the number of This is useful for benchmarking or for use in tuning the number of
buffers. buffers.
.TP </para>
.BR "-v" " protocol" </listitem>
</varlistentry>
<varlistentry>
<term>
-v <replaceable class="parameter">protocol</replaceable>
</term>
<listitem>
<para>
Specifies the number of the frontend/backend protocol to be used for this Specifies the number of the frontend/backend protocol to be used for this
particular session. particular session.
.SH "DEVELOPER COMMAND OPTIONS" </para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
There are several other options that may be specified, used mainly There are several other options that may be specified, used mainly
for debugging purposes. These are listed here only for the use by for debugging purposes. These are listed here only for the use by
Postgres system developers. <productname>Postgres</productname> system developers.
.BR "Use of any of these options is highly discouraged" . <emphasis>Use of any of these options is highly discouraged.</emphasis>
Furthermore, any of these options may disappear or change at any time. Furthermore, any of these options may disappear or change at any time.
.TP </para>
.BR "-A" "n|r|b|Q\fIn\fP|X\fIn\fP"
.IP <para>
These special-case options are:
<variablelist>
<varlistentry>
<term>
-A n|r|b|Q\fIn\fP|X\fIn\fP
</term>
<listitem>
<para>
This option generates a tremendous amount of output. This option generates a tremendous amount of output.
.TP </para>
.BR "-L" </listitem>
</varlistentry>
<varlistentry>
<term>
-L
</term>
<listitem>
<para>
Turns off the locking system. Turns off the locking system.
.TP </para>
.BR "-N" </listitem>
</varlistentry>
<varlistentry>
<term>
-N
</term>
<listitem>
<para>
Disables use of newline as a query delimiter. Disables use of newline as a query delimiter.
.TP </para>
.BR "-f" </listitem>
</varlistentry>
<varlistentry>
<term>
-f [ s | i | m | n | h ]
</term>
<listitem>
<para>
Forbids the use of particular scan and join methods: Forbids the use of particular scan and join methods:
.IR s " and " i <literal>s</literal> and <literal>i</literal>
disable sequential and index scans respectively, while disable sequential and index scans respectively, while
.IR n ", " m " and " h <literal>n</literal>, <literal>m</literal>, and <literal>h</literal>
disable nested-loop, merge and hash joins respectively. disable nested-loop, merge and hash joins respectively.
(Neither sequential scans nor nested-loop joins can be disabled completely;
the -fs and -fn options simply discourage the optimizer from using those <note>
plan types if it has any other alternative.) <para>
.TP Neither sequential scans nor nested-loop joins can be disabled completely;
.BR "-i" the <literal>-fs</literal> and <literal>-fn</literal>
options simply discourage the optimizer from using those
plan types if it has any other alternative.
</para>
</note>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
-i
</term>
<listitem>
<para>
Prevents query execution, but shows the plan tree. Prevents query execution, but shows the plan tree.
.TP </para>
.BR "-p" " databasename" </listitem>
</varlistentry>
<varlistentry>
<term>
-p <replaceable class="parameter">dbname</replaceable>
</term>
<listitem>
<para>
Indicates to the backend server that it has been started by a Indicates to the backend server that it has been started by a
.IR postmaster <application>postmaster</application>
and make different assumptions about buffer pool management, file and make different assumptions about buffer pool management, file
descriptors, etc. Switches following -p are restricted to those descriptors, etc. Switches following -p are restricted to those
considered "secure". considered "secure".
.TP </para>
.BR "-t" "pa[rser]|pl[anner]|e[xecutor]" </listitem>
</varlistentry>
<varlistentry>
<term>
-t pa[rser] | pl[anner] | e[xecutor]
</term>
<listitem>
<para>
Print timing statistics for each query relating to each of the major Print timing statistics for each query relating to each of the major
system modules. This option cannot be used with system modules. This option cannot be used with <option>-s</option>.
.BR "-s" . </para>
.SH "SEE ALSO" </listitem>
ipcclean(1), </varlistentry>
psql(1), </variablelist>
postmaster(1). </para>
.SH "DIAGNOSTICS" </refsect2>
<refsect2 id="R2-APP-POSTGRES-2">
<refsect2info>
<date>1999-05-19</date>
</refsect2info>
<title>
Outputs
</title>
<para>
Of the nigh-infinite number of error messages you may see when you Of the nigh-infinite number of error messages you may see when you
execute the backend server directly, the most common will probably be: execute the backend server directly, the most common will probably be:
.TP
.BR "semget: No space left on device" <variablelist>
<varlistentry>
<term>
semget: No space left on device
</term>
<listitem>
<para>
If you see this message, you should run the If you see this message, you should run the
.IR ipcclean <application>ipcclean</application>
command. After doing this, try starting command. After doing this, try starting
.IR postgres <application>postmaster</application>
again. If this still doesn't work, you probably need to configure again. If this still doesn't work, you probably need to configure
your kernel for shared memory and semaphores as described in the your kernel for shared memory and semaphores as described in the
installation notes. installation notes. If you have a kernel with particularly small shared memory
and/or semaphore limits, you may have to reconfigure your kernel to increase
its shared memory or semaphore parameters.
<tip>
<para>
You may be able to postpone
reconfiguring your kernel by decreasing -B to reduce
<productname>Postgres</productname>' shared memory
consumption.
</para>
</tip>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect2>
</refsynopsisdiv>
<refsect1 id="R1-APP-POSTGRES-1">
<refsect1info>
<date>1999-05-19</date>
</refsect1info>
<title>
Description
</title>
<para>
The Postgres backend server can be executed directly from the user shell.
This should be done only while debugging by the DBA, and should not be
done while other Postgres backends are being managed by a
<application>postmaster</application>
on this set of databases.
</para>
<para>
Some of the switches explained here can be passed to the backend
through the "database options" field of a connection request, and thus can be
set for a particular backend without going to the trouble of restarting the
postmaster. This is particularly handy for debugging-related switches.
</para>
<para>
The optional argument <replaceable class="parameter">dbname</replaceable>
specifies the name of the database to be accessed.
<replaceable class="parameter">dbname</replaceable>
defaults to the value of the
<envar>USER</envar> environment variable.
</para>
</refsect1>
<refsect1 id="R1-APP-POSTGRES-2">
<refsect1info>
<date>1998-10-04</date>
</refsect1info>
<title>
Notes
</title>
<para>
Useful utilities for dealing with shared memory problems include
<application>ipcs(1)</application>,
<application>ipcrm(1</application>), and
<application>ipcclean(1)</application>.
See also <xref linkend="postmaster-ref" endterm="postmaster-ref">.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
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
sgml-local-catalogs:"/usr/lib/sgml/catalog"
sgml-local-ecat-files:nil
End:
-->

22
doc/src/sgml/ref/postmaster.sgml
View File

@ -6,7 +6,7 @@
<refmiscinfo>Application</refmiscinfo> <refmiscinfo>Application</refmiscinfo>
</refmeta> </refmeta>
<refnamediv> <refnamediv>
<refname id="postmaster"> <refname id="postmaster-ref">
<application>postmaster</application> <application>postmaster</application>
</refname> </refname>
<refpurpose> <refpurpose>
@ -18,10 +18,9 @@
<date>1999-05-19</date> <date>1999-05-19</date>
</refsynopsisdivinfo> </refsynopsisdivinfo>
<synopsis> <synopsis>
postmaster [ -B <replaceable class="parameter">nBuffers</replaceable> ] postmaster [ -B <replaceable class="parameter">nBuffers</replaceable> ] [ -D <replaceable class="parameter">DataDir</replaceable> ] [ -i ]
[ -D <replaceable class="parameter">DataDir</replaceable> ] [-N <replaceable class="parameter">nBackends</replaceable> ] [ -S ] postmaster [ -B <replaceable class="parameter">nBuffers</replaceable> ] [ -D <replaceable class="parameter">DataDir</replaceable> ] [ -N <replaceable class="parameter">nBackends</replaceable> ] [ -S ]
[ -d [ <replaceable class="parameter">DebugLevel</replaceable> ] ] [ -d [ <replaceable class="parameter">DebugLevel</replaceable> ] [ -i ] [ -o <replaceable class="parameter">BackendOptions</replaceable> ] [ -p <replaceable class="parameter">port</replaceable> ]
[ -i ] [ -o <replaceable class="parameter">BackendOptions</replaceable> ] [ -p <replaceable class="parameter">port</replaceable> ]
postmaster [ -n | -s ] ... postmaster [ -n | -s ] ...
</synopsis> </synopsis>
@ -206,10 +205,8 @@ postmaster [ -n | -s ] ...
</term> </term>
<listitem> <listitem>
<para> <para>
If the <literal>-n</literal>
option is supplied, then the
<application>postmaster</application> <application>postmaster</application>
does not reinitialize shared data structures. A knowledgable system will not reinitialize shared data structures. A knowledgable system
programmer can then use the programmer can then use the
<application>shmemdoc</application> <application>shmemdoc</application>
program to examine shared memory and semaphore state. program to examine shared memory and semaphore state.
@ -235,7 +232,7 @@ postmaster [ -n | -s ] ...
</para> </para>
</refsect2> </refsect2>
<refsect2 id="R2-APP-POSTMASTER-1"> <refsect2 id="R2-APP-POSTMASTER-2">
<refsect2info> <refsect2info>
<date>1999-05-19</date> <date>1999-05-19</date>
</refsect2info> </refsect2info>
@ -388,8 +385,9 @@ on BSD-based systems, or
You can run more than one postmaster on a machine only if each one has a You can run more than one postmaster on a machine only if each one has a
separate directory and port number. separate directory and port number.
</para> </para>
</refsect1>
<refsect1 id="R1-APP-VACUUMDB-2"> <refsect1 id="R1-APP-POSTMASTER-2">
<refsect1info> <refsect1info>
<date>1998-10-04</date> <date>1998-10-04</date>
</refsect1info> </refsect1info>
@ -434,7 +432,7 @@ or its alternative form
</para> </para>
</refsect1> </refsect1>
<refsect1 id="R1-APP-VACUUMDB-3"> <refsect1 id="R1-APP-POSTMASTER-3">
<refsect1info> <refsect1info>
<date>1998-10-04</date> <date>1998-10-04</date>
</refsect1info> </refsect1info>
@ -478,7 +476,7 @@ or its alternative form
% setenv PGPORT 1234 % setenv PGPORT 1234
% psql % psql
</programlisting>. </programlisting>.
</para>
</refsect1> </refsect1>
</refentry> </refentry>