source: server/databases/postgresql.xml@ bcdfc53

11.1 lazarus trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since bcdfc53 was bcdfc53, checked in by Thomas Trepl (Moody) <thomas@…>, 6 months ago

Add some notes about upgrading DBMS

  • Property mode set to 100644
File size: 34.7 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY postgresql-download-http "https://ftp.postgresql.org/pub/source/v&postgresql-version;/postgresql-&postgresql-version;.tar.bz2">
8 <!-- <!ENTITY postgresql-download-ftp "ftp://ftp.postgresql.org/pub/source/v&postgresql-version;/postgresql-&postgresql-version;.tar.bz2"> -->
9 <!ENTITY postgresql-download-ftp " ">
10 <!ENTITY postgresql-md5sum "26e85a23c6a0ef68e9755555aea31141">
11 <!ENTITY postgresql-size "20.8 MB">
12 <!ENTITY postgresql-buildsize "193 MB (add 38 MB for tests)">
13 <!ENTITY postgresql-time "0.9 SBU (with parallelism=4, add 0.1 SBU for tests)">
14]>
15
16<sect1 id="postgresql" xreflabel="PostgreSQL-&postgresql-version;">
17 <?dbhtml filename="postgresql.html"?>
18
19 <sect1info>
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>
33 <application>PostgreSQL</application> is an advanced
34 object-relational database management system (ORDBMS), derived
35 from the Berkeley Postgres database management system.
36 </para>
37
38 &lfs110a_checked;
39
40 <bridgehead renderas="sect3">Package Information</bridgehead>
41 <itemizedlist spacing="compact">
42 <listitem>
43 <para>
44 Download (HTTP): <ulink url="&postgresql-download-http;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download (FTP): <ulink url="&postgresql-download-ftp;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download MD5 sum: &postgresql-md5sum;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download size: &postgresql-size;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated disk space required: &postgresql-buildsize;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated build time: &postgresql-time;
70 </para>
71 </listitem>
72 </itemizedlist>
73
74 <bridgehead renderas="sect3">PostgreSQL Dependencies</bridgehead>
75
76 <bridgehead renderas="sect4">Optional</bridgehead>
77 <para role="optional">
78 <xref linkend="python2"/>,
79 <!-- <xref linkend="tcl"/>, -->
80 <xref linkend="icu"/>,
81 <xref linkend="libxml2"/>,
82 <xref linkend="libxslt"/>,
83 <xref linkend="openldap"/>,
84 <xref linkend="linux-pam"/>,
85 <xref linkend="mitkrb"/> and
86 <ulink url="https://developer.apple.com/bonjour/">Bonjour</ulink>
87 </para>
88
89 <bridgehead renderas="sect4">Optional (To Regenerate Documentation)</bridgehead>
90 <para role="optional">
91 <xref linkend="fop"/>,
92 <xref linkend="sgml-dtd"/>,
93 <xref linkend="docbook-dsssl"/>,
94 <xref linkend="docbook-utils"/>,
95 <xref linkend="openjade"/>, and
96 <xref linkend="perl-sgmlspm"/>
97 </para>
98
99 <para condition="html" role="usernotes">User Notes:
100 <ulink url="&blfs-wiki;/postgresql"/></para>
101
102 </sect2>
103
104 <sect2 role="installation">
105 <title>Installation of PostgreSQL</title>
106
107 <note>
108 <para>
109 Before upgrading an existing installation of PostgreSQL check
110 the documentation about various ways to upgrade. Note that
111 new major versions might use a different binary format in the
112 data objects in which case incompatibilities may be introduced.
113 Find the documentation about upgrading at
114 <ulink url="https://www.postgresql.org/docs/current/upgrading.html"/>.
115 </para>
116 </note>
117
118 <para>
119 For enhanced security, it is better to have a dedicated group and user
120 for running the PostgreSQL server. First, issue as the
121 <systemitem class="username">root</systemitem> user:
122 </para>
123
124<screen role="root"><userinput>groupadd -g 41 postgres &amp;&amp;
125useradd -c "PostgreSQL Server" -g postgres -d /srv/pgsql/data \
126 -u 41 postgres</userinput></screen>
127
128 <note>
129 <para>
130 There are several configuration items that add additional
131 functionality with optional packages to
132 <application>PostgreSQL</application>. Use <command>./configure
133 --help</command> to see a list.
134 </para>
135 </note>
136
137 <para>
138 Install <application>PostgreSQL</application> with the
139 following commands:
140 </para>
141
142<screen><userinput>sed -i '/DEFAULT_PGSOCKET_DIR/s@/tmp@/run/postgresql@' src/include/pg_config_manual.h &amp;&amp;
143
144./configure --prefix=/usr \
145 --enable-thread-safety \
146 --docdir=/usr/share/doc/postgresql-&postgresql-version; &amp;&amp;
147make</userinput></screen>
148
149 <para>
150 There are a number of programs in the
151 <filename class="directory">contrib/</filename> directory. If you are
152 going to run this installation as a server and wish to build some of
153 them, enter <command>make -C contrib</command> or <command>make -C
154 contrib/<replaceable>&lt;SUBDIR-NAME&gt;</replaceable></command> for
155 each subdirectory.
156 </para>
157
158 <para>
159 Tests must be run as an unprivileged user because they need to start a
160 temporary server and this is prevented as the root user. For the same
161 reason, you need to stop all PostgreSQL servers if any are running. If a
162 previous version of PostgreSQL is installed, it may be necessary to use
163 <command>--disable-rpath</command> with <command>configure</command> to
164 avoid failures, but <emphasis>installing the binaries created using this
165 switch is not recommended</emphasis>. To test the results, issue:
166 <command>make check</command>.
167 </para>
168
169 <note>
170 <para>Hold off from continuing in case you are building
171 <application>PostgreSQL</application> to upgrade an existing
172 installation. In case the major version of the new build is
173 different to the existing one, its quite likely that the
174 new software cannot act on the existing data files. In this case,
175 the server will not start and the old binaries has been overwritten
176 so you got stuck with an unusable database.</para>
177 <para>At this moment, you have both, the old and the new binaries
178 on disk. They can be used to perform an upgrade of your existing
179 database right now. For the folloging instructions it is
180 assumed that
181 <itemizedlist>
182 <listitem><para>The actual data files are stored in
183 <filename class="directory">/srv/pgsql/data</filename></para>
184 </listitem>
185 <listitem><para>The upgraded data files will be stored in
186 <filename class="directory">/srv/pgsql/newdata</filename></para>
187 </listitem>
188 <listitem><para>There is enough disk space to hold the actual
189 data files twice. The upgrade is not an inline upgrade but
190 it will copy the data to new database files.</para>
191 </listitem>
192 </itemizedlist>
193 </para>
194
195 <para>Do a temporary install which makes access to the new
196 binaries a bit easier:</para>
197 <screen><userinput>make DESTDIR=$(pwd)/DESTDIR install</userinput></screen>
198
199 <para>Create a directory which is writable by the
200 <systemitem class="username">postgres</systemitem> as the
201 <systemitem class="username">root</systemitem> user:</para>
202
203 <screen><userinput role="root">install -D -o postgres $(pwd)/DESTDIR/tmp</userinput></screen>
204
205 <para>Now, stop the existing instance of <application>PostgreSQL</application>
206 and start the upgrade process as the
207 <systemitem class="username">root</systemitem> user:</para>
208
209 <screen><userinput role="root">pushd $(pwd)/DESTDIR/tmp
210/etc/rc.d/init.d/postgresql stop
211su postgres -c "../usr/bin/initdb -D /srv/pgsql/newdata"
212su postgres -c "../usr/bin/pg_upgrade -d /srv/pgsql/data -D /srv/pgsql/newdata -b /usr/bin -B ../usr/bin"
213popd</userinput></screen>
214
215 <para>At this stage, you have your database files two times on
216 disk, one is the old data in <filename class="directory">/srv/pgsql/data</filename>
217 and the new ones in <filename class="directory">/srv/pgsql/newdata</filename>.
218 May this is the time you do a last backup of the old database files.</para>
219
220 <para>Remove the old database files, and rename the new data
221 directory as the <systemitem class="username">root</systemitem> user:</para>
222
223 <screen><userinput role="root">rm -rf /srv/pgsql/data
224mv /srv/pgsql/newdata /srv/pgsql/data</userinput></screen>
225
226 </note>
227
228 <para>
229 Now, as the <systemitem class="username">root</systemitem> user:
230 </para>
231
232<screen role="root"><userinput>make install &amp;&amp;
233make install-docs</userinput></screen>
234
235 <para>
236 If you made any of the <filename class="directory">contrib/</filename>
237 programs, as the <systemitem class="username">root</systemitem> user:
238 </para>
239
240<screen role="nodump"><userinput>make -C contrib/<replaceable>&lt;SUBDIR-NAME&gt;</replaceable> install</userinput></screen>
241
242 <tip>
243 <para>
244 If you only intend to use <application>PostgreSQL</application> as a
245 client to connect to a server on another machine, your installation is
246 complete and you should not run the remaining commands.
247 </para>
248 </tip>
249
250 <para>
251 If you have upgraded an existing database, skip the rest of the
252 commands because your database is ready to use. If this is the
253 first time you install <application>PostgreSQL</application>,
254 continue with the initialization.
255 </para>
256
257 <para>
258 Initialize a database cluster with the following commands issued by the
259 <systemitem class="username">root</systemitem> user:
260 </para>
261
262<screen role="root"><userinput>install -v -dm700 /srv/pgsql/data &amp;&amp;
263install -v -dm755 /run/postgresql &amp;&amp;
264chown -Rv postgres:postgres /srv/pgsql /run/postgresql</userinput></screen>
265
266 <para>
267 Now, initialize the database as the <systemitem
268 class="username">root</systemitem> user:
269 </para>
270
271<screen role="root"><userinput>su - postgres -c '/usr/bin/initdb -D /srv/pgsql/data'</userinput></screen>
272
273 </sect2>
274
275 <sect2 role="commands">
276 <title>Command Explanations</title>
277
278 <para>
279 <command>sed -i ...</command>: This sed changes the server socket location
280 from <filename class="directory">/tmp</filename> to
281 <filename class="directory">/run/postgresql</filename><!-- and fix up the
282 regression tests to use <filename class="directory">/tmp</filename> so
283 that they can work reliably-->.
284 </para>
285
286 <para>
287 <parameter>--enable-thread-safety</parameter>: This switch makes the
288 client libraries thread-safe by allowing concurrent threads in
289 <filename class="libraryfile">libpq</filename> and ECPG programs to
290 safely control their private connection handles.
291 </para>
292
293 <para>
294 <option>--with-openssl</option>: builds the package with support for
295 <application>OpenSSL</application> encrypted connections.
296 </para>
297
298 <para>
299 <option>--with-perl</option>: builds the PL/Perl server-side language.
300 </para>
301
302 <para>
303 <option>--with-python</option>: builds the PL/Python server-side
304 language. Add PYTHON=/usr/bin/python2 for Python2 support, otherwise
305 Python3 is used by default.
306 </para>
307
308 <para>
309 <option>--with-tcl</option>: builds the PL/Tcl server-side language.
310 </para>
311
312 </sect2>
313
314 <sect2 role="configuration">
315 <title>Configuring PostgreSQL</title>
316
317 <sect3 id="postgresql-config">
318 <title>Config Files</title>
319
320 <para>
321 <filename>$PGDATA/pg_ident.con</filename>,
322 <filename>$PGDATA/pg_hba.conf</filename>, and
323 <filename>$PGDATA/postgresql.conf</filename>
324 </para>
325
326 <indexterm zone="postgresql postgresql-config">
327 <primary sortas="e-A.PGDATA-pg_ident.con">$PGDATA/pg_indent.con</primary>
328 </indexterm>
329
330 <indexterm zone="postgresql postgresql-config">
331 <primary sortas="e-A.PGDATA-pg_hba.conf">$PGDATA/pg_hba_conf</primary>
332 </indexterm>
333
334 <indexterm zone="postgresql postgresql-config">
335 <primary sortas="e-A.PGDATA-postgresql.conf">$PGDATA/postgresql.conf</primary>
336 </indexterm>
337
338 <para>
339 The <envar>PGDATA</envar> environment variable is used to
340 distinguish database clusters from one another by setting it to
341 the value of the directory which contains the cluster desired.
342 The three configuration files exist in every <filename
343 class="directory">PGDATA/</filename> directory. Details on the
344 format of the files and the options that can be set in each can
345 be found in <filename>
346 /usr/share/doc/postgresql-&postgresql-version;/html/index.html</filename>.
347 </para>
348
349 </sect3>
350
351 <sect3 id="postgresql-init">
352 <title><phrase revision="sysv">Boot Script</phrase>
353 <phrase revision="systemd">Systemd Unit</phrase></title>
354
355 <para>
356 Install the
357 <phrase revision="sysv"><filename>/etc/rc.d/init.d/postgresql</filename>
358 init script</phrase>
359 <phrase revision="systemd"><filename>postgresql.service</filename>
360 unit</phrase> included in the
361 <xref linkend="bootscripts" revision="sysv"/>
362 <xref linkend="systemd-units" revision="systemd"/> package:
363 </para>
364
365 <indexterm zone="postgresql postgresql-init">
366 <primary sortas="f-postgresql">postgresql</primary>
367 </indexterm>
368
369<screen role="root"><userinput>make install-postgresql</userinput></screen>
370
371 </sect3>
372
373 <sect3>
374 <title>Starting the PostgreSQL Server and Creating a Sample Database</title>
375
376 <para>
377 The database server can be manually started with the following command
378 (as the <systemitem class="username">root</systemitem> user):
379 </para>
380
381<screen role="root"><userinput>su - postgres -c '/usr/bin/postgres -D /srv/pgsql/data > \
382 /srv/pgsql/data/logfile 2&gt;&amp;1 &amp;'</userinput></screen>
383 <note>
384 <para>
385 If you are scripting this part, you should wait for the server to
386 start before going on, by adding for example
387 <command>sleep 2</command> after the above command.
388 </para>
389 </note>
390
391 <para>
392 The instructions below show how to create a database, add a table to
393 it, insert some rows into the table and select them, to verify that the
394 installation is working properly. Still as user <systemitem
395 class="username">root</systemitem>, issue:
396 </para>
397
398<screen role="root"><userinput>su - postgres -c '/usr/bin/createdb test' &amp;&amp;
399echo "create table t1 ( name varchar(20), state_province varchar(20) );" \
400 | (su - postgres -c '/usr/bin/psql test ') &amp;&amp;
401echo "insert into t1 values ('Billy', 'NewYork');" \
402 | (su - postgres -c '/usr/bin/psql test ') &amp;&amp;
403echo "insert into t1 values ('Evanidus', 'Quebec');" \
404 | (su - postgres -c '/usr/bin/psql test ') &amp;&amp;
405echo "insert into t1 values ('Jesse', 'Ontario');" \
406 | (su - postgres -c '/usr/bin/psql test ') &amp;&amp;
407echo "select * from t1;" | (su - postgres -c '/usr/bin/psql test')</userinput></screen>
408
409 <para>
410 When you are done with testing, you can shut down the server, by
411 issuing as <systemitem class="username">root</systemitem>:
412 </para>
413
414<screen role="root"><userinput>su - postgres -c "/usr/bin/pg_ctl stop -D /srv/pgsql/data"</userinput></screen>
415
416 </sect3>
417
418 </sect2>
419
420 <sect2 role="content">
421 <title>Contents</title>
422
423 <segmentedlist>
424 <segtitle>Installed Programs</segtitle>
425 <segtitle>Installed Libraries</segtitle>
426 <segtitle>Installed Directories</segtitle>
427
428 <seglistitem>
429 <seg>
430 clusterdb, createdb, createuser, dropdb, dropuser,
431 ecpg, initdb, pg_archivecleanup, pg_basebackup, pg_checksums,
432 pg_config, pg_controldata, pg_ctl, pg_dump, pg_dumpall, pg_isready,
433 pg_receivewal, pg_recvlogical, pg_resetwal, pg_restore, pg_rewind,
434 pg_test_fsync, pg_test_timing, pg_upgrade, pg_verifybackup,
435 pg_waldump, pgbench,
436 postgres, postmaster (deprecated), psql, reindexdb, vacuumdb,
437 optionally, if Tcl support has been built, pltcl_delmod,
438 pltcl_listmod, pltcl_loadmod, and optionally (in contrib/) oid2name,
439 pg_standby, vacuumlo, and many others
440
441 </seg>
442 <seg>
443 libecpg.{so,a}, libecpg_compat.{so,a}, libpgcommon.a,
444 libpgcommon_shlib.a, libpgfeutils.a, libpgport.a, libpgport_shlib.a,
445 libpgtypes.{so,a}, libpq.{so,a}, various charset modules and
446 optionally programming language modules under /usr/lib/postgresql
447 </seg>
448 <seg>
449 /usr/include/{libpq,postgresql},
450 /usr/lib/postgresql,
451 /usr/share/{doc/postgresql-&postgresql-version;,postgresql}, and
452 /srv/pgsql
453 </seg>
454 </seglistitem>
455 </segmentedlist>
456
457 <variablelist>
458 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
459 <?dbfo list-presentation="list"?>
460 <?dbhtml list-presentation="table"?>
461
462 <varlistentry id="clusterdb">
463 <term><command>clusterdb</command></term>
464 <listitem>
465 <para>
466 is a utility for reclustering tables in a
467 <application>PostgreSQL</application> database
468 </para>
469 <indexterm zone="postgresql clusterdb">
470 <primary sortas="b-clusterdb">clusterdb</primary>
471 </indexterm>
472 </listitem>
473 </varlistentry>
474
475 <varlistentry id="createdb">
476 <term><command>createdb</command></term>
477 <listitem>
478 <para>
479 creates a new <application>PostgreSQL</application>
480 database
481 </para>
482 <indexterm zone="postgresql createdb">
483 <primary sortas="b-createdb">createdb</primary>
484 </indexterm>
485 </listitem>
486 </varlistentry>
487
488 <varlistentry id="createuser">
489 <term><command>createuser</command></term>
490 <listitem>
491 <para>
492 defines a new <application>PostgreSQL</application>
493 user account
494 </para>
495 <indexterm zone="postgresql createuser">
496 <primary sortas="b-createuser">createuser</primary>
497 </indexterm>
498 </listitem>
499 </varlistentry>
500
501 <varlistentry id="dropdb">
502 <term><command>dropdb</command></term>
503 <listitem>
504 <para>
505 removes a <application>PostgreSQL</application> database
506 </para>
507 <indexterm zone="postgresql dropdb">
508 <primary sortas="b-dropdb">dropdb</primary>
509 </indexterm>
510 </listitem>
511 </varlistentry>
512
513 <varlistentry id="dropuser">
514 <term><command>dropuser</command></term>
515 <listitem>
516 <para>
517 removes a <application>PostgreSQL</application> user account
518 </para>
519 <indexterm zone="postgresql dropuser">
520 <primary sortas="b-dropuser">dropuser</primary>
521 </indexterm>
522 </listitem>
523 </varlistentry>
524
525 <varlistentry id="ecpg">
526 <term><command>ecpg</command></term>
527 <listitem>
528 <para>
529 is the embedded SQL preprocessor
530 </para>
531 <indexterm zone="postgresql ecpg">
532 <primary sortas="b-ecpg">ecpg</primary>
533 </indexterm>
534 </listitem>
535 </varlistentry>
536
537 <varlistentry id="initdb">
538 <term><command>initdb</command></term>
539 <listitem>
540 <para>
541 creates a new database cluster
542 </para>
543 <indexterm zone="postgresql initdb">
544 <primary sortas="b-initdb">initdb</primary>
545 </indexterm>
546 </listitem>
547 </varlistentry>
548
549 <varlistentry id="oid2name">
550 <term><command>oid2name</command></term>
551 <listitem>
552 <para>
553 resolves OIDs (Object IDs) and file nodes in a PostgreSQL data
554 directory
555 </para>
556 <indexterm zone="postgresql oid2name">
557 <primary sortas="b-oid2name">oid2name</primary>
558 </indexterm>
559 </listitem>
560 </varlistentry>
561
562 <varlistentry id="pg_archivecleanup">
563 <term><command>pg_archivecleanup</command></term>
564 <listitem>
565 <para>
566 cleans up PostgreSQL WAL (write-ahead log) archive files
567 </para>
568 <indexterm zone="postgresql pg_archivecleanup">
569 <primary sortas="b-pg_archivecleanup">pg_archivecleanup</primary>
570 </indexterm>
571 </listitem>
572 </varlistentry>
573
574 <varlistentry id="pg_basebackup">
575 <term><command>pg_basebackup</command></term>
576 <listitem>
577 <para>
578 takes base backups of a running
579 <application>PostgreSQL</application> cluster
580 </para>
581 <indexterm zone="postgresql pg_basebackup">
582 <primary sortas="b-pg_basebackup">pg_basebackup</primary>
583 </indexterm>
584 </listitem>
585 </varlistentry>
586
587 <varlistentry id="pg_checksums">
588 <term><command>pg_checksums</command></term>
589 <listitem>
590 <para>
591 enables, disables, or checks data checksums in a
592 <application>PostgreSQL</application> database cluster
593 </para>
594 <indexterm zone="postgresql pg_checksums">
595 <primary sortas="b-pg_checksums">pg_checksums</primary>
596 </indexterm>
597 </listitem>
598 </varlistentry>
599
600 <varlistentry id="pg_config">
601 <term><command>pg_config</command></term>
602 <listitem>
603 <para>
604 retrieves <application>PostgreSQL</application> version
605 information
606 </para>
607 <indexterm zone="postgresql pg_config">
608 <primary sortas="b-pg_config">pg_config</primary>
609 </indexterm>
610 </listitem>
611 </varlistentry>
612
613 <varlistentry id="pg_controldata">
614 <term><command>pg_controldata</command></term>
615 <listitem>
616 <para>
617 returns information initialized during <command>initdb</command>,
618 such as the catalog version and server locale
619 </para>
620 <indexterm zone="postgresql pg_controldata">
621 <primary sortas="b-pg_controldata">pg_controldata</primary>
622 </indexterm>
623 </listitem>
624 </varlistentry>
625
626 <varlistentry id="pg_ctl">
627 <term><command>pg_ctl</command></term>
628 <listitem>
629 <para>
630 controls stopping and starting the database server
631 </para>
632 <indexterm zone="postgresql pg_ctl">
633 <primary sortas="b-pg_ctl">pg_ctl</primary>
634 </indexterm>
635 </listitem>
636 </varlistentry>
637
638 <varlistentry id="pg_dump">
639 <term><command>pg_dump</command></term>
640 <listitem>
641 <para>
642 dumps database data and metadata into scripts which are used
643 to recreate the database
644 </para>
645 <indexterm zone="postgresql pg_dump">
646 <primary sortas="b-pg_dump">pg_dump</primary>
647 </indexterm>
648 </listitem>
649 </varlistentry>
650
651 <varlistentry id="pg_dumpall">
652 <term><command>pg_dumpall</command></term>
653 <listitem>
654 <para>
655 recursively calls <command>pg_dump</command> for each
656 database in a cluster
657 </para>
658 <indexterm zone="postgresql pg_dumpall">
659 <primary sortas="b-pg_dumpall">pg_dumpall</primary>
660 </indexterm>
661 </listitem>
662 </varlistentry>
663
664 <varlistentry id="pg_isready">
665 <term><command>pg_isready</command></term>
666 <listitem>
667 <para>
668 checks the connection status of a PostgreSQL server
669 </para>
670 <indexterm zone="postgresql pg_isready">
671 <primary sortas="b-pg_isready">pg_isready</primary>
672 </indexterm>
673 </listitem>
674 </varlistentry>
675
676 <varlistentry id="pg_receivewal">
677 <term><command>pg_receivewal</command></term>
678 <listitem>
679 <para>
680 is used to stream write-ahead logs from a PostgreSQL server
681 </para>
682 <indexterm zone="postgresql pg_receivewal">
683 <primary sortas="b-pg_receivewal">pg_receivewal</primary>
684 </indexterm>
685 </listitem>
686 </varlistentry>
687
688 <varlistentry id="pg_recvlogical">
689 <term><command>pg_recvlogical</command></term>
690 <listitem>
691 <para>
692 controls PostgreSQL logical decoding streams
693 </para>
694 <indexterm zone="postgresql pg_recvlogical">
695 <primary sortas="b-pg_recvlogical">pg_recvlogical</primary>
696 </indexterm>
697 </listitem>
698 </varlistentry>
699
700 <varlistentry id="pg_resetwal">
701 <term><command>pg_resetwal</command></term>
702 <listitem>
703 <para>
704 resets the write-ahead log and other control information
705 of a PostgreSQL database cluster
706 </para>
707 <indexterm zone="postgresql pg_resetwal">
708 <primary sortas="b-pg_resetwal">pg_resetwal</primary>
709 </indexterm>
710 </listitem>
711 </varlistentry>
712
713 <varlistentry id="pg_restore">
714 <term><command>pg_restore</command></term>
715 <listitem>
716 <para>
717 creates databases from dump files created by
718 <command>pg_dump</command>
719 </para>
720 <indexterm zone="postgresql pg_restore">
721 <primary sortas="b-pg_restore">pg_restore</primary>
722 </indexterm>
723 </listitem>
724 </varlistentry>
725
726 <varlistentry id="pg_rewind">
727 <term><command>pg_rewind</command></term>
728 <listitem>
729 <para>
730 synchronizes a PostgreSQL data directory with another data
731 directory that was forked from the first one
732 </para>
733 <indexterm zone="postgresql pg_rewind">
734 <primary sortas="b-pg_rewind">pg_rewind</primary>
735 </indexterm>
736 </listitem>
737 </varlistentry>
738
739 <varlistentry id="pg_standby">
740 <term><command>pg_standby</command></term>
741 <listitem>
742 <para>
743 supports the creation of a PostgreSQL warm standby server
744 </para>
745 <indexterm zone="postgresql pg_standby">
746 <primary sortas="b-pg_standby">pg_standby</primary>
747 </indexterm>
748 </listitem>
749 </varlistentry>
750
751 <varlistentry id="pg_test_fsync">
752 <term><command>pg_test_fsync</command></term>
753 <listitem>
754 <para>
755 determines the fastest wal_sync method for PostgreSQL
756 </para>
757 <indexterm zone="postgresql pg_test_fsync">
758 <primary sortas="b-pg_test_fsync">pg_test_fsync</primary>
759 </indexterm>
760 </listitem>
761 </varlistentry>
762
763 <varlistentry id="pg_test_timing">
764 <term><command>pg_test_timing</command></term>
765 <listitem>
766 <para>
767 measures timing overhead
768 </para>
769 <indexterm zone="postgresql pg_test_timing">
770 <primary sortas="b-pg_test_timing">pg_test_timing</primary>
771 </indexterm>
772 </listitem>
773 </varlistentry>
774
775 <varlistentry id="pg_upgrade">
776 <term><command>pg_upgrade</command></term>
777 <listitem>
778 <para>
779 upgrades a PostgreSQL server instance
780 </para>
781 <indexterm zone="postgresql pg_upgrade">
782 <primary sortas="b-pg_upgrade">pg_upgrade</primary>
783 </indexterm>
784 </listitem>
785 </varlistentry>
786
787 <varlistentry id="pg_verifybackup">
788 <term><command>pg_verifybackup</command></term>
789 <listitem>
790 <para>
791 verifies the integrity of a base backup of a PostgreSQL cluster
792 </para>
793 <indexterm zone="postgresql pg_verifybackup">
794 <primary sortas="b-pg_upgrade">pg_verifybackup</primary>
795 </indexterm>
796 </listitem>
797 </varlistentry>
798
799 <varlistentry id="pg_waldump">
800 <term><command>pg_waldump</command></term>
801 <listitem>
802 <para>
803 displays a human-readable rendering of the write-ahead log of a
804 PostgreSQL database cluster
805 </para>
806 <indexterm zone="postgresql pg_waldump">
807 <primary sortas="b-pg_waldump">pg_waldump</primary>
808 </indexterm>
809 </listitem>
810 </varlistentry>
811
812 <varlistentry id="pgbench">
813 <term><command>pgbench</command></term>
814 <listitem>
815 <para>
816 runs a benchmark test on PostgreSQL
817 </para>
818 <indexterm zone="postgresql pgbench">
819 <primary sortas="b-pgbench">pgbench</primary>
820 </indexterm>
821 </listitem>
822 </varlistentry>
823
824 <varlistentry id="pltcl_delmod">
825 <term><command>pltcl_delmod</command></term>
826 <listitem>
827 <para>
828 is a support script used to delete a module from a
829 PL/<application>Tcl</application> table. The command
830 requires the
831 <ulink url="http://flightaware.github.io/Pgtcl/">Pgtcl</ulink>
832 package to be installed
833 </para>
834 <indexterm zone="postgresql pltcl_delmod">
835 <primary sortas="b-pltcl_delmod">pltcl_delmod</primary>
836 </indexterm>
837 </listitem>
838 </varlistentry>
839
840 <varlistentry id="pltcl_listmod">
841 <term><command>pltcl_listmod</command></term>
842 <listitem>
843 <para>
844 is a support script used to list the modules in a
845 PL/<application>Tcl</application> table. The command
846 requires the
847 <ulink url="http://gborg.postgresql.org/project/pgtcl/">Pgtcl</ulink>
848 package to be installed
849 </para>
850 <indexterm zone="postgresql pltcl_listmod">
851 <primary sortas="b-pltcl_listmod">pltcl_listmod</primary>
852 </indexterm>
853 </listitem>
854 </varlistentry>
855
856 <varlistentry id="pltcl_loadmod">
857 <term><command>pltcl_loadmod</command></term>
858 <listitem>
859 <para>
860 is a support script used to load a module into a
861 PL/<application>Tcl</application> table. The command
862 requires the
863 <ulink url="http://gborg.postgresql.org/project/pgtcl/">Pgtcl</ulink>
864 package to be installed too
865 </para>
866 <indexterm zone="postgresql pltcl_loadmod">
867 <primary sortas="b-pltcl_loadmod">pltcl_loadmod</primary>
868 </indexterm>
869 </listitem>
870 </varlistentry>
871
872 <varlistentry id="postgres">
873 <term><command>postgres</command></term>
874 <listitem>
875 <para>
876 is the PostgreSQL database server
877 </para>
878 <indexterm zone="postgresql postgres">
879 <primary sortas="b-postgres">postgres</primary>
880 </indexterm>
881 </listitem>
882 </varlistentry>
883
884 <varlistentry id="postmaster">
885 <term><command>postmaster</command></term>
886 <listitem>
887 <para>
888 (deprecated, a symlink to <command>postgres</command>) is a
889 multi-user database daemon
890 </para>
891 <indexterm zone="postgresql postmaster">
892 <primary sortas="b-postmaster">postmaster</primary>
893 </indexterm>
894 </listitem>
895 </varlistentry>
896
897 <varlistentry id="psql">
898 <term><command>psql</command></term>
899 <listitem>
900 <para>
901 is a console based database shell
902 </para>
903 <indexterm zone="postgresql psql">
904 <primary sortas="b-psql">psql</primary>
905 </indexterm>
906 </listitem>
907 </varlistentry>
908
909 <varlistentry id="reindexdb">
910 <term><command>reindexdb</command></term>
911 <listitem>
912 <para>
913 is a utility for rebuilding indexes in a database
914 </para>
915 <indexterm zone="postgresql reindexdb">
916 <primary sortas="b-reindexdb">reindexdb</primary>
917 </indexterm>
918 </listitem>
919 </varlistentry>
920
921 <varlistentry id="vacuumdb">
922 <term><command>vacuumdb</command></term>
923 <listitem>
924 <para>
925 compacts databases and generates statistics for the query analyzer
926 </para>
927 <indexterm zone="postgresql vacuumdb">
928 <primary sortas="b-vacuumdb">vacuumdb</primary>
929 </indexterm>
930 </listitem>
931 </varlistentry>
932
933 <varlistentry id="vacuumlo">
934 <term><command>vacuumlo</command></term>
935 <listitem>
936 <para>
937 removes orphaned large objects from a PostgreSQL database
938 </para>
939 <indexterm zone="postgresql vacuumlo">
940 <primary sortas="b-vacuumlo">vacuumlo</primary>
941 </indexterm>
942 </listitem>
943 </varlistentry>
944
945 <varlistentry id="libecpg">
946 <term><filename class="libraryfile">libecpg.{so,a}</filename></term>
947 <listitem>
948 <para>
949 contains functions to support embedded SQL in C programs
950 </para>
951 <indexterm zone="postgresql libecpg">
952 <primary sortas="c-libecpg">libecpg.{so,a}</primary>
953 </indexterm>
954 </listitem>
955 </varlistentry>
956
957 <varlistentry id="libecpg_compat">
958 <term><filename class="libraryfile">libecpg_compat.{so,a}</filename></term>
959 <listitem>
960 <para>
961 is the ecpg compatibility library
962 </para>
963 <indexterm zone="postgresql libecpg_compat">
964 <primary sortas="c-libecpg_compat">libecpg_compat.{so,a}</primary>
965 </indexterm>
966 </listitem>
967 </varlistentry>
968
969 <varlistentry id="libgport">
970 <term><filename class="libraryfile">libgport.a</filename></term>
971 <listitem>
972 <para>
973 is the port-specific subsystem of the Postgres backend
974 </para>
975 <indexterm zone="postgresql libgport">
976 <primary sortas="c-libgport">libgport.a</primary>
977 </indexterm>
978 </listitem>
979 </varlistentry>
980
981 <varlistentry id="libpgtypes">
982 <term><filename class="libraryfile">libpgtypes.{so,a}</filename></term>
983 <listitem>
984 <para>
985 contains functions for dealing with Postgres data types
986 </para>
987 <indexterm zone="postgresql libpgtypes">
988 <primary sortas="c-libpgtypes">libpgtypes.{so,a}</primary>
989 </indexterm>
990 </listitem>
991 </varlistentry>
992
993 <varlistentry id="libpq">
994 <term><filename class="libraryfile">libpq.{so,a}</filename></term>
995 <listitem>
996 <para>
997 is the C programmer's API to Postgres
998 </para>
999 <indexterm zone="postgresql libpq">
1000 <primary sortas="c-libpq">libpq.{so,a}</primary>
1001 </indexterm>
1002 </listitem>
1003 </varlistentry>
1004
1005 </variablelist>
1006
1007 </sect2>
1008
1009</sect1>
Note: See TracBrowser for help on using the repository browser.