source: server/databases/postgresql.xml@ 0efab06

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 6.1 6.2 6.2.0 6.2.0-rc1 6.2.0-rc2 6.3 6.3-rc1 6.3-rc2 6.3-rc3 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts krejzi/svn lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 0efab06 was 4ab91cd, checked in by Manuel Canales Esparcia <manuel@…>, 19 years ago

Tagged postgresql.xml

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@4326 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 19.5 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY postgresql-download-http "http://gd.tuwien.ac.at/db/postgresql/source/v&postgresql-version;/postgresql-&postgresql-version;.tar.bz2">
8 <!ENTITY postgresql-download-ftp "ftp://ftp.fr.postgresql.org/source/v&postgresql-version;/postgresql-&postgresql-version;.tar.bz2">
9 <!ENTITY postgresql-md5sum "075ac81c865b0af865459260bf1ca890">
10 <!ENTITY postgresql-size "11.0 MB">
11 <!ENTITY postgresql-buildsize "259 MB">
12 <!ENTITY postgresql-time "1.34 SBU">
13]>
14
15<sect1 id="postgresql" xreflabel="PostgreSQL-&postgresql-version;">
16 <?dbhtml filename="postgresql.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>PostgreSQL-&postgresql-version;</title>
24
25 <indexterm zone="postgresql">
26 <primary sortas="a-PostgreSQL">PostgreSQL</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to PostgreSQL</title>
31
32 <para><application>PostgreSQL</application> is an advanced
33 object-relational database management system (ORDBMS), derived
34 from the Berkeley Postgres database management system.</para>
35
36 <bridgehead renderas="sect3">Package Information</bridgehead>
37 <itemizedlist spacing="compact">
38 <listitem>
39 <para>Download (HTTP): <ulink url="&postgresql-download-http;"/></para>
40 </listitem>
41 <listitem>
42 <para>Download (FTP): <ulink url="&postgresql-download-ftp;"/></para>
43 </listitem>
44 <listitem>
45 <para>Download MD5 sum: &postgresql-md5sum;</para>
46 </listitem>
47 <listitem>
48 <para>Download size: &postgresql-size;</para>
49 </listitem>
50 <listitem>
51 <para>Estimated disk space required: &postgresql-buildsize;</para>
52 </listitem>
53 <listitem>
54 <para>Estimated build time: &postgresql-time;</para>
55 </listitem>
56 </itemizedlist>
57
58<!--
59<sect3><title>Additional downloads</title>
60<itemizedlist spacing='compact'>
61<listitem><para>Required patch: <ulink
62url="&patch-root;/postgresql-&postgresql-version;-dsssl_fix-1.patch"/></para>
63</listitem></itemizedlist>
64</sect3>
65 -->
66
67 <bridgehead renderas="sect3">PostgreSQL Dependencies</bridgehead>
68
69 <bridgehead renderas="sect4">Optional</bridgehead>
70 <para><xref linkend="python"/>,
71 <xref linkend="tcl"/>,
72 <xref linkend="openssl"/>,
73 <xref linkend="Linux_PAM"/>,
74 <xref linkend="sgml-dtd"/>,
75 <xref linkend="docbook-dsssl"/>,
76 <xref linkend="openjade"/>,
77 <xref linkend="perl-modules"/>: SGMLSpm-&SGMLSpm-version;,
78 <ulink url="http://www.pdc.kth.se/kth-krb/">krb4</ulink>,
79 <xref linkend="mitkrb"/> or <xref linkend="heimdal"/>, and
80 <ulink url="http://rendezvous.sourceforge.net/">Rendezvous</ulink></para>
81
82 </sect2>
83
84 <sect2 role="installation">
85 <title>Installation of PostgreSQL</title>
86
87 <para>In order for <command>configure</command> to properly discover
88 <application>Docbook SGML DTD</application>, you may need to remove
89 <application>OpenSP</application> catalog definitions from the system
90 SGML catalogs. Use the following command before building the package
91 to accomplish this:</para>
92
93<screen role="root"><userinput>sed -i.orig \
94 -e "/CATALOG \/etc\/sgml\/OpenSP-1.5.1.cat/d" \
95 /etc/sgml/catalog \
96 /etc/sgml/sgml-docbook.cat</userinput></screen>
97
98 <para>Install <application>PostgreSQL</application> with the
99 following commands: </para>
100
101<screen><userinput>sed -i \
102 -e "s|dsssl-stylesheets|&amp; \\\\\n sgml/docbook/&amp;-&docbook-dsssl-version;|" \
103 configure &amp;&amp;
104./configure --prefix=/usr --enable-thread-safety &amp;&amp;
105make</userinput></screen>
106
107 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
108
109<screen role="root"><userinput>make install</userinput></screen>
110
111<!--
112<para>The standard installation provides only the header files needed
113for client application development. Server-side applications require
114the entire <application>PostgreSQL</application>
115include tree which can be installed using the following command:</para>
116
117<screen><userinput><command>make install-all-headers</command></userinput></screen>
118 -->
119
120 <note>
121 <para>If you are upgrading an existing system and are going to install
122 the new files over the old ones, then you should back up your data, shut
123 down the old server and follow the instructions in <ulink
124 url="http://www.postgresql.org/docs/8.0/static/install-upgrading.html">the
125 official <application>PostgreSQL</application> documentation</ulink>.</para>
126 </note>
127
128 <para>Initialize a database cluster with the following commands issued by the
129 <systemitem class="username">root</systemitem> user:</para>
130
131<screen role="root"><userinput>install -v -m755 -d /srv/pgsql/data &amp;&amp;
132useradd -c "PostgreSQL Server" -g users -d /srv/pgsql/data postgres &amp;&amp;
133chown -v postgres /srv/pgsql/data &amp;&amp;
134su - postgres -c '/usr/bin/initdb -D /srv/pgsql/data'</userinput></screen>
135
136 <para>As the <systemitem class="username">root</systemitem> user, start the
137 database server with the following command:</para>
138
139<screen role="root"><userinput>su - postgres -c '/usr/bin/postmaster -D /srv/pgsql/data > \
140 /srv/pgsql/data/logfile 2&gt;&amp;1 &amp;'</userinput></screen>
141
142 <para>Still as user <systemitem class="username">root</systemitem>, create
143 a database and verify the installation:</para>
144
145<screen role="root"><userinput>su - postgres -c '/usr/bin/createdb test' &amp;&amp;
146echo "create table t1 ( name varchar(20), state_province varchar(20) );" \
147 | (su - postgres -c '/usr/bin/psql test ') &amp;&amp;
148echo "insert into t1 values ('Billy', 'NewYork');" \
149 | (su - postgres -c '/usr/bin/psql test ') &amp;&amp;
150echo "insert into t1 values ('Evanidus', 'Quebec');" \
151 | (su - postgres -c '/usr/bin/psql test ') &amp;&amp;
152echo "insert into t1 values ('Jesse', 'Ontario');" \
153 | (su - postgres -c '/usr/bin/psql test ') &amp;&amp;
154echo "select * from t1;" | (su - postgres -c '/usr/bin/psql test')</userinput></screen>
155
156 </sect2>
157
158 <sect2 role="commands">
159 <title>Command Explanations</title>
160
161 <para><command>sed -i -e "s|dsssl-stylesheets|..."</command>: This command
162 puts an extra line in the <command>configure</command> script so that the
163 BLFS installed version of the DSSSL stylesheets can be discovered.</para>
164
165 <para><parameter>--enable-thread-safety</parameter>: This switch makes the
166 client libraries thread-safe by allowing concurrent threads in
167 <filename class='libraryfile'>libpq</filename> and ECPG programs to safely
168 control their private connection handles.</para>
169
170 <para><command>chown -R root:root /usr/share/doc/postgresql/html</command>:
171 This command corrects the improper ownership of some documentation
172 files.</para>
173
174 <para><command>useradd ...</command>: Add an unprivileged user to run the
175 database server.</para>
176
177 <para><command>createdb test; create table t1; insert into t1 values...;
178 select * from t1</command>: Create a database, add a table to it, insert
179 some rows into the table and select them to verify that the installation
180 is working properly.</para>
181
182 </sect2>
183
184 <sect2 role="configuration">
185 <title>Configuring PostgreSQL</title>
186
187 <sect3 id="postgresql-config">
188 <title>Config Files</title>
189
190 <para><filename>$PGDATA/pg_ident.con</filename>,
191 <filename>$PGDATA/pg_hba.conf</filename> and
192 <filename>$PGDATA/postgresql.conf</filename></para>
193
194 <indexterm zone="postgresql postgresql-config">
195 <primary sortas="e-A.PGDATA-pg_ident.con">$PGDATA/pg_indent.con</primary>
196 </indexterm>
197
198 <indexterm zone="postgresql postgresql-config">
199 <primary sortas="e-A.PGDATA-pg_hba.conf">$PGDATA/pg_hba_conf</primary>
200 </indexterm>
201
202 <indexterm zone="postgresql postgresql-config">
203 <primary sortas="e-A.PGDATA-postgresql.conf">$PGDATA/postgresql.conf</primary>
204 </indexterm>
205
206 <para>The <envar>PGDATA</envar> environment variable is used to
207 distinguish database clusters from one another by setting it to
208 the value of the directory which contains the cluster desired.
209 The three configuration files exist in every <filename
210 class="directory">PGDATA/</filename> directory. Details on the
211 format of the files and the options that can be set in each can
212 be found in <ulink
213 url="file:///usr/share/doc/postgresql/html/index.html"/>.</para>
214
215 </sect3>
216
217 <sect3 id="postgresql-init">
218 <title>Boot Script</title>
219
220 <para>Install the <filename>/etc/rc.d/init.d/postgresql</filename>
221 init script included in the
222 <xref linkend="intro-important-bootscripts"/> package.</para>
223
224 <indexterm zone="postgresql postgresql-init">
225 <primary sortas="f-postgresql">postgresql</primary>
226 </indexterm>
227
228<screen role="root"><userinput>make install-postgresql</userinput></screen>
229
230 </sect3>
231
232 </sect2>
233
234 <sect2 role="content">
235 <title>Contents</title>
236
237 <segmentedlist>
238 <segtitle>Installed Programs</segtitle>
239 <segtitle>Installed Libraries</segtitle>
240 <segtitle>Installed Directories</segtitle>
241
242 <seglistitem>
243 <seg>clusterdb, createdb, createlang, createuser, dropdb, droplang,
244 dropuser, ecpg, initdb, ipcclean, pg_config, pg_controldata, pg_ctl,
245 pg_dump, pg_dumpall, pg_resetxlog, pg_restore, pltcl_delmod,
246 pltcl_listmod, pltcl_loadmod, postgres, postmaster, psql, and
247 vacuumdb</seg>
248 <seg>libecpg.[so,a], libecpg_compat.[so,a], libpgport.a, libpgtypes.[so,a],
249 libpq.[so,a], and various charset modules.</seg>
250 <seg>/srv/pgsql, /usr/include/libpq, /usr/include/postgresql,
251 /usr/lib/postgresql, /usr/share/doc/postgresql, and
252 /usr/share/postgresql</seg>
253 </seglistitem>
254 </segmentedlist>
255
256 <variablelist>
257 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
258 <?dbfo list-presentation="list"?>
259 <?dbhtml list-presentation="table"?>
260
261 <varlistentry id="clusterdb">
262 <term><command>clusterdb</command></term>
263 <listitem>
264 <para>is a utility for reclustering tables in a
265 <application>PostgreSQL</application> database.</para>
266 <indexterm zone="postgresql clusterdb">
267 <primary sortas="b-clusterdb">clusterdb</primary>
268 </indexterm>
269 </listitem>
270 </varlistentry>
271
272 <varlistentry id="createdb">
273 <term><command>createdb</command></term>
274 <listitem>
275 <para> creates a new <application>PostgreSQL</application>
276 database.</para>
277 <indexterm zone="postgresql createdb">
278 <primary sortas="b-createdb">createdb</primary>
279 </indexterm>
280 </listitem>
281 </varlistentry>
282
283 <varlistentry id="createlang">
284 <term><command>createlang</command></term>
285 <listitem>
286 <para>defines a new <application>PostgreSQL</application> procedural
287 language.</para>
288 <indexterm zone="postgresql createlang">
289 <primary sortas="b-createlang">createlang</primary>
290 </indexterm>
291 </listitem>
292 </varlistentry>
293
294 <varlistentry id="createuser">
295 <term><command>createuser</command></term>
296 <listitem>
297 <para>defines a new <application>PostgreSQL</application>
298 user account.</para>
299 <indexterm zone="postgresql createuser">
300 <primary sortas="b-createuser">createuser</primary>
301 </indexterm>
302 </listitem>
303 </varlistentry>
304
305 <varlistentry id="dropdb">
306 <term><command>dropdb</command></term>
307 <listitem>
308 <para>removes a <application>PostgreSQL</application> database.</para>
309 <indexterm zone="postgresql dropdb">
310 <primary sortas="b-dropdb">dropdb</primary>
311 </indexterm>
312 </listitem>
313 </varlistentry>
314
315 <varlistentry id="droplang">
316 <term><command>droplang</command></term>
317 <listitem>
318 <para>removes a <application>PostgreSQL</application> procedural
319 language.</para>
320 <indexterm zone="postgresql droplang">
321 <primary sortas="b-droplang">droplang</primary>
322 </indexterm>
323 </listitem>
324 </varlistentry>
325
326 <varlistentry id="dropuser">
327 <term><command>dropuser</command></term>
328 <listitem>
329 <para>removes a <application>PostgreSQL</application>
330 user account.</para>
331 <indexterm zone="postgresql dropuser">
332 <primary sortas="b-dropuser">dropuser</primary>
333 </indexterm>
334 </listitem>
335 </varlistentry>
336
337 <varlistentry id="ecpg">
338 <term><command>ecpg</command></term>
339 <listitem>
340 <para>is the embedded SQL preprocessor.</para>
341 <indexterm zone="postgresql ecpg">
342 <primary sortas="b-ecpg">ecpg</primary>
343 </indexterm>
344 </listitem>
345 </varlistentry>
346
347 <varlistentry id="initdb">
348 <term><command>initdb</command></term>
349 <listitem>
350 <para>creates a new database cluster.</para>
351 <indexterm zone="postgresql initdb">
352 <primary sortas="b-initdb">initdb</primary>
353 </indexterm>
354 </listitem>
355 </varlistentry>
356
357 <varlistentry id="ipcclean">
358 <term><command>ipcclean</command></term>
359 <listitem>
360 <para>removes shared memory and semaphores left over by an aborted
361 database server.</para>
362 <indexterm zone="postgresql ipcclean">
363 <primary sortas="b-ipcclean">ipcclean</primary>
364 </indexterm>
365 </listitem>
366 </varlistentry>
367
368 <varlistentry id="pg_config">
369 <term><command>pg_config</command></term>
370 <listitem>
371 <para>retrieves <application>PostgreSQL</application> version
372 information.</para>
373 <indexterm zone="postgresql pg_config">
374 <primary sortas="b-pg_config">pg_config</primary>
375 </indexterm>
376 </listitem>
377 </varlistentry>
378
379 <varlistentry id="pg_controldata">
380 <term><command>pg_controldata</command></term>
381 <listitem>
382 <para>returns information initialized during
383 <command>initdb</command>, such as the catalog version and server
384 locale.</para>
385 <indexterm zone="postgresql pg_controldata">
386 <primary sortas="b-pg_controldata">pg_controldata</primary>
387 </indexterm>
388 </listitem>
389 </varlistentry>
390
391 <varlistentry id="pg_ctl">
392 <term><command>pg_ctl</command></term>
393 <listitem>
394 <para>controls stopping and starting the database server.</para>
395 <indexterm zone="postgresql pg_ctl">
396 <primary sortas="b-pg_ctl">pg_ctl</primary>
397 </indexterm>
398 </listitem>
399 </varlistentry>
400
401 <varlistentry id="pg_dump">
402 <term><command>pg_dump</command></term>
403 <listitem>
404 <para>dumps database data and metadata into scripts which are used
405 to recreate the database.</para>
406 <indexterm zone="postgresql pg_dump">
407 <primary sortas="b-pg_dump">pg_dump</primary>
408 </indexterm>
409 </listitem>
410 </varlistentry>
411
412 <varlistentry id="pg_dumpall">
413 <term><command>pg_dumpall</command></term>
414 <listitem>
415 <para>recursively calls <command>pg_dump</command> for each
416 database in a cluster.</para>
417 <indexterm zone="postgresql pg_dumpall">
418 <primary sortas="b-pg_dumpall">pg_dumpall</primary>
419 </indexterm>
420 </listitem>
421 </varlistentry>
422
423 <varlistentry id="pg_resetxlog">
424 <term><command>pg_resetxlog</command></term>
425 <listitem>
426 <para>clears the write-ahead log and optionally resets some
427 fields in the <filename>pg_control</filename> file.</para>
428 <indexterm zone="postgresql pg_resetxlog">
429 <primary sortas="b-pg_resetxlog">pg_resetxlog</primary>
430 </indexterm>
431 </listitem>
432 </varlistentry>
433
434 <varlistentry id="pg_restore">
435 <term><command>pg_restore</command></term>
436 <listitem>
437 <para>creates databases from dump files created by
438 <command>pg_dump</command>.</para>
439 <indexterm zone="postgresql pg_restore">
440 <primary sortas="b-pg_restore">pg_restore</primary>
441 </indexterm>
442 </listitem>
443 </varlistentry>
444
445 <varlistentry id="pltcl_delmod">
446 <term><command>pltcl_delmod</command></term>
447 <listitem>
448 <para>is a support script used to delete a module from a
449 PL/<application>Tcl</application> table. The command
450 requires the <ulink
451 url="http://gborg.postgresql.org/project/pgtcl/">Pgtcl</ulink>
452 package to be installed also.</para>
453 <indexterm zone="postgresql pltcl_delmod">
454 <primary sortas="b-pltcl_delmod">pltcl_delmod</primary>
455 </indexterm>
456 </listitem>
457 </varlistentry>
458
459 <varlistentry id="pltcl_listmod">
460 <term><command>pltcl_listmod</command></term>
461 <listitem>
462 <para>is a support script used to list the modules in a
463 PL/<application>Tcl</application> table. The command
464 requires the <ulink
465 url="http://gborg.postgresql.org/project/pgtcl/">Pgtcl</ulink>
466 package to be installed also.</para>
467 <indexterm zone="postgresql pltcl_listmod">
468 <primary sortas="b-pltcl_listmod">pltcl_listmod</primary>
469 </indexterm>
470 </listitem>
471 </varlistentry>
472
473 <varlistentry id="pltcl_loadmod">
474 <term><command>pltcl_loadmod</command></term>
475 <listitem>
476 <para>is a support script used to load a module into a
477 PL/<application>Tcl</application> table. The command
478 requires the <ulink
479 url="http://gborg.postgresql.org/project/pgtcl/">Pgtcl</ulink>
480 package to be installed also.</para>
481 <indexterm zone="postgresql pltcl_loadmod">
482 <primary sortas="b-pltcl_loadmod">pltcl_loadmod</primary>
483 </indexterm>
484 </listitem>
485 </varlistentry>
486
487 <varlistentry id="postgres">
488 <term><command>postgres</command></term>
489 <listitem>
490 <para>is a single user database server, generally used for
491 debugging.</para>
492 <indexterm zone="postgresql postgres">
493 <primary sortas="b-postgres">postgres</primary>
494 </indexterm>
495 </listitem>
496 </varlistentry>
497
498 <varlistentry id="postmaster">
499 <term><command>postmaster</command></term>
500 <listitem>
501 <para>is a multi-user database daemon.</para>
502 <indexterm zone="postgresql postmaster">
503 <primary sortas="b-postmaster">postmaster</primary>
504 </indexterm>
505 </listitem>
506 </varlistentry>
507
508 <varlistentry id="psql">
509 <term><command>psql</command></term>
510 <listitem>
511 <para>is a console based database shell.</para>
512 <indexterm zone="postgresql psql">
513 <primary sortas="b-psql">psql</primary>
514 </indexterm>
515 </listitem>
516 </varlistentry>
517
518 <varlistentry id="vacuumdb">
519 <term><command>vacuumdb</command></term>
520 <listitem>
521 <para>compacts databases and generates statistics for the query
522 analyzer.</para>
523 <indexterm zone="postgresql vacuumdb">
524 <primary sortas="b-vacuumdb">vacuumdb</primary>
525 </indexterm>
526 </listitem>
527 </varlistentry>
528
529 </variablelist>
530
531 </sect2>
532
533</sect1>
Note: See TracBrowser for help on using the repository browser.