source: server/databases/postgresql.xml@ e99a437

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 e99a437 was e99a437, checked in by Thomas Trepl (Moody) <thomas@…>, 2 years ago

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