source: server/databases/postgresql.xml@ 96d79ed

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

Added a small note on upgrading pgsql

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