source: server/databases/postgresql.xml@ a923ca1e

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt perl-modules 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 a923ca1e was a923ca1e, checked in by Bruce Dubbs <bdubbs@…>, 6 years ago

Update to postgresql-10.2.
Update to udisks2-2.7.6.
Update to libblockdev-2.16.
Update to qpdf-7.1.1.
Update to fribidi-1.0.1.
Update to exempi-2.4.4.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@19743 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 29.6 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY postgresql-download-http "http://ftp.postgresql.org/pub/source/v&postgresql-version;/postgresql-&postgresql-version;.tar.bz2">
8 <!ENTITY postgresql-download-ftp "ftp://ftp.postgresql.org/pub/source/v&postgresql-version;/postgresql-&postgresql-version;.tar.bz2">
9 <!ENTITY postgresql-md5sum "e97c3cc72bdf661441f29069299b260a">
10 <!ENTITY postgresql-size "19 MB">
11 <!ENTITY postgresql-buildsize "176 MB (add 32 MB for tests)">
12 <!ENTITY postgresql-time "0.6 SBU (with parallelism=4, add 0.1 SBU for tests)">
13]>
14
15<sect1 id="postgresql" xreflabel="PostgreSQL-&postgresql-version;">
16 <?dbhtml filename="postgresql.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
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><application>PostgreSQL</application> is an advanced
33 object-relational database management system (ORDBMS), derived
34 from the Berkeley Postgres database management system.</para>
35
36 &lfs81_checked;
37
38 <bridgehead renderas="sect3">Package Information</bridgehead>
39 <itemizedlist spacing="compact">
40 <listitem>
41 <para>Download (HTTP): <ulink url="&postgresql-download-http;"/></para>
42 </listitem>
43 <listitem>
44 <para>Download (FTP): <ulink url="&postgresql-download-ftp;"/></para>
45 </listitem>
46 <listitem>
47 <para>Download MD5 sum: &postgresql-md5sum;</para>
48 </listitem>
49 <listitem>
50 <para>Download size: &postgresql-size;</para>
51 </listitem>
52 <listitem>
53 <para>Estimated disk space required: &postgresql-buildsize;</para>
54 </listitem>
55 <listitem>
56 <para>Estimated build time: &postgresql-time;</para>
57 </listitem>
58 </itemizedlist>
59
60 <bridgehead renderas="sect3">PostgreSQL Dependencies</bridgehead>
61
62 <bridgehead renderas="sect4">Optional</bridgehead>
63 <para role="optional">
64 <xref linkend="python2"/>,
65 <xref linkend="tcl"/>,
66 <xref linkend="openssl"/>,
67 <xref linkend="libxml2"/>,
68 <xref linkend="libxslt"/>,
69 <xref linkend="openldap"/>,
70 <xref linkend="linux-pam"/>,
71 <xref linkend="mitkrb"/> and
72 <ulink url="http://developer.apple.com/networking/bonjour/">Bonjour</ulink>
73 </para>
74
75 <bridgehead renderas="sect4">Optional (To Regenerate Documentation)</bridgehead>
76 <para role="optional">
77 <xref linkend="sgml-dtd"/>,
78 <xref linkend="docbook-dsssl"/>,
79 <xref linkend="openjade"/>, and
80 <xref linkend="perl-sgmlspm"/>
81 </para>
82
83 <para condition="html" role="usernotes">User Notes:
84 <ulink url="&blfs-wiki;/postgresql"/></para>
85
86 </sect2>
87
88 <sect2 role="installation">
89 <title>Installation of PostgreSQL</title>
90
91 <para>Install <application>PostgreSQL</application> with the
92 following commands: </para>
93
94<screen><userinput>sed -i '/DEFAULT_PGSOCKET_DIR/s@/tmp@/run/postgresql@' src/include/pg_config_manual.h &amp;&amp;
95
96./configure --prefix=/usr \
97 --enable-thread-safety \
98 --docdir=/usr/share/doc/postgresql-&postgresql-version; &amp;&amp;
99make</userinput></screen>
100
101 <para>There are a number of programs in the
102 <filename class="directory">contrib/</filename> directory. If you are going
103 to run this installation as a server and wish to build some of them, enter
104 <command>make -C contrib</command> or
105 <command>make -C contrib/<replaceable>&lt;SUBDIR-NAME&gt;</replaceable></command> for each subdirectory.
106 </para>
107
108 <para>Tests must be run as an unprivileged user because they need to start a
109 temporary server and this is prevented as the root user. For the same reason,
110 you need to stop all PostgreSQL servers if any are running. If a previous
111 version of PostgreSQL is installed, it may be necessary to use
112 <emphasis>--disable-rpath</emphasis> with <emphasis>configure</emphasis> to
113 avoid failures, but <command>installing the binaries created using this
114 switch is not recommended</command>. To test the results, issue:
115 <command>make check</command>.</para>
116
117 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
118
119<screen role="root"><userinput>make install &amp;&amp;
120make install-docs</userinput></screen>
121
122 <para>If you made any of the <filename class="directory">contrib/</filename>
123 programs, as the <systemitem class="username">root</systemitem> user:</para>
124
125<screen role="nodump/"><userinput>make -C contrib/<replaceable>&lt;SUBDIR-NAME&gt;</replaceable> install</userinput></screen>
126
127 <para><emphasis>If you only intend to use
128 <application>PostgreSQL</application> as a client to connect to a server on
129 another machine, your installation is complete and you should not run the
130 remaining commands.</emphasis></para>
131
132 <!-- 'Upgrading' seems to only ever exist in the docs for *previous* version -->
133 <!-- Obsolete: only if upgrading for versions prior to 9 <note>
134 <para>If you are upgrading an existing system and are going to install
135 the new files over the old ones, then you should back up your data, shut
136 down the old server and follow the instructions in <ulink
137 url="http://www.postgresql.org/docs/9.0/static/install-upgrading.html">the
138 official <application>PostgreSQL</application> documentation</ulink>.</para>
139 </note>-->
140
141 <para>Initialize a database cluster with the following commands issued by the
142 <systemitem class="username">root</systemitem> user:</para>
143
144<screen role="root"><userinput>install -v -dm700 /srv/pgsql/data &amp;&amp;
145install -v -dm755 /run/postgresql &amp;&amp;
146
147groupadd -g 41 postgres &amp;&amp;
148useradd -c "PostgreSQL Server" -g postgres -d /srv/pgsql/data \
149 -u 41 postgres &amp;&amp;
150
151chown -Rv postgres:postgres /srv/pgsql /run/postgresql</userinput></screen>
152
153 <para>Now, initialize the database at the <systemitem
154 class="username">root</systemitem> user:</para>
155
156<screen role="root"><userinput>su - postgres -c '/usr/bin/initdb -D /srv/pgsql/data'</userinput></screen>
157
158 <para>Again as the <systemitem class="username">root</systemitem> user,
159 start the database server with the following command:</para>
160
161<screen role="root"><userinput>su - postgres -c '/usr/bin/postgres -D /srv/pgsql/data > \
162 /srv/pgsql/data/logfile 2&gt;&amp;1 &amp;'</userinput></screen>
163
164 <para>Still as user <systemitem class="username">root</systemitem>, create
165 a database and verify the installation:</para>
166
167<screen role="root"><userinput>su - postgres -c '/usr/bin/createdb test' &amp;&amp;
168echo "create table t1 ( name varchar(20), state_province varchar(20) );" \
169 | (su - postgres -c '/usr/bin/psql test ') &amp;&amp;
170echo "insert into t1 values ('Billy', 'NewYork');" \
171 | (su - postgres -c '/usr/bin/psql test ') &amp;&amp;
172echo "insert into t1 values ('Evanidus', 'Quebec');" \
173 | (su - postgres -c '/usr/bin/psql test ') &amp;&amp;
174echo "insert into t1 values ('Jesse', 'Ontario');" \
175 | (su - postgres -c '/usr/bin/psql test ') &amp;&amp;
176echo "select * from t1;" | (su - postgres -c '/usr/bin/psql test')</userinput></screen>
177
178 <para>To shut down the server, as <systemitem
179 class="username">root</systemitem>:</para>
180
181<screen role="root"><userinput>su - postgres -c "/usr/bin/pg_ctl stop -D /srv/pgsql/data"</userinput></screen>
182
183 </sect2>
184
185 <sect2 role="commands">
186 <title>Command Explanations</title>
187
188 <para>
189 <command>sed -i ...</command>: This sed changes server socket location
190 from <filename class="directory">/tmp</filename> to
191 <filename class="directory">/run/postgresql</filename><!-- and fix up the
192 regression tests to use <filename class="directory">/tmp</filename> so
193 that they can work reliably-->. Second sed renames a function as
194 glibc-2.27 introduced one with the same name.
195 </para>
196
197 <para><parameter>--docdir=/usr/share/doc/postgresql-&postgresql-version;</parameter>:
198 This switch puts the documentation in a versioned directory.</para>
199
200 <para><parameter>--enable-thread-safety</parameter>: This switch makes the
201 client libraries thread-safe by allowing concurrent threads in
202 <filename class="libraryfile">libpq</filename> and ECPG programs to safely
203 control their private connection handles.</para>
204
205 <para><option>--with-openssl</option>: builds the package with support for
206 <application>OpenSSL</application> encrypted connections.</para>
207
208 <para><option>--with-perl</option>: builds the PL/Perl server-side language.
209 </para>
210
211 <para><option>--with-python</option>: builds the PL/Python server-side
212 language. Add PYTHON=/usr/bin/python3 for Python3 support.</para>
213
214 <para><option>--with-tcl</option>: builds the PL/Tcl server-side language.</para>
215
216 <para><command>groupadd ...</command>; <command>useradd ...</command>:
217 These commands add an unprivileged user and group to run the database
218 server.</para>
219
220 <para><command>createdb test; create table t1; insert into t1 values...;
221 select * from t1</command>: Create a database, add a table to it, insert
222 some rows into the table and select them to verify that the installation
223 is working properly.</para>
224
225 </sect2>
226
227 <sect2 role="configuration">
228 <title>Configuring PostgreSQL</title>
229
230 <sect3 id="postgresql-config">
231 <title>Config Files</title>
232
233 <para><filename>$PGDATA/pg_ident.con</filename>,
234 <filename>$PGDATA/pg_hba.conf</filename> and
235 <filename>$PGDATA/postgresql.conf</filename></para>
236
237 <indexterm zone="postgresql postgresql-config">
238 <primary sortas="e-A.PGDATA-pg_ident.con">$PGDATA/pg_indent.con</primary>
239 </indexterm>
240
241 <indexterm zone="postgresql postgresql-config">
242 <primary sortas="e-A.PGDATA-pg_hba.conf">$PGDATA/pg_hba_conf</primary>
243 </indexterm>
244
245 <indexterm zone="postgresql postgresql-config">
246 <primary sortas="e-A.PGDATA-postgresql.conf">$PGDATA/postgresql.conf</primary>
247 </indexterm>
248
249 <para>The <envar>PGDATA</envar> environment variable is used to
250 distinguish database clusters from one another by setting it to
251 the value of the directory which contains the cluster desired.
252 The three configuration files exist in every <filename
253 class="directory">PGDATA/</filename> directory. Details on the
254 format of the files and the options that can be set in each can
255 be found in <ulink
256 url="file:///usr/share/doc/postgresql-&postgresql-version;/html/index.html"/>.</para>
257
258 </sect3>
259
260 <sect3 id="postgresql-init">
261 <title><phrase revision="sysv">Boot Script</phrase>
262 <phrase revision="systemd">Systemd Unit</phrase></title>
263
264 <para>Install the
265 <phrase revision="sysv"><filename>/etc/rc.d/init.d/postgresql</filename>
266 init script</phrase>
267 <phrase revision="systemd"><filename>postgresql.service</filename>
268 unit</phrase> included in the
269 <xref linkend="bootscripts" revision="sysv"/>
270 <xref linkend="systemd-units" revision="systemd"/> package.</para>
271
272 <indexterm zone="postgresql postgresql-init">
273 <primary sortas="f-postgresql">postgresql</primary>
274 </indexterm>
275
276<screen role="root"><userinput>make install-postgresql</userinput></screen>
277
278 </sect3>
279
280 </sect2>
281
282 <sect2 role="content">
283 <title>Contents</title>
284
285 <segmentedlist>
286 <segtitle>Installed Programs</segtitle>
287 <segtitle>Installed Libraries</segtitle>
288 <segtitle>Installed Directories</segtitle>
289
290 <seglistitem>
291 <seg>
292 clusterdb, createdb, createlang, createuser, dropdb, droplang,
293 dropuser, ecpg, initdb, pg_archivecleanup, pg_basebackup, pg_config,
294 pg_controldata, pg_ctl, pg_dump, pg_dumpall, pg_isready,
295 pg_receivexlog, pg_recvlogical, pg_resetxlog, pg_restore, pg_rewind,
296 pg_test_fsync, pg_test_timing, pg_upgrade, pg_xlogdump, pgbench,
297 postgres, postmaster (deprecated), psql, reindexdb, vacuumdb,
298 optionally, if Tcl support has been built, pltcl_delmod,
299 pltcl_listmod, pltcl_loadmod, and optionally (in contrib/) oid2name,
300 pg_standby, vacuumlo, and many others
301
302 </seg>
303 <seg>
304 libecpg.{so,a}, libecpg_compat.{so,a}, libpgcommon.a, libpgport.a,
305 libpgtypes.{so,a}, libpq.{so,a}, various charset modules, and
306 optionally programming language modules under /usr/lib/postgresql
307 </seg>
308 <seg>
309 /usr/include/{libpq,postgresql},
310 /usr/lib/postgresql,
311 /usr/share/{doc/postgresql-&postgresql-version;,postgresql}, and
312 /srv/pgsql
313 </seg>
314 </seglistitem>
315 </segmentedlist>
316
317 <variablelist>
318 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
319 <?dbfo list-presentation="list"?>
320 <?dbhtml list-presentation="table"?>
321
322 <varlistentry id="clusterdb">
323 <term><command>clusterdb</command></term>
324 <listitem>
325 <para>is a utility for reclustering tables in a
326 <application>PostgreSQL</application> database.</para>
327 <indexterm zone="postgresql clusterdb">
328 <primary sortas="b-clusterdb">clusterdb</primary>
329 </indexterm>
330 </listitem>
331 </varlistentry>
332
333 <varlistentry id="createdb">
334 <term><command>createdb</command></term>
335 <listitem>
336 <para> creates a new <application>PostgreSQL</application>
337 database.</para>
338 <indexterm zone="postgresql createdb">
339 <primary sortas="b-createdb">createdb</primary>
340 </indexterm>
341 </listitem>
342 </varlistentry>
343
344 <varlistentry id="createlang">
345 <term><command>createlang</command></term>
346 <listitem>
347 <para>defines a new <application>PostgreSQL</application> procedural
348 language.</para>
349 <indexterm zone="postgresql createlang">
350 <primary sortas="b-createlang">createlang</primary>
351 </indexterm>
352 </listitem>
353 </varlistentry>
354
355 <varlistentry id="createuser">
356 <term><command>createuser</command></term>
357 <listitem>
358 <para>defines a new <application>PostgreSQL</application>
359 user account.</para>
360 <indexterm zone="postgresql createuser">
361 <primary sortas="b-createuser">createuser</primary>
362 </indexterm>
363 </listitem>
364 </varlistentry>
365
366 <varlistentry id="dropdb">
367 <term><command>dropdb</command></term>
368 <listitem>
369 <para>removes a <application>PostgreSQL</application> database.</para>
370 <indexterm zone="postgresql dropdb">
371 <primary sortas="b-dropdb">dropdb</primary>
372 </indexterm>
373 </listitem>
374 </varlistentry>
375
376 <varlistentry id="droplang">
377 <term><command>droplang</command></term>
378 <listitem>
379 <para>removes a <application>PostgreSQL</application> procedural
380 language.</para>
381 <indexterm zone="postgresql droplang">
382 <primary sortas="b-droplang">droplang</primary>
383 </indexterm>
384 </listitem>
385 </varlistentry>
386
387 <varlistentry id="dropuser">
388 <term><command>dropuser</command></term>
389 <listitem>
390 <para>removes a <application>PostgreSQL</application>
391 user account.</para>
392 <indexterm zone="postgresql dropuser">
393 <primary sortas="b-dropuser">dropuser</primary>
394 </indexterm>
395 </listitem>
396 </varlistentry>
397
398 <varlistentry id="ecpg">
399 <term><command>ecpg</command></term>
400 <listitem>
401 <para>is the embedded SQL preprocessor.</para>
402 <indexterm zone="postgresql ecpg">
403 <primary sortas="b-ecpg">ecpg</primary>
404 </indexterm>
405 </listitem>
406 </varlistentry>
407
408 <varlistentry id="initdb">
409 <term><command>initdb</command></term>
410 <listitem>
411 <para>creates a new database cluster.</para>
412 <indexterm zone="postgresql initdb">
413 <primary sortas="b-initdb">initdb</primary>
414 </indexterm>
415 </listitem>
416 </varlistentry>
417
418 <varlistentry id="oid2name">
419 <term><command>oid2name</command></term>
420 <listitem>
421 <para>resolves OIDs (Object IDs) and file nodes in a PostgreSQL data
422 directory.</para>
423 <indexterm zone="postgresql oid2name">
424 <primary sortas="b-oid2name">oid2name</primary>
425 </indexterm>
426 </listitem>
427 </varlistentry>
428
429 <varlistentry id="pg_archivecleanup">
430 <term><command>pg_archivecleanup</command></term>
431 <listitem>
432 <para>cleans up PostgreSQL WAL (write-ahead log) archive files.</para>
433 <indexterm zone="postgresql pg_archivecleanup">
434 <primary sortas="b-pg_archivecleanup">pg_archivecleanup</primary>
435 </indexterm>
436 </listitem>
437 </varlistentry>
438
439 <varlistentry id="pg_basebackup">
440 <term><command>pg_basebackup</command></term>
441 <listitem>
442 <para>takes base backups of a running
443 <application>PostgreSQL</application> cluster.</para>
444 <indexterm zone="postgresql pg_basebackup">
445 <primary sortas="b-pg_basebackup">pg_basebackup</primary>
446 </indexterm>
447 </listitem>
448 </varlistentry>
449
450 <varlistentry id="pg_config">
451 <term><command>pg_config</command></term>
452 <listitem>
453 <para>retrieves <application>PostgreSQL</application> version
454 information.</para>
455 <indexterm zone="postgresql pg_config">
456 <primary sortas="b-pg_config">pg_config</primary>
457 </indexterm>
458 </listitem>
459 </varlistentry>
460
461 <varlistentry id="pg_controldata">
462 <term><command>pg_controldata</command></term>
463 <listitem>
464 <para>returns information initialized during
465 <command>initdb</command>, such as the catalog version and server
466 locale.</para>
467 <indexterm zone="postgresql pg_controldata">
468 <primary sortas="b-pg_controldata">pg_controldata</primary>
469 </indexterm>
470 </listitem>
471 </varlistentry>
472
473 <varlistentry id="pg_ctl">
474 <term><command>pg_ctl</command></term>
475 <listitem>
476 <para>controls stopping and starting the database server.</para>
477 <indexterm zone="postgresql pg_ctl">
478 <primary sortas="b-pg_ctl">pg_ctl</primary>
479 </indexterm>
480 </listitem>
481 </varlistentry>
482
483 <varlistentry id="pg_dump">
484 <term><command>pg_dump</command></term>
485 <listitem>
486 <para>dumps database data and metadata into scripts which are used
487 to recreate the database.</para>
488 <indexterm zone="postgresql pg_dump">
489 <primary sortas="b-pg_dump">pg_dump</primary>
490 </indexterm>
491 </listitem>
492 </varlistentry>
493
494 <varlistentry id="pg_dumpall">
495 <term><command>pg_dumpall</command></term>
496 <listitem>
497 <para>recursively calls <command>pg_dump</command> for each
498 database in a cluster.</para>
499 <indexterm zone="postgresql pg_dumpall">
500 <primary sortas="b-pg_dumpall">pg_dumpall</primary>
501 </indexterm>
502 </listitem>
503 </varlistentry>
504
505 <varlistentry id="pg_isready">
506 <term><command>pg_isready</command></term>
507 <listitem>
508 <para>check the connection status of a PostgreSQL server.</para>
509 <indexterm zone="postgresql pg_isready">
510 <primary sortas="b-pg_isready">pg_isready</primary>
511 </indexterm>
512 </listitem>
513 </varlistentry>
514
515 <varlistentry id="pg_receivexlog">
516 <term><command>pg_receivexlog</command></term>
517 <listitem>
518 <para>
519 is used to stream transaction log from a running
520 PostgreSQL cluster.
521 </para>
522 <indexterm zone="postgresql pg_receivexlog">
523 <primary sortas="b-pg_receivexlog">pg_receivexlog</primary>
524 </indexterm>
525 </listitem>
526 </varlistentry>
527
528 <varlistentry id="pg_recvlogical">
529 <term><command>pg_recvlogical</command></term>
530 <listitem>
531 <para>controls PostgreSQL logical decoding streams.</para>
532 <indexterm zone="postgresql pg_recvlogical">
533 <primary sortas="b-pg_recvlogical">pg_recvlogical</primary>
534 </indexterm>
535 </listitem>
536 </varlistentry>
537
538 <varlistentry id="pg_resetxlog">
539 <term><command>pg_resetxlog</command></term>
540 <listitem>
541 <para>clears the write-ahead log and optionally resets some
542 fields in the <filename>pg_control</filename> file.</para>
543 <indexterm zone="postgresql pg_resetxlog">
544 <primary sortas="b-pg_resetxlog">pg_resetxlog</primary>
545 </indexterm>
546 </listitem>
547 </varlistentry>
548
549 <varlistentry id="pg_restore">
550 <term><command>pg_restore</command></term>
551 <listitem>
552 <para>creates databases from dump files created by
553 <command>pg_dump</command>.</para>
554 <indexterm zone="postgresql pg_restore">
555 <primary sortas="b-pg_restore">pg_restore</primary>
556 </indexterm>
557 </listitem>
558 </varlistentry>
559
560 <varlistentry id="pg_rewind">
561 <term><command>pg_rewind</command></term>
562 <listitem>
563 <para>synchronizes a PostgreSQL data directory with another data
564 directory that was forked from the first one.</para>
565 <indexterm zone="postgresql pg_rewind">
566 <primary sortas="b-pg_rewind">pg_rewind</primary>
567 </indexterm>
568 </listitem>
569 </varlistentry>
570
571 <varlistentry id="pg_standby">
572 <term><command>pg_standby</command></term>
573 <listitem>
574 <para>supports the creation of a PostgreSQL warm standby
575 server.</para>
576 <indexterm zone="postgresql pg_standby">
577 <primary sortas="b-pg_standby">pg_standby</primary>
578 </indexterm>
579 </listitem>
580 </varlistentry>
581
582 <varlistentry id="pg_test_fsync">
583 <term><command>pg_test_fsync</command></term>
584 <listitem>
585 <para>determine fastest wal_sync method for PostgreSQL.</para>
586 <indexterm zone="postgresql pg_test_fsync">
587 <primary sortas="b-pg_test_fsync">pg_test_fsync</primary>
588 </indexterm>
589 </listitem>
590 </varlistentry>
591
592 <varlistentry id="pg_test_timing">
593 <term><command>pg_test_timing</command></term>
594 <listitem>
595 <para>measure timing overhead.</para>
596 <indexterm zone="postgresql pg_test_timing">
597 <primary sortas="b-pg_test_timing">pg_test_timing</primary>
598 </indexterm>
599 </listitem>
600 </varlistentry>
601
602 <varlistentry id="pg_upgrade">
603 <term><command>pg_upgrade</command></term>
604 <listitem>
605 <para>upgrade a PostgreSQL server instance.</para>
606 <indexterm zone="postgresql pg_upgrade">
607 <primary sortas="b-pg_upgrade">pg_upgrade</primary>
608 </indexterm>
609 </listitem>
610 </varlistentry>
611
612 <varlistentry id="pg_xlogdump">
613 <term><command>pg_xlogdump</command></term>
614 <listitem>
615 <para>display a human-readable rendering of the write-ahead log of a
616 PostgreSQL database cluster.</para>
617 <indexterm zone="postgresql pg_xlogdump">
618 <primary sortas="b-pg_xlogdump">pg_xlogdump</primary>
619 </indexterm>
620 </listitem>
621 </varlistentry>
622
623 <varlistentry id="pgbench">
624 <term><command>pgbench</command></term>
625 <listitem>
626 <para>run a benchmark test on PostgreSQL.</para>
627 <indexterm zone="postgresql pgbench">
628 <primary sortas="b-pgbench">pgbench</primary>
629 </indexterm>
630 </listitem>
631 </varlistentry>
632
633 <varlistentry id="pltcl_delmod">
634 <term><command>pltcl_delmod</command></term>
635 <listitem>
636 <para>is a support script used to delete a module from a
637 PL/<application>Tcl</application> table. The command
638 requires the <ulink
639 url="http://flightaware.github.io/Pgtcl/">Pgtcl</ulink>
640 package to be installed also.</para>
641 <indexterm zone="postgresql pltcl_delmod">
642 <primary sortas="b-pltcl_delmod">pltcl_delmod</primary>
643 </indexterm>
644 </listitem>
645 </varlistentry>
646
647 <varlistentry id="pltcl_listmod">
648 <term><command>pltcl_listmod</command></term>
649 <listitem>
650 <para>is a support script used to list the modules in a
651 PL/<application>Tcl</application> table. The command
652 requires the <ulink
653 url="http://gborg.postgresql.org/project/pgtcl/">Pgtcl</ulink>
654 package to be installed also.</para>
655 <indexterm zone="postgresql pltcl_listmod">
656 <primary sortas="b-pltcl_listmod">pltcl_listmod</primary>
657 </indexterm>
658 </listitem>
659 </varlistentry>
660
661 <varlistentry id="pltcl_loadmod">
662 <term><command>pltcl_loadmod</command></term>
663 <listitem>
664 <para>is a support script used to load a module into a
665 PL/<application>Tcl</application> table. The command
666 requires the <ulink
667 url="http://gborg.postgresql.org/project/pgtcl/">Pgtcl</ulink>
668 package to be installed also.</para>
669 <indexterm zone="postgresql pltcl_loadmod">
670 <primary sortas="b-pltcl_loadmod">pltcl_loadmod</primary>
671 </indexterm>
672 </listitem>
673 </varlistentry>
674
675 <varlistentry id="postgres">
676 <term><command>postgres</command></term>
677 <listitem>
678 <para>is the PostgreSQL database server.</para>
679 <indexterm zone="postgresql postgres">
680 <primary sortas="b-postgres">postgres</primary>
681 </indexterm>
682 </listitem>
683 </varlistentry>
684
685 <varlistentry id="postmaster">
686 <term><command>postmaster</command></term>
687 <listitem>
688 <para>(deprecated, a symlink to <command>postgres</command>) is a
689 multi-user database daemon.</para>
690 <indexterm zone="postgresql postmaster">
691 <primary sortas="b-postmaster">postmaster</primary>
692 </indexterm>
693 </listitem>
694 </varlistentry>
695
696 <varlistentry id="psql">
697 <term><command>psql</command></term>
698 <listitem>
699 <para>is a console based database shell.</para>
700 <indexterm zone="postgresql psql">
701 <primary sortas="b-psql">psql</primary>
702 </indexterm>
703 </listitem>
704 </varlistentry>
705
706 <varlistentry id="reindexdb">
707 <term><command>reindexdb</command></term>
708 <listitem>
709 <para>is a utility for rebuilding indexes in a database.</para>
710 <indexterm zone="postgresql reindexdb">
711 <primary sortas="b-reindexdb">reindexdb</primary>
712 </indexterm>
713 </listitem>
714 </varlistentry>
715
716 <varlistentry id="vacuumdb">
717 <term><command>vacuumdb</command></term>
718 <listitem>
719 <para>compacts databases and generates statistics for the query
720 analyzer.</para>
721 <indexterm zone="postgresql vacuumdb">
722 <primary sortas="b-vacuumdb">vacuumdb</primary>
723 </indexterm>
724 </listitem>
725 </varlistentry>
726
727 <varlistentry id="vacuumlo">
728 <term><command>vacuumlo</command></term>
729 <listitem>
730 <para>remove orphaned large objects from a PostgreSQL database.</para>
731 <indexterm zone="postgresql vacuumlo">
732 <primary sortas="b-vacuumlo">vacuumlo</primary>
733 </indexterm>
734 </listitem>
735 </varlistentry>
736
737 <varlistentry id="libecpg">
738 <term><filename class='libraryfile'>libecpg.{so,a}</filename></term>
739 <listitem>
740 <para>contains functions to support embedded SQL in C programs.</para>
741 <indexterm zone="postgresql libecpg">
742 <primary sortas="c-libecpg">libecpg.{so,a}</primary>
743 </indexterm>
744 </listitem>
745 </varlistentry>
746
747 <varlistentry id="libecpg_compat">
748 <term><filename class='libraryfile'>libecpg_compat.{so,a}</filename></term>
749 <listitem>
750 <para>is the ecpg compatibility library.</para>
751 <indexterm zone="postgresql libecpg_compat">
752 <primary sortas="c-libecpg_compat">libecpg_compat.{so,a}</primary>
753 </indexterm>
754 </listitem>
755 </varlistentry>
756
757 <varlistentry id="libgport">
758 <term><filename class='libraryfile'>libgport.a</filename></term>
759 <listitem>
760 <para>is the port-specific subsystem of the Postgres backend.</para>
761 <indexterm zone="postgresql libgport">
762 <primary sortas="c-libgport">libgport.a</primary>
763 </indexterm>
764 </listitem>
765 </varlistentry>
766
767 <varlistentry id="libpgtypes">
768 <term><filename class='libraryfile'>libpgtypes.{so,a}</filename></term>
769 <listitem>
770 <para>contains functions for dealing with Postgres data types.</para>
771 <indexterm zone="postgresql libpgtypes">
772 <primary sortas="c-libpgtypes">libpgtypes.{so,a}</primary>
773 </indexterm>
774 </listitem>
775 </varlistentry>
776
777 <varlistentry id="libpq">
778 <term><filename class='libraryfile'>libpq.{so,a}</filename></term>
779 <listitem>
780 <para>is the C programmer's API to Postgres.</para>
781 <indexterm zone="postgresql libpq">
782 <primary sortas="c-libpq">libpq.{so,a}</primary>
783 </indexterm>
784 </listitem>
785 </varlistentry>
786
787 </variablelist>
788
789 </sect2>
790
791</sect1>
Note: See TracBrowser for help on using the repository browser.