source: server/databases/postgresql.xml@ eee261a

10.1 11.0 11.1 11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since eee261a was eee261a, checked in by Douglas R. Reno <renodr@…>, 3 years ago

Update to evolution-3.38.4
Update to evolution-data-server-3.38.4
Update to postgresql-13.2 (Security Update)
Update to highlight-3.61
Update to libgdata-0.18.0
Update to gnome-autoar-0.3.0 (Security Update)

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

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