source: server/databases/postgresql.xml@ 45ab6c7

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

more SVN prop clean up

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