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