source: server/databases/postgresql.xml@ 79f9638

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

postgresql: Remove comment about obsolete sed (glibc-2.27 naming issue)

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