glfs/server/databases/postgresql.xml
Manuel Canales Esparcia 4ab91cdd39 Tagged postgresql.xml
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@4326 af4574ff-66df-0310-9fd7-8a98e5e911e0
2005-05-17 16:32:29 +00:00

534 lines
20 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../../general.ent">
%general-entities;
<!ENTITY postgresql-download-http "http://gd.tuwien.ac.at/db/postgresql/source/v&postgresql-version;/postgresql-&postgresql-version;.tar.bz2">
<!ENTITY postgresql-download-ftp "ftp://ftp.fr.postgresql.org/source/v&postgresql-version;/postgresql-&postgresql-version;.tar.bz2">
<!ENTITY postgresql-md5sum "075ac81c865b0af865459260bf1ca890">
<!ENTITY postgresql-size "11.0 MB">
<!ENTITY postgresql-buildsize "259 MB">
<!ENTITY postgresql-time "1.34 SBU">
]>
<sect1 id="postgresql" xreflabel="PostgreSQL-&postgresql-version;">
<?dbhtml filename="postgresql.html"?>
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<title>PostgreSQL-&postgresql-version;</title>
<indexterm zone="postgresql">
<primary sortas="a-PostgreSQL">PostgreSQL</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to PostgreSQL</title>
<para><application>PostgreSQL</application> is an advanced
object-relational database management system (ORDBMS), derived
from the Berkeley Postgres database management system.</para>
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>Download (HTTP): <ulink url="&postgresql-download-http;"/></para>
</listitem>
<listitem>
<para>Download (FTP): <ulink url="&postgresql-download-ftp;"/></para>
</listitem>
<listitem>
<para>Download MD5 sum: &postgresql-md5sum;</para>
</listitem>
<listitem>
<para>Download size: &postgresql-size;</para>
</listitem>
<listitem>
<para>Estimated disk space required: &postgresql-buildsize;</para>
</listitem>
<listitem>
<para>Estimated build time: &postgresql-time;</para>
</listitem>
</itemizedlist>
<!--
<sect3><title>Additional downloads</title>
<itemizedlist spacing='compact'>
<listitem><para>Required patch: <ulink
url="&patch-root;/postgresql-&postgresql-version;-dsssl_fix-1.patch"/></para>
</listitem></itemizedlist>
</sect3>
-->
<bridgehead renderas="sect3">PostgreSQL Dependencies</bridgehead>
<bridgehead renderas="sect4">Optional</bridgehead>
<para><xref linkend="python"/>,
<xref linkend="tcl"/>,
<xref linkend="openssl"/>,
<xref linkend="Linux_PAM"/>,
<xref linkend="sgml-dtd"/>,
<xref linkend="docbook-dsssl"/>,
<xref linkend="openjade"/>,
<xref linkend="perl-modules"/>: SGMLSpm-&SGMLSpm-version;,
<ulink url="http://www.pdc.kth.se/kth-krb/">krb4</ulink>,
<xref linkend="mitkrb"/> or <xref linkend="heimdal"/>, and
<ulink url="http://rendezvous.sourceforge.net/">Rendezvous</ulink></para>
</sect2>
<sect2 role="installation">
<title>Installation of PostgreSQL</title>
<para>In order for <command>configure</command> to properly discover
<application>Docbook SGML DTD</application>, you may need to remove
<application>OpenSP</application> catalog definitions from the system
SGML catalogs. Use the following command before building the package
to accomplish this:</para>
<screen role="root"><userinput>sed -i.orig \
-e "/CATALOG \/etc\/sgml\/OpenSP-1.5.1.cat/d" \
/etc/sgml/catalog \
/etc/sgml/sgml-docbook.cat</userinput></screen>
<para>Install <application>PostgreSQL</application> with the
following commands: </para>
<screen><userinput>sed -i \
-e "s|dsssl-stylesheets|&amp; \\\\\n sgml/docbook/&amp;-&docbook-dsssl-version;|" \
configure &amp;&amp;
./configure --prefix=/usr --enable-thread-safety &amp;&amp;
make</userinput></screen>
<para>Now, as the <systemitem class="username">root</systemitem> user:</para>
<screen role="root"><userinput>make install</userinput></screen>
<!--
<para>The standard installation provides only the header files needed
for client application development. Server-side applications require
the entire <application>PostgreSQL</application>
include tree which can be installed using the following command:</para>
<screen><userinput><command>make install-all-headers</command></userinput></screen>
-->
<note>
<para>If you are upgrading an existing system and are going to install
the new files over the old ones, then you should back up your data, shut
down the old server and follow the instructions in <ulink
url="http://www.postgresql.org/docs/8.0/static/install-upgrading.html">the
official <application>PostgreSQL</application> documentation</ulink>.</para>
</note>
<para>Initialize a database cluster with the following commands issued by the
<systemitem class="username">root</systemitem> user:</para>
<screen role="root"><userinput>install -v -m755 -d /srv/pgsql/data &amp;&amp;
useradd -c "PostgreSQL Server" -g users -d /srv/pgsql/data postgres &amp;&amp;
chown -v postgres /srv/pgsql/data &amp;&amp;
su - postgres -c '/usr/bin/initdb -D /srv/pgsql/data'</userinput></screen>
<para>As the <systemitem class="username">root</systemitem> user, start the
database server with the following command:</para>
<screen role="root"><userinput>su - postgres -c '/usr/bin/postmaster -D /srv/pgsql/data > \
/srv/pgsql/data/logfile 2&gt;&amp;1 &amp;'</userinput></screen>
<para>Still as user <systemitem class="username">root</systemitem>, create
a database and verify the installation:</para>
<screen role="root"><userinput>su - postgres -c '/usr/bin/createdb test' &amp;&amp;
echo "create table t1 ( name varchar(20), state_province varchar(20) );" \
| (su - postgres -c '/usr/bin/psql test ') &amp;&amp;
echo "insert into t1 values ('Billy', 'NewYork');" \
| (su - postgres -c '/usr/bin/psql test ') &amp;&amp;
echo "insert into t1 values ('Evanidus', 'Quebec');" \
| (su - postgres -c '/usr/bin/psql test ') &amp;&amp;
echo "insert into t1 values ('Jesse', 'Ontario');" \
| (su - postgres -c '/usr/bin/psql test ') &amp;&amp;
echo "select * from t1;" | (su - postgres -c '/usr/bin/psql test')</userinput></screen>
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<para><command>sed -i -e "s|dsssl-stylesheets|..."</command>: This command
puts an extra line in the <command>configure</command> script so that the
BLFS installed version of the DSSSL stylesheets can be discovered.</para>
<para><parameter>--enable-thread-safety</parameter>: This switch makes the
client libraries thread-safe by allowing concurrent threads in
<filename class='libraryfile'>libpq</filename> and ECPG programs to safely
control their private connection handles.</para>
<para><command>chown -R root:root /usr/share/doc/postgresql/html</command>:
This command corrects the improper ownership of some documentation
files.</para>
<para><command>useradd ...</command>: Add an unprivileged user to run the
database server.</para>
<para><command>createdb test; create table t1; insert into t1 values...;
select * from t1</command>: Create a database, add a table to it, insert
some rows into the table and select them to verify that the installation
is working properly.</para>
</sect2>
<sect2 role="configuration">
<title>Configuring PostgreSQL</title>
<sect3 id="postgresql-config">
<title>Config Files</title>
<para><filename>$PGDATA/pg_ident.con</filename>,
<filename>$PGDATA/pg_hba.conf</filename> and
<filename>$PGDATA/postgresql.conf</filename></para>
<indexterm zone="postgresql postgresql-config">
<primary sortas="e-A.PGDATA-pg_ident.con">$PGDATA/pg_indent.con</primary>
</indexterm>
<indexterm zone="postgresql postgresql-config">
<primary sortas="e-A.PGDATA-pg_hba.conf">$PGDATA/pg_hba_conf</primary>
</indexterm>
<indexterm zone="postgresql postgresql-config">
<primary sortas="e-A.PGDATA-postgresql.conf">$PGDATA/postgresql.conf</primary>
</indexterm>
<para>The <envar>PGDATA</envar> environment variable is used to
distinguish database clusters from one another by setting it to
the value of the directory which contains the cluster desired.
The three configuration files exist in every <filename
class="directory">PGDATA/</filename> directory. Details on the
format of the files and the options that can be set in each can
be found in <ulink
url="file:///usr/share/doc/postgresql/html/index.html"/>.</para>
</sect3>
<sect3 id="postgresql-init">
<title>Boot Script</title>
<para>Install the <filename>/etc/rc.d/init.d/postgresql</filename>
init script included in the
<xref linkend="intro-important-bootscripts"/> package.</para>
<indexterm zone="postgresql postgresql-init">
<primary sortas="f-postgresql">postgresql</primary>
</indexterm>
<screen role="root"><userinput>make install-postgresql</userinput></screen>
</sect3>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>clusterdb, createdb, createlang, createuser, dropdb, droplang,
dropuser, ecpg, initdb, ipcclean, pg_config, pg_controldata, pg_ctl,
pg_dump, pg_dumpall, pg_resetxlog, pg_restore, pltcl_delmod,
pltcl_listmod, pltcl_loadmod, postgres, postmaster, psql, and
vacuumdb</seg>
<seg>libecpg.[so,a], libecpg_compat.[so,a], libpgport.a, libpgtypes.[so,a],
libpq.[so,a], and various charset modules.</seg>
<seg>/srv/pgsql, /usr/include/libpq, /usr/include/postgresql,
/usr/lib/postgresql, /usr/share/doc/postgresql, and
/usr/share/postgresql</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="clusterdb">
<term><command>clusterdb</command></term>
<listitem>
<para>is a utility for reclustering tables in a
<application>PostgreSQL</application> database.</para>
<indexterm zone="postgresql clusterdb">
<primary sortas="b-clusterdb">clusterdb</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="createdb">
<term><command>createdb</command></term>
<listitem>
<para> creates a new <application>PostgreSQL</application>
database.</para>
<indexterm zone="postgresql createdb">
<primary sortas="b-createdb">createdb</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="createlang">
<term><command>createlang</command></term>
<listitem>
<para>defines a new <application>PostgreSQL</application> procedural
language.</para>
<indexterm zone="postgresql createlang">
<primary sortas="b-createlang">createlang</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="createuser">
<term><command>createuser</command></term>
<listitem>
<para>defines a new <application>PostgreSQL</application>
user account.</para>
<indexterm zone="postgresql createuser">
<primary sortas="b-createuser">createuser</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="dropdb">
<term><command>dropdb</command></term>
<listitem>
<para>removes a <application>PostgreSQL</application> database.</para>
<indexterm zone="postgresql dropdb">
<primary sortas="b-dropdb">dropdb</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="droplang">
<term><command>droplang</command></term>
<listitem>
<para>removes a <application>PostgreSQL</application> procedural
language.</para>
<indexterm zone="postgresql droplang">
<primary sortas="b-droplang">droplang</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="dropuser">
<term><command>dropuser</command></term>
<listitem>
<para>removes a <application>PostgreSQL</application>
user account.</para>
<indexterm zone="postgresql dropuser">
<primary sortas="b-dropuser">dropuser</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="ecpg">
<term><command>ecpg</command></term>
<listitem>
<para>is the embedded SQL preprocessor.</para>
<indexterm zone="postgresql ecpg">
<primary sortas="b-ecpg">ecpg</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="initdb">
<term><command>initdb</command></term>
<listitem>
<para>creates a new database cluster.</para>
<indexterm zone="postgresql initdb">
<primary sortas="b-initdb">initdb</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="ipcclean">
<term><command>ipcclean</command></term>
<listitem>
<para>removes shared memory and semaphores left over by an aborted
database server.</para>
<indexterm zone="postgresql ipcclean">
<primary sortas="b-ipcclean">ipcclean</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="pg_config">
<term><command>pg_config</command></term>
<listitem>
<para>retrieves <application>PostgreSQL</application> version
information.</para>
<indexterm zone="postgresql pg_config">
<primary sortas="b-pg_config">pg_config</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="pg_controldata">
<term><command>pg_controldata</command></term>
<listitem>
<para>returns information initialized during
<command>initdb</command>, such as the catalog version and server
locale.</para>
<indexterm zone="postgresql pg_controldata">
<primary sortas="b-pg_controldata">pg_controldata</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="pg_ctl">
<term><command>pg_ctl</command></term>
<listitem>
<para>controls stopping and starting the database server.</para>
<indexterm zone="postgresql pg_ctl">
<primary sortas="b-pg_ctl">pg_ctl</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="pg_dump">
<term><command>pg_dump</command></term>
<listitem>
<para>dumps database data and metadata into scripts which are used
to recreate the database.</para>
<indexterm zone="postgresql pg_dump">
<primary sortas="b-pg_dump">pg_dump</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="pg_dumpall">
<term><command>pg_dumpall</command></term>
<listitem>
<para>recursively calls <command>pg_dump</command> for each
database in a cluster.</para>
<indexterm zone="postgresql pg_dumpall">
<primary sortas="b-pg_dumpall">pg_dumpall</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="pg_resetxlog">
<term><command>pg_resetxlog</command></term>
<listitem>
<para>clears the write-ahead log and optionally resets some
fields in the <filename>pg_control</filename> file.</para>
<indexterm zone="postgresql pg_resetxlog">
<primary sortas="b-pg_resetxlog">pg_resetxlog</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="pg_restore">
<term><command>pg_restore</command></term>
<listitem>
<para>creates databases from dump files created by
<command>pg_dump</command>.</para>
<indexterm zone="postgresql pg_restore">
<primary sortas="b-pg_restore">pg_restore</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="pltcl_delmod">
<term><command>pltcl_delmod</command></term>
<listitem>
<para>is a support script used to delete a module from a
PL/<application>Tcl</application> table. The command
requires the <ulink
url="http://gborg.postgresql.org/project/pgtcl/">Pgtcl</ulink>
package to be installed also.</para>
<indexterm zone="postgresql pltcl_delmod">
<primary sortas="b-pltcl_delmod">pltcl_delmod</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="pltcl_listmod">
<term><command>pltcl_listmod</command></term>
<listitem>
<para>is a support script used to list the modules in a
PL/<application>Tcl</application> table. The command
requires the <ulink
url="http://gborg.postgresql.org/project/pgtcl/">Pgtcl</ulink>
package to be installed also.</para>
<indexterm zone="postgresql pltcl_listmod">
<primary sortas="b-pltcl_listmod">pltcl_listmod</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="pltcl_loadmod">
<term><command>pltcl_loadmod</command></term>
<listitem>
<para>is a support script used to load a module into a
PL/<application>Tcl</application> table. The command
requires the <ulink
url="http://gborg.postgresql.org/project/pgtcl/">Pgtcl</ulink>
package to be installed also.</para>
<indexterm zone="postgresql pltcl_loadmod">
<primary sortas="b-pltcl_loadmod">pltcl_loadmod</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="postgres">
<term><command>postgres</command></term>
<listitem>
<para>is a single user database server, generally used for
debugging.</para>
<indexterm zone="postgresql postgres">
<primary sortas="b-postgres">postgres</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="postmaster">
<term><command>postmaster</command></term>
<listitem>
<para>is a multi-user database daemon.</para>
<indexterm zone="postgresql postmaster">
<primary sortas="b-postmaster">postmaster</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="psql">
<term><command>psql</command></term>
<listitem>
<para>is a console based database shell.</para>
<indexterm zone="postgresql psql">
<primary sortas="b-psql">psql</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="vacuumdb">
<term><command>vacuumdb</command></term>
<listitem>
<para>compacts databases and generates statistics for the query
analyzer.</para>
<indexterm zone="postgresql vacuumdb">
<primary sortas="b-vacuumdb">vacuumdb</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>