source: server/databases/postgresql.xml@ ad6afb24

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 8.0 8.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 ad6afb24 was 3c4d525, checked in by Douglas R. Reno <renodr@…>, 7 years ago

Update to postgresql-9.6.2

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