source: server/databases/postgresql.xml@ 97af643

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 xry111/llvm18 xry111/soup3 xry111/xf86-video-removal
Last change on this file since 97af643 was 97af643, checked in by Pierre Labastie <pierre.labastie@…>, 20 months ago

Update to postgresql-14.5

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