source: server/databases/postgresql.xml@ 765916f

10.0 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 765916f was d95fe3d0, checked in by Ken Moffat <ken@…>, 4 years ago

A few more tags.

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