| 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://gd.tuwien.ac.at/db/postgresql/source/v&postgresql-version;/postgresql-&postgresql-version;.tar.bz2">
|
|---|
| 8 | <!ENTITY postgresql-download-ftp "ftp://ftp5.us.postgresql.org/pub/PostgreSQL/source/v&postgresql-version;/postgresql-&postgresql-version;.tar.bz2">
|
|---|
| 9 | <!-- <!ENTITY postgresql-download-http "&sources-anduin-http;/p/postgresql-&postgresql-version;.tar.bz2">
|
|---|
| 10 | <!ENTITY postgresql-download-ftp "&sources-anduin-ftp;/p/postgresql-&postgresql-version;.tar.bz2"> -->
|
|---|
| 11 | <!ENTITY postgresql-md5sum "a8035688dba988b782725ac1aec60186">
|
|---|
| 12 | <!ENTITY postgresql-size "15 MB">
|
|---|
| 13 | <!ENTITY postgresql-buildsize "174 MB (additional 143 MB to run the testsuite)">
|
|---|
| 14 | <!ENTITY postgresql-time "1.2 SBU (additional 0.3 SBU to run the testsuite)">
|
|---|
| 15 | ]>
|
|---|
| 16 |
|
|---|
| 17 | <sect1 id="postgresql" xreflabel="PostgreSQL-&postgresql-version;">
|
|---|
| 18 | <?dbhtml filename="postgresql.html"?>
|
|---|
| 19 |
|
|---|
| 20 | <sect1info>
|
|---|
| 21 | <othername>$LastChangedBy$</othername>
|
|---|
| 22 | <date>$Date$</date>
|
|---|
| 23 | </sect1info>
|
|---|
| 24 |
|
|---|
| 25 | <title>PostgreSQL-&postgresql-version;</title>
|
|---|
| 26 |
|
|---|
| 27 | <indexterm zone="postgresql">
|
|---|
| 28 | <primary sortas="a-PostgreSQL">PostgreSQL</primary>
|
|---|
| 29 | </indexterm>
|
|---|
| 30 |
|
|---|
| 31 | <sect2 role="package">
|
|---|
| 32 | <title>Introduction to PostgreSQL</title>
|
|---|
| 33 |
|
|---|
| 34 | <para><application>PostgreSQL</application> is an advanced
|
|---|
| 35 | object-relational database management system (ORDBMS), derived
|
|---|
| 36 | from the Berkeley Postgres database management system.</para>
|
|---|
| 37 |
|
|---|
| 38 | <para>There may be a more recent release available from the
|
|---|
| 39 | <application>PostgreSQL</application> home page. You can check
|
|---|
| 40 | <ulink url="http://www.postgresql.org/"/> and probably use the
|
|---|
| 41 | existing BLFS instructions. Note that versions other than the one shown
|
|---|
| 42 | in the download URLs have not been tested in a BLFS environment.</para>
|
|---|
| 43 |
|
|---|
| 44 | &lfs70_checked;
|
|---|
| 45 |
|
|---|
| 46 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
|---|
| 47 | <itemizedlist spacing="compact">
|
|---|
| 48 | <listitem>
|
|---|
| 49 | <para>Download (HTTP): <ulink url="&postgresql-download-http;"/></para>
|
|---|
| 50 | </listitem>
|
|---|
| 51 | <listitem>
|
|---|
| 52 | <para>Download (FTP): <ulink url="&postgresql-download-ftp;"/></para>
|
|---|
| 53 | </listitem>
|
|---|
| 54 | <listitem>
|
|---|
| 55 | <para>Download MD5 sum: &postgresql-md5sum;</para>
|
|---|
| 56 | </listitem>
|
|---|
| 57 | <listitem>
|
|---|
| 58 | <para>Download size: &postgresql-size;</para>
|
|---|
| 59 | </listitem>
|
|---|
| 60 | <listitem>
|
|---|
| 61 | <para>Estimated disk space required: &postgresql-buildsize;</para>
|
|---|
| 62 | </listitem>
|
|---|
| 63 | <listitem>
|
|---|
| 64 | <para>Estimated build time: &postgresql-time;</para>
|
|---|
| 65 | </listitem>
|
|---|
| 66 | </itemizedlist>
|
|---|
| 67 |
|
|---|
| 68 | <bridgehead renderas="sect3">PostgreSQL Dependencies</bridgehead>
|
|---|
| 69 |
|
|---|
| 70 | <bridgehead renderas="sect4">Optional</bridgehead>
|
|---|
| 71 | <para role="optional"><xref linkend="python2"/>,
|
|---|
| 72 | <xref linkend="tcl"/>,
|
|---|
| 73 | <xref linkend="openssl"/>,
|
|---|
| 74 | <xref linkend="libxml2"/>,
|
|---|
| 75 | <xref linkend="libxslt"/>,
|
|---|
| 76 | <xref linkend="openldap"/>,
|
|---|
| 77 | <xref linkend="linux-pam"/>,
|
|---|
| 78 | <!-- link is dead, no other suitable GSSAPI links found
|
|---|
| 79 | <ulink url="http://www.pdc.kth.se/kth-krb/">krb4</ulink>, -->
|
|---|
| 80 | <xref linkend="mitkrb"/> and
|
|---|
| 81 | <ulink url="http://developer.apple.com/networking/bonjour/">Bonjour</ulink></para>
|
|---|
| 82 |
|
|---|
| 83 | <bridgehead renderas="sect4">Optional (To Regenerate Documentation)</bridgehead>
|
|---|
| 84 | <para role="optional"><xref linkend="sgml-dtd"/>,
|
|---|
| 85 | <xref linkend="docbook-dsssl"/>,
|
|---|
| 86 | <xref linkend="openjade"/>, and
|
|---|
| 87 | <xref linkend="perl-sgmlspm"/></para>
|
|---|
| 88 |
|
|---|
| 89 | <para condition="html" role="usernotes">User Notes:
|
|---|
| 90 | <ulink url="&blfs-wiki;/postgresql"/></para>
|
|---|
| 91 |
|
|---|
| 92 | </sect2>
|
|---|
| 93 |
|
|---|
| 94 | <sect2 role="installation">
|
|---|
| 95 | <title>Installation of PostgreSQL</title>
|
|---|
| 96 |
|
|---|
| 97 | <para>Install <application>PostgreSQL</application> with the
|
|---|
| 98 | following commands: </para>
|
|---|
| 99 |
|
|---|
| 100 | <!-- commented : regeneration is unnecessary, and we don't tell people the
|
|---|
| 101 | command to do it.
|
|---|
| 102 | <para>If you intend to regenerate the html documentation, issue the
|
|---|
| 103 | following command:</para>
|
|---|
| 104 | <screen><userinput>sed -i "s|dsssl-stylesheets|& \\\\\n sgml/docbook/&-&docbook-dsssl-version;|" \
|
|---|
| 105 | configure</userinput></screen>-->
|
|---|
| 106 |
|
|---|
| 107 | <para>Now configure and build the package:</para>
|
|---|
| 108 |
|
|---|
| 109 | <screen><userinput>./configure --prefix=/usr \
|
|---|
| 110 | --docdir=/usr/share/doc/postgresql-&postgresql-version; \
|
|---|
| 111 | --enable-thread-safety &&
|
|---|
| 112 | make</userinput></screen>
|
|---|
| 113 |
|
|---|
| 114 | <para>To test the results, issue: <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 &&
|
|---|
| 119 | make install-docs &&
|
|---|
| 120 | chown -v root:root /usr/share/doc/postgresql-&postgresql-version;/html/*</userinput></screen>
|
|---|
| 121 |
|
|---|
| 122 | <!-- 'Upgrading' seems to only ever exist in the docs for *previous* version -->
|
|---|
| 123 | <note>
|
|---|
| 124 | <para>If you are upgrading an existing system and are going to install
|
|---|
| 125 | the new files over the old ones, then you should back up your data, shut
|
|---|
| 126 | down the old server and follow the instructions in <ulink
|
|---|
| 127 | url="http://www.postgresql.org/docs/9.0/static/install-upgrading.html">the
|
|---|
| 128 | official <application>PostgreSQL</application> documentation</ulink>.</para>
|
|---|
| 129 | </note>
|
|---|
| 130 |
|
|---|
| 131 | <para>Initialize a database cluster with the following commands issued by the
|
|---|
| 132 | <systemitem class="username">root</systemitem> user:</para>
|
|---|
| 133 |
|
|---|
| 134 | <screen role="root"><userinput>install -v -m700 -d /srv/pgsql/data &&
|
|---|
| 135 | groupadd -g 41 postgres &&
|
|---|
| 136 | useradd -c "PostgreSQL Server" -g postgres -d /srv/pgsql/data \
|
|---|
| 137 | -u 41 postgres &&
|
|---|
| 138 | chown -v postgres /srv/pgsql/data &&
|
|---|
| 139 | su - postgres -c '/usr/bin/initdb -D /srv/pgsql/data'</userinput></screen>
|
|---|
| 140 |
|
|---|
| 141 | <para>As the <systemitem class="username">root</systemitem> user, start the
|
|---|
| 142 | database server with the following command:</para>
|
|---|
| 143 |
|
|---|
| 144 | <screen role="root"><userinput>su - postgres -c '/usr/bin/postmaster -D /srv/pgsql/data > \
|
|---|
| 145 | /srv/pgsql/data/logfile 2>&1 &'</userinput></screen>
|
|---|
| 146 |
|
|---|
| 147 | <para>Still as user <systemitem class="username">root</systemitem>, create
|
|---|
| 148 | a database and verify the installation:</para>
|
|---|
| 149 |
|
|---|
| 150 | <screen role="root"><userinput>su - postgres -c '/usr/bin/createdb test' &&
|
|---|
| 151 | echo "create table t1 ( name varchar(20), state_province varchar(20) );" \
|
|---|
| 152 | | (su - postgres -c '/usr/bin/psql test ') &&
|
|---|
| 153 | echo "insert into t1 values ('Billy', 'NewYork');" \
|
|---|
| 154 | | (su - postgres -c '/usr/bin/psql test ') &&
|
|---|
| 155 | echo "insert into t1 values ('Evanidus', 'Quebec');" \
|
|---|
| 156 | | (su - postgres -c '/usr/bin/psql test ') &&
|
|---|
| 157 | echo "insert into t1 values ('Jesse', 'Ontario');" \
|
|---|
| 158 | | (su - postgres -c '/usr/bin/psql test ') &&
|
|---|
| 159 | echo "select * from t1;" | (su - postgres -c '/usr/bin/psql test')</userinput></screen>
|
|---|
| 160 |
|
|---|
| 161 | </sect2>
|
|---|
| 162 |
|
|---|
| 163 | <sect2 role="commands">
|
|---|
| 164 | <title>Command Explanations</title>
|
|---|
| 165 |
|
|---|
| 166 | <!-- commented : regeneration is unnecessary, and we don't tell people the
|
|---|
| 167 | command to do it.
|
|---|
| 168 | <para><command>sed -i "s|dsssl-stylesheets|..."</command>: This command
|
|---|
| 169 | puts an extra line in the <command>configure</command> script so that the
|
|---|
| 170 | BLFS installed version of the DSSSL stylesheets are discovered.</para> -->
|
|---|
| 171 |
|
|---|
| 172 | <para><parameter>--docdir=/usr/share/doc/postgresql-&postgresql-version;</parameter>:
|
|---|
| 173 | This switch puts the html (and pdf, if created) docs in a versioned
|
|---|
| 174 | directory.</para>
|
|---|
| 175 |
|
|---|
| 176 | <para><parameter>--enable-thread-safety</parameter>: This switch makes the
|
|---|
| 177 | client libraries thread-safe by allowing concurrent threads in
|
|---|
| 178 | <filename class='libraryfile'>libpq</filename> and ECPG programs to safely
|
|---|
| 179 | control their private connection handles.</para>
|
|---|
| 180 |
|
|---|
| 181 | <para><option>--with-openssl</option>: build with support for
|
|---|
| 182 | <application>OpenSSL</application> encrypted connections.</para>
|
|---|
| 183 |
|
|---|
| 184 | <para><option>--with-perl</option>: build the PL/Perl server-side language.
|
|---|
| 185 | </para>
|
|---|
| 186 |
|
|---|
| 187 | <para><option>--with-python</option>: build the PL/Python server-side
|
|---|
| 188 | language.</para>
|
|---|
| 189 |
|
|---|
| 190 | <para><option>--with-tcl</option>: build the PL/Tcl server-side language.</para>
|
|---|
| 191 |
|
|---|
| 192 | <para><command>chown -v root:root /usr/share/doc/postgresql-&postgresql-version;/html/*</command>:
|
|---|
| 193 | This command corrects the improper ownership of documentation files.</para>
|
|---|
| 194 |
|
|---|
| 195 | <para><command>groupadd ...</command>; <command>useradd ...</command>:
|
|---|
| 196 | These commands add an unprivileged user and group to run the database
|
|---|
| 197 | server.</para>
|
|---|
| 198 |
|
|---|
| 199 | <para><command>createdb test; create table t1; insert into t1 values...;
|
|---|
| 200 | select * from t1</command>: Create a database, add a table to it, insert
|
|---|
| 201 | some rows into the table and select them to verify that the installation
|
|---|
| 202 | is working properly.</para>
|
|---|
| 203 |
|
|---|
| 204 | </sect2>
|
|---|
| 205 |
|
|---|
| 206 | <sect2 role="configuration">
|
|---|
| 207 | <title>Configuring PostgreSQL</title>
|
|---|
| 208 |
|
|---|
| 209 | <sect3 id="postgresql-config">
|
|---|
| 210 | <title>Config Files</title>
|
|---|
| 211 |
|
|---|
| 212 | <para><filename>$PGDATA/pg_ident.con</filename>,
|
|---|
| 213 | <filename>$PGDATA/pg_hba.conf</filename> and
|
|---|
| 214 | <filename>$PGDATA/postgresql.conf</filename></para>
|
|---|
| 215 |
|
|---|
| 216 | <indexterm zone="postgresql postgresql-config">
|
|---|
| 217 | <primary sortas="e-A.PGDATA-pg_ident.con">$PGDATA/pg_indent.con</primary>
|
|---|
| 218 | </indexterm>
|
|---|
| 219 |
|
|---|
| 220 | <indexterm zone="postgresql postgresql-config">
|
|---|
| 221 | <primary sortas="e-A.PGDATA-pg_hba.conf">$PGDATA/pg_hba_conf</primary>
|
|---|
| 222 | </indexterm>
|
|---|
| 223 |
|
|---|
| 224 | <indexterm zone="postgresql postgresql-config">
|
|---|
| 225 | <primary sortas="e-A.PGDATA-postgresql.conf">$PGDATA/postgresql.conf</primary>
|
|---|
| 226 | </indexterm>
|
|---|
| 227 |
|
|---|
| 228 | <para>The <envar>PGDATA</envar> environment variable is used to
|
|---|
| 229 | distinguish database clusters from one another by setting it to
|
|---|
| 230 | the value of the directory which contains the cluster desired.
|
|---|
| 231 | The three configuration files exist in every <filename
|
|---|
| 232 | class="directory">PGDATA/</filename> directory. Details on the
|
|---|
| 233 | format of the files and the options that can be set in each can
|
|---|
| 234 | be found in <ulink
|
|---|
| 235 | url="file:///usr/share/doc/postgresql-&postgresql-version;/html/index.html"/>.</para>
|
|---|
| 236 |
|
|---|
| 237 | </sect3>
|
|---|
| 238 |
|
|---|
| 239 | <sect3 id="postgresql-init">
|
|---|
| 240 | <title>Boot Script</title>
|
|---|
| 241 |
|
|---|
| 242 | <para>Install the <filename>/etc/rc.d/init.d/postgresql</filename>
|
|---|
| 243 | init script included in the
|
|---|
| 244 | <xref linkend="bootscripts"/> package.</para>
|
|---|
| 245 |
|
|---|
| 246 | <indexterm zone="postgresql postgresql-init">
|
|---|
| 247 | <primary sortas="f-postgresql">postgresql</primary>
|
|---|
| 248 | </indexterm>
|
|---|
| 249 |
|
|---|
| 250 | <screen role="root"><userinput>make install-postgresql</userinput></screen>
|
|---|
| 251 |
|
|---|
| 252 | </sect3>
|
|---|
| 253 |
|
|---|
| 254 | </sect2>
|
|---|
| 255 |
|
|---|
| 256 | <sect2 role="content">
|
|---|
| 257 | <title>Contents</title>
|
|---|
| 258 |
|
|---|
| 259 | <segmentedlist>
|
|---|
| 260 | <segtitle>Installed Programs</segtitle>
|
|---|
| 261 | <segtitle>Installed Libraries</segtitle>
|
|---|
| 262 | <segtitle>Installed Directories</segtitle>
|
|---|
| 263 |
|
|---|
| 264 | <seglistitem>
|
|---|
| 265 | <seg>clusterdb, createdb, createlang, createuser, dropdb, droplang,
|
|---|
| 266 | dropuser, ecpg, initdb, pg_basebackup, pg_config, pg_controldata, pg_ctl,
|
|---|
| 267 | pg_dump, pg_dumpall, pg_resetxlog, pg_restore, pltcl_delmod,
|
|---|
| 268 | pltcl_listmod, pltcl_loadmod, postgres, postmaster, psql,
|
|---|
| 269 | reindexdb, and vacuumdb</seg>
|
|---|
| 270 | <seg>libecpg.{so,a}, libecpg_compat.{so,a}, libpgport.a, libpgtypes.{so,a},
|
|---|
| 271 | libpq.{so,a}, and various charset (and optionally, programming language)
|
|---|
| 272 | modules.</seg>
|
|---|
| 273 | <seg>/srv/pgsql, /usr/include/libpq, /usr/include/postgresql,
|
|---|
| 274 | /usr/lib/postgresql, /usr/share/doc/postgresql-&postgresql-version;, and
|
|---|
| 275 | /usr/share/postgresql</seg>
|
|---|
| 276 | </seglistitem>
|
|---|
| 277 | </segmentedlist>
|
|---|
| 278 |
|
|---|
| 279 | <variablelist>
|
|---|
| 280 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|---|
| 281 | <?dbfo list-presentation="list"?>
|
|---|
| 282 | <?dbhtml list-presentation="table"?>
|
|---|
| 283 |
|
|---|
| 284 | <varlistentry id="clusterdb">
|
|---|
| 285 | <term><command>clusterdb</command></term>
|
|---|
| 286 | <listitem>
|
|---|
| 287 | <para>is a utility for reclustering tables in a
|
|---|
| 288 | <application>PostgreSQL</application> database.</para>
|
|---|
| 289 | <indexterm zone="postgresql clusterdb">
|
|---|
| 290 | <primary sortas="b-clusterdb">clusterdb</primary>
|
|---|
| 291 | </indexterm>
|
|---|
| 292 | </listitem>
|
|---|
| 293 | </varlistentry>
|
|---|
| 294 |
|
|---|
| 295 | <varlistentry id="createdb">
|
|---|
| 296 | <term><command>createdb</command></term>
|
|---|
| 297 | <listitem>
|
|---|
| 298 | <para> creates a new <application>PostgreSQL</application>
|
|---|
| 299 | database.</para>
|
|---|
| 300 | <indexterm zone="postgresql createdb">
|
|---|
| 301 | <primary sortas="b-createdb">createdb</primary>
|
|---|
| 302 | </indexterm>
|
|---|
| 303 | </listitem>
|
|---|
| 304 | </varlistentry>
|
|---|
| 305 |
|
|---|
| 306 | <varlistentry id="createlang">
|
|---|
| 307 | <term><command>createlang</command></term>
|
|---|
| 308 | <listitem>
|
|---|
| 309 | <para>defines a new <application>PostgreSQL</application> procedural
|
|---|
| 310 | language.</para>
|
|---|
| 311 | <indexterm zone="postgresql createlang">
|
|---|
| 312 | <primary sortas="b-createlang">createlang</primary>
|
|---|
| 313 | </indexterm>
|
|---|
| 314 | </listitem>
|
|---|
| 315 | </varlistentry>
|
|---|
| 316 |
|
|---|
| 317 | <varlistentry id="createuser">
|
|---|
| 318 | <term><command>createuser</command></term>
|
|---|
| 319 | <listitem>
|
|---|
| 320 | <para>defines a new <application>PostgreSQL</application>
|
|---|
| 321 | user account.</para>
|
|---|
| 322 | <indexterm zone="postgresql createuser">
|
|---|
| 323 | <primary sortas="b-createuser">createuser</primary>
|
|---|
| 324 | </indexterm>
|
|---|
| 325 | </listitem>
|
|---|
| 326 | </varlistentry>
|
|---|
| 327 |
|
|---|
| 328 | <varlistentry id="dropdb">
|
|---|
| 329 | <term><command>dropdb</command></term>
|
|---|
| 330 | <listitem>
|
|---|
| 331 | <para>removes a <application>PostgreSQL</application> database.</para>
|
|---|
| 332 | <indexterm zone="postgresql dropdb">
|
|---|
| 333 | <primary sortas="b-dropdb">dropdb</primary>
|
|---|
| 334 | </indexterm>
|
|---|
| 335 | </listitem>
|
|---|
| 336 | </varlistentry>
|
|---|
| 337 |
|
|---|
| 338 | <varlistentry id="droplang">
|
|---|
| 339 | <term><command>droplang</command></term>
|
|---|
| 340 | <listitem>
|
|---|
| 341 | <para>removes a <application>PostgreSQL</application> procedural
|
|---|
| 342 | language.</para>
|
|---|
| 343 | <indexterm zone="postgresql droplang">
|
|---|
| 344 | <primary sortas="b-droplang">droplang</primary>
|
|---|
| 345 | </indexterm>
|
|---|
| 346 | </listitem>
|
|---|
| 347 | </varlistentry>
|
|---|
| 348 |
|
|---|
| 349 | <varlistentry id="dropuser">
|
|---|
| 350 | <term><command>dropuser</command></term>
|
|---|
| 351 | <listitem>
|
|---|
| 352 | <para>removes a <application>PostgreSQL</application>
|
|---|
| 353 | user account.</para>
|
|---|
| 354 | <indexterm zone="postgresql dropuser">
|
|---|
| 355 | <primary sortas="b-dropuser">dropuser</primary>
|
|---|
| 356 | </indexterm>
|
|---|
| 357 | </listitem>
|
|---|
| 358 | </varlistentry>
|
|---|
| 359 |
|
|---|
| 360 | <varlistentry id="ecpg">
|
|---|
| 361 | <term><command>ecpg</command></term>
|
|---|
| 362 | <listitem>
|
|---|
| 363 | <para>is the embedded SQL preprocessor.</para>
|
|---|
| 364 | <indexterm zone="postgresql ecpg">
|
|---|
| 365 | <primary sortas="b-ecpg">ecpg</primary>
|
|---|
| 366 | </indexterm>
|
|---|
| 367 | </listitem>
|
|---|
| 368 | </varlistentry>
|
|---|
| 369 |
|
|---|
| 370 | <varlistentry id="initdb">
|
|---|
| 371 | <term><command>initdb</command></term>
|
|---|
| 372 | <listitem>
|
|---|
| 373 | <para>creates a new database cluster.</para>
|
|---|
| 374 | <indexterm zone="postgresql initdb">
|
|---|
| 375 | <primary sortas="b-initdb">initdb</primary>
|
|---|
| 376 | </indexterm>
|
|---|
| 377 | </listitem>
|
|---|
| 378 | </varlistentry>
|
|---|
| 379 |
|
|---|
| 380 | <varlistentry id="pg_basebackup">
|
|---|
| 381 | <term><command>pg_basebackup</command></term>
|
|---|
| 382 | <listitem>
|
|---|
| 383 | <para>takes base backups of a running
|
|---|
| 384 | <application>PostgreSQL</application> cluster.</para>
|
|---|
| 385 | <indexterm zone="postgresql pg_basebackup">
|
|---|
| 386 | <primary sortas="b-pg_basebackup">pg_basebackup</primary>
|
|---|
| 387 | </indexterm>
|
|---|
| 388 | </listitem>
|
|---|
| 389 | </varlistentry>
|
|---|
| 390 |
|
|---|
| 391 | <varlistentry id="pg_config">
|
|---|
| 392 | <term><command>pg_config</command></term>
|
|---|
| 393 | <listitem>
|
|---|
| 394 | <para>retrieves <application>PostgreSQL</application> version
|
|---|
| 395 | information.</para>
|
|---|
| 396 | <indexterm zone="postgresql pg_config">
|
|---|
| 397 | <primary sortas="b-pg_config">pg_config</primary>
|
|---|
| 398 | </indexterm>
|
|---|
| 399 | </listitem>
|
|---|
| 400 | </varlistentry>
|
|---|
| 401 |
|
|---|
| 402 | <varlistentry id="pg_controldata">
|
|---|
| 403 | <term><command>pg_controldata</command></term>
|
|---|
| 404 | <listitem>
|
|---|
| 405 | <para>returns information initialized during
|
|---|
| 406 | <command>initdb</command>, such as the catalog version and server
|
|---|
| 407 | locale.</para>
|
|---|
| 408 | <indexterm zone="postgresql pg_controldata">
|
|---|
| 409 | <primary sortas="b-pg_controldata">pg_controldata</primary>
|
|---|
| 410 | </indexterm>
|
|---|
| 411 | </listitem>
|
|---|
| 412 | </varlistentry>
|
|---|
| 413 |
|
|---|
| 414 | <varlistentry id="pg_ctl">
|
|---|
| 415 | <term><command>pg_ctl</command></term>
|
|---|
| 416 | <listitem>
|
|---|
| 417 | <para>controls stopping and starting the database server.</para>
|
|---|
| 418 | <indexterm zone="postgresql pg_ctl">
|
|---|
| 419 | <primary sortas="b-pg_ctl">pg_ctl</primary>
|
|---|
| 420 | </indexterm>
|
|---|
| 421 | </listitem>
|
|---|
| 422 | </varlistentry>
|
|---|
| 423 |
|
|---|
| 424 | <varlistentry id="pg_dump">
|
|---|
| 425 | <term><command>pg_dump</command></term>
|
|---|
| 426 | <listitem>
|
|---|
| 427 | <para>dumps database data and metadata into scripts which are used
|
|---|
| 428 | to recreate the database.</para>
|
|---|
| 429 | <indexterm zone="postgresql pg_dump">
|
|---|
| 430 | <primary sortas="b-pg_dump">pg_dump</primary>
|
|---|
| 431 | </indexterm>
|
|---|
| 432 | </listitem>
|
|---|
| 433 | </varlistentry>
|
|---|
| 434 |
|
|---|
| 435 | <varlistentry id="pg_dumpall">
|
|---|
| 436 | <term><command>pg_dumpall</command></term>
|
|---|
| 437 | <listitem>
|
|---|
| 438 | <para>recursively calls <command>pg_dump</command> for each
|
|---|
| 439 | database in a cluster.</para>
|
|---|
| 440 | <indexterm zone="postgresql pg_dumpall">
|
|---|
| 441 | <primary sortas="b-pg_dumpall">pg_dumpall</primary>
|
|---|
| 442 | </indexterm>
|
|---|
| 443 | </listitem>
|
|---|
| 444 | </varlistentry>
|
|---|
| 445 |
|
|---|
| 446 | <varlistentry id="pg_resetxlog">
|
|---|
| 447 | <term><command>pg_resetxlog</command></term>
|
|---|
| 448 | <listitem>
|
|---|
| 449 | <para>clears the write-ahead log and optionally resets some
|
|---|
| 450 | fields in the <filename>pg_control</filename> file.</para>
|
|---|
| 451 | <indexterm zone="postgresql pg_resetxlog">
|
|---|
| 452 | <primary sortas="b-pg_resetxlog">pg_resetxlog</primary>
|
|---|
| 453 | </indexterm>
|
|---|
| 454 | </listitem>
|
|---|
| 455 | </varlistentry>
|
|---|
| 456 |
|
|---|
| 457 | <varlistentry id="pg_restore">
|
|---|
| 458 | <term><command>pg_restore</command></term>
|
|---|
| 459 | <listitem>
|
|---|
| 460 | <para>creates databases from dump files created by
|
|---|
| 461 | <command>pg_dump</command>.</para>
|
|---|
| 462 | <indexterm zone="postgresql pg_restore">
|
|---|
| 463 | <primary sortas="b-pg_restore">pg_restore</primary>
|
|---|
| 464 | </indexterm>
|
|---|
| 465 | </listitem>
|
|---|
| 466 | </varlistentry>
|
|---|
| 467 |
|
|---|
| 468 | <varlistentry id="pltcl_delmod">
|
|---|
| 469 | <term><command>pltcl_delmod</command></term>
|
|---|
| 470 | <listitem>
|
|---|
| 471 | <para>is a support script used to delete a module from a
|
|---|
| 472 | PL/<application>Tcl</application> table. The command
|
|---|
| 473 | requires the <ulink
|
|---|
| 474 | url="http://gborg.postgresql.org/project/pgtcl/">Pgtcl</ulink>
|
|---|
| 475 | package to be installed also.</para>
|
|---|
| 476 | <indexterm zone="postgresql pltcl_delmod">
|
|---|
| 477 | <primary sortas="b-pltcl_delmod">pltcl_delmod</primary>
|
|---|
| 478 | </indexterm>
|
|---|
| 479 | </listitem>
|
|---|
| 480 | </varlistentry>
|
|---|
| 481 |
|
|---|
| 482 | <varlistentry id="pltcl_listmod">
|
|---|
| 483 | <term><command>pltcl_listmod</command></term>
|
|---|
| 484 | <listitem>
|
|---|
| 485 | <para>is a support script used to list the modules in a
|
|---|
| 486 | PL/<application>Tcl</application> table. The command
|
|---|
| 487 | requires the <ulink
|
|---|
| 488 | url="http://gborg.postgresql.org/project/pgtcl/">Pgtcl</ulink>
|
|---|
| 489 | package to be installed also.</para>
|
|---|
| 490 | <indexterm zone="postgresql pltcl_listmod">
|
|---|
| 491 | <primary sortas="b-pltcl_listmod">pltcl_listmod</primary>
|
|---|
| 492 | </indexterm>
|
|---|
| 493 | </listitem>
|
|---|
| 494 | </varlistentry>
|
|---|
| 495 |
|
|---|
| 496 | <varlistentry id="pltcl_loadmod">
|
|---|
| 497 | <term><command>pltcl_loadmod</command></term>
|
|---|
| 498 | <listitem>
|
|---|
| 499 | <para>is a support script used to load a module into a
|
|---|
| 500 | PL/<application>Tcl</application> table. The command
|
|---|
| 501 | requires the <ulink
|
|---|
| 502 | url="http://gborg.postgresql.org/project/pgtcl/">Pgtcl</ulink>
|
|---|
| 503 | package to be installed also.</para>
|
|---|
| 504 | <indexterm zone="postgresql pltcl_loadmod">
|
|---|
| 505 | <primary sortas="b-pltcl_loadmod">pltcl_loadmod</primary>
|
|---|
| 506 | </indexterm>
|
|---|
| 507 | </listitem>
|
|---|
| 508 | </varlistentry>
|
|---|
| 509 |
|
|---|
| 510 | <varlistentry id="postgres">
|
|---|
| 511 | <term><command>postgres</command></term>
|
|---|
| 512 | <listitem>
|
|---|
| 513 | <para>is a single user database server, generally used for
|
|---|
| 514 | debugging.</para>
|
|---|
| 515 | <indexterm zone="postgresql postgres">
|
|---|
| 516 | <primary sortas="b-postgres">postgres</primary>
|
|---|
| 517 | </indexterm>
|
|---|
| 518 | </listitem>
|
|---|
| 519 | </varlistentry>
|
|---|
| 520 |
|
|---|
| 521 | <varlistentry id="postmaster">
|
|---|
| 522 | <term><command>postmaster</command></term>
|
|---|
| 523 | <listitem>
|
|---|
| 524 | <para>(a symlink to <command>postgres</command>) is a multi-user
|
|---|
| 525 | database daemon.</para>
|
|---|
| 526 | <indexterm zone="postgresql postmaster">
|
|---|
| 527 | <primary sortas="b-postmaster">postmaster</primary>
|
|---|
| 528 | </indexterm>
|
|---|
| 529 | </listitem>
|
|---|
| 530 | </varlistentry>
|
|---|
| 531 |
|
|---|
| 532 | <varlistentry id="psql">
|
|---|
| 533 | <term><command>psql</command></term>
|
|---|
| 534 | <listitem>
|
|---|
| 535 | <para>is a console based database shell.</para>
|
|---|
| 536 | <indexterm zone="postgresql psql">
|
|---|
| 537 | <primary sortas="b-psql">psql</primary>
|
|---|
| 538 | </indexterm>
|
|---|
| 539 | </listitem>
|
|---|
| 540 | </varlistentry>
|
|---|
| 541 |
|
|---|
| 542 | <varlistentry id="reindexdb">
|
|---|
| 543 | <term><command>reindexdb</command></term>
|
|---|
| 544 | <listitem>
|
|---|
| 545 | <para>is a utility for rebuilding indexes in a database.</para>
|
|---|
| 546 | <indexterm zone="postgresql reindexdb">
|
|---|
| 547 | <primary sortas="b-reindexdb">reindexdb</primary>
|
|---|
| 548 | </indexterm>
|
|---|
| 549 | </listitem>
|
|---|
| 550 | </varlistentry>
|
|---|
| 551 |
|
|---|
| 552 | <varlistentry id="vacuumdb">
|
|---|
| 553 | <term><command>vacuumdb</command></term>
|
|---|
| 554 | <listitem>
|
|---|
| 555 | <para>compacts databases and generates statistics for the query
|
|---|
| 556 | analyzer.</para>
|
|---|
| 557 | <indexterm zone="postgresql vacuumdb">
|
|---|
| 558 | <primary sortas="b-vacuumdb">vacuumdb</primary>
|
|---|
| 559 | </indexterm>
|
|---|
| 560 | </listitem>
|
|---|
| 561 | </varlistentry>
|
|---|
| 562 |
|
|---|
| 563 | <varlistentry id="libecpg">
|
|---|
| 564 | <term><filename class='libraryfile'>libecpg.{so,a}</filename></term>
|
|---|
| 565 | <listitem>
|
|---|
| 566 | <para>contains functions to support embedded SQL in C programs.</para>
|
|---|
| 567 | <indexterm zone="postgresql libecpg">
|
|---|
| 568 | <primary sortas="c-libecpg">libecpg.{so,a}</primary>
|
|---|
| 569 | </indexterm>
|
|---|
| 570 | </listitem>
|
|---|
| 571 | </varlistentry>
|
|---|
| 572 |
|
|---|
| 573 | <varlistentry id="libecpg_compat">
|
|---|
| 574 | <term><filename class='libraryfile'>libecpg_compat.{so,a}</filename></term>
|
|---|
| 575 | <listitem>
|
|---|
| 576 | <para>is the ecpg compatability library.</para>
|
|---|
| 577 | <indexterm zone="postgresql libecpg_compat">
|
|---|
| 578 | <primary sortas="c-libecpg_compat">libecpg_compat.{so,a}</primary>
|
|---|
| 579 | </indexterm>
|
|---|
| 580 | </listitem>
|
|---|
| 581 | </varlistentry>
|
|---|
| 582 |
|
|---|
| 583 | <varlistentry id="libgport">
|
|---|
| 584 | <term><filename class='libraryfile'>libgport.a</filename></term>
|
|---|
| 585 | <listitem>
|
|---|
| 586 | <para>is the port-specific subsystem of the Postgres backend.</para>
|
|---|
| 587 | <indexterm zone="postgresql libgport">
|
|---|
| 588 | <primary sortas="c-libgport">libgport.a</primary>
|
|---|
| 589 | </indexterm>
|
|---|
| 590 | </listitem>
|
|---|
| 591 | </varlistentry>
|
|---|
| 592 |
|
|---|
| 593 | <varlistentry id="libpgtypes">
|
|---|
| 594 | <term><filename class='libraryfile'>libpgtypes.{so,a}</filename></term>
|
|---|
| 595 | <listitem>
|
|---|
| 596 | <para>contains functions for dealing with Postgres data types.</para>
|
|---|
| 597 | <indexterm zone="postgresql libpgtypes">
|
|---|
| 598 | <primary sortas="c-libpgtypes">libpgtypes.{so,a}</primary>
|
|---|
| 599 | </indexterm>
|
|---|
| 600 | </listitem>
|
|---|
| 601 | </varlistentry>
|
|---|
| 602 |
|
|---|
| 603 | <varlistentry id="libpq">
|
|---|
| 604 | <term><filename class='libraryfile'>libpq.{so,a}</filename></term>
|
|---|
| 605 | <listitem>
|
|---|
| 606 | <para>is the C programmer's API to Postgres.</para>
|
|---|
| 607 | <indexterm zone="postgresql libpq">
|
|---|
| 608 | <primary sortas="c-libpq">libpq.{so,a}</primary>
|
|---|
| 609 | </indexterm>
|
|---|
| 610 | </listitem>
|
|---|
| 611 | </varlistentry>
|
|---|
| 612 |
|
|---|
| 613 | </variablelist>
|
|---|
| 614 |
|
|---|
| 615 | </sect2>
|
|---|
| 616 |
|
|---|
| 617 | </sect1>
|
|---|
