source: server/databases/postgresql.xml@ a38fe9f

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

Merge existing note to a note doing the upgrade stuff

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