source: server/databases/postgresql.xml@ ec7f767

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 ec7f767 was ec7f767, checked in by Thomas Trepl <thomas@…>, 6 years ago

postgresql: Add sed to come over a naming issue with new glibc-2.27

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