PostgreSQL Quick Start Guide
1.
Introduction
A Little Bit About PostgreSQL
PostgreSQL is a free and open source
relational database management system (RDBMS). It supports such things as
transactions, schemata and foreign keys, and is often touted to more strictly
adhere to the SQL standards and to be more secure, by default, than any other
database, commercial or otherwise.
Visit the About page on
postgresql.org for more information.
What This Article Will Cover
This article will guide you through the Gentoo specific steps to install the
PostgreSQL RDBMS.
The Ebuilds covered by this article are dev-db/postgresql-docs,
dev-db/postgresql-base
and dev-db/postgresql-server.
This article assumes that you will be installing the latest, stable version of
PostgreSQL; at the time of this writing, the version was 9.0.3. Adjust the
commands in this article as necessary for your specific version.
Important:
The 8.2 branch will have its upstream support dropped in December of 2011. Start
planning your migration now.
|
About the Ebuilds
The PostgreSQL ebuilds in Portage feature slotting based on the major version.
This allows you to have two major versions of PostgreSQL operating
simultaneously; 8.4 and 9.0 libraries and servers can be installed and serve at
the same time. This is useful in such circumstances where you need to move data
from an older database to a new database, or need to have a production and a
testing database on the same machine. Also, this prevents a database,
corresponding libraries or executables from being overwritten by an incompatible
update. That would require migration which is described in this guide.
Additionally, bug and security fixes, which are delivered via minor version
updates, can be applied without fear of corrupting the database or the
PostgreSQL installation itself; 9.0.2 can be updated to 9.0.3 as they are
guaranteed to be compatible and require no more interaction from you than to
emerge it and restart the server process — neither migration,
reconfiguration nor initialization are necessary.
Read the PostgreSQL
Versioning Policy for more information.
What this Article Will Not Cover
There is quite a bit that will not be covered. The official documentation is somewhere
in the neighborhood of 2,000 pages. So, a lot of details will be left out in
this quick start guide. Only Gentoo specific issues will be covered and some
basic configuration guidelines.
2.
Installation
The Obsolete Ebuilds
If you have any of the following ebuilds installed, then you have an older,
obsolete Gentoo installation of PostgreSQL and should migrate now:
dev-db/postgresql-libs, dev-db/postgresql-client, dev-db/libpq and/or
dev-db/postgresql.
This article does cover migrating from the old
ebuilds to the new ones.
USE Flags
| USE Flag |
Meaning |
| doc |
Include the online
documentation to be stored on your system
|
| kerberos |
Support for utilizing Kerberos for authentication. |
| ldap |
Support for utilizing LDAP authentication and connection parameter lookup.
|
| nls |
Enable the ability to display messages in a language other than
English. Used in conjunction with the Portage variable LINGUAS.
|
| pam |
Support for utilizing Pluggable Authentication Modules for authentication.
|
| perl |
Enable support for using Perl to write functions and trigger procedures.
|
| pg-intdatetime (Deprecated) |
Use the newer, high resolution, 64-bit integer method for formatting
timestamps instead of the older, floating point method. Unless you had a
previous installation that utilized the deprecated method, leave this
enabled. (See note.)
|
| pg_legacytimestamp |
Use the older, floating-point method for formatting timestamps instead of
the higher resolution 64-bit integer method. Unless you had a previous
installation that utilized this deprecated method, leave this USE flag
disabled. (See note.)
|
| python |
Enable support for using Python to write functions and trigger procedures.
|
| readline |
You really want this enabled. Disabling removes command line editing and
history in psql.
|
| selinux |
Install respective SELinux policy. This can only be enabled by using the
SELinux profile.
|
| ssl |
Enable support for SSL connections. |
| tcl |
Enable support for using Tcl to write functions and trigger procedures.
|
| threads |
Make the client libraries thread-safe. The rest of your system must be
thread-safe as well.
|
| uuid |
Include support to generate a 128 bit random unique identifier. This is
useful for merging databases together so the chances of collisions become
extremely low.
|
| xml |
Enable SQL/XML support. |
| zlib |
Support for compressed archives in pg_dump and pg_restore. |
Note:
Flipping the 'pg-intdatetime' or the 'pg_legacytimestamp' will require you to do
a dump and restore if any of your databases utilize timestamps. The two methods
are incompatible with each other.
|
Start Emerging
Code Listing 2.1: Emerging PostgreSQL server |
# emerge -av dev-db/postgresql-server
[ebuild N ] dev-db/postgresql-docs-9.0.3 0 kB
[ebuild N ]dev-db/postgresql-base-9.0.3 USE="doc nls pam readline ssl zlib
-kerberos -ldap -pg_legacytimestamp -threads" LINGUAS="-af -cs -de -es -fa -fr
-hr -hu -it -ko -nb -pl -pt_BR -ro -ru -sk -sl -sv -tr -zh_CN -zh_TW" 0 kB
[ebuild N ] dev-db/postgresql-server-9.0.3 USE="doc nls perl python
-pg_legacytimestamp (-selinux) -tcl -uuid -xml" LINGUAS="-af -cs -de -es -fa
-fr -hr -hu -it -ko -nb -pl -pt_BR -ro -ru -sk -sl -sv -tr -zh_CN -zh_TW" 0 kB
|
You may receive a notice regarding that any of the above packages are blocked by
any or all of the following packages: dev-db/postgresql-libs,
dev-db/postgresql-client, dev-db/libpq or dev-db/postgresql. These packages are
not maintained and obsoleted. Refer to the section on migration for how to handle this situation.
Preparing to Initialize the Database Cluster
Once the packages have finished emerging, you may want to edit
/etc/conf.d/postgresql-9.0. There are three lines that effect the
defaults of the server and cannot be changed later without deleting the
directory that contains the database cluster and reinitializing.
PGDATA defines where to place the configuration files. DATA_DIR
defines where to create the database cluster and related
files. PG_INITDB_OPTS may contain any extra
options you would care to set. The extra options are not required
as the reasonable defaults are, ahem, reasonable.
In the following example, PGDATA states that the configuration files are
to be located in /etc/postgresql-9.0/. DATA_DIR states that
the database cluster should be installed to
/var/lib/postgresql/9.0/data/, which is the default. If you decide
to stray from the default, bear in mind that it is a very good idea to
keep the major version in the path. PG_INITDB_OPTS states that the
default locale should be en_US.UTF-8. That is, U.S. English ordering and
formatting, and UTF-8 character encoding.
Code Listing 2.2: Example contents of /etc/conf.d/postgresql-8.4 |
PGDATA="/etc/postgresql-9.0/"
DATA_DIR="/var/lib/postgresql/9.0/data"
PG_INITDB_OPTS="--locale=en_US.UTF-8"
|
Note:
This only determines the default locale and character encoding. You can specify
different locales and/or character encodings at database creation time
(CREATE DATABASE) in the same database cluster.
|
There are six locale options that can be set to override --locale=. The
following table lists the six options that, if used, are to be formatted as:
--option=lo_LO.ENCODING.
| Option |
Effects |
| lc-collate |
String sort order |
| lc-ctype |
Character classification (What is a letter? Its upper-case equivalent?)
|
| lc-messages |
Language of messages |
| lc-monetary |
Formatting of currency amounts |
| lc-numeric |
Formatting of numbers |
| lc-time |
Formatting of dates and times |
So, if you would like the default to be English, but you want messages in, say,
Swedish, then your PG_INITDB_OPTS would look like so:
Code Listing 2.3: Example |
PG_INITDB_OPTS="--locale=en_US.UTF-8 --lc-messages=sv_SE.UTF-8"
|
A complete list of language and character encodings supported by the server can
be found in the documentation, but your system must also support the respective
languages and character encodings. Compare the output of locale -a to the
encodings
in the documentation.
You can change your locale and encoding selections at database creation
time. In order to change the locale for a database after you have
created it, you must drop the database and start over again.
Code Listing 2.4: Finalize the installation |
# emerge --config dev-db/postgresql-server:9.0
|
This will create the database cluster and store all the related server files
into PGDATA and DATA_DIR.
3.
Configuration
Where the Configuration Files are Located
This time the focus is upon the files in the PGDATA directory,
/etc/postgresql-9.0, instead with primary focus on the
postgresql.conf and pg_hba.conf files.
postgresql.conf
This is the main configuration file. The line that you may find of immediate
interest is listen_addresses. This variable defines to which addresses
PostgreSQL will bind. By default, only localhost and the Unix socket are
bound. Changing listen_addresses is not enough to enable remote
connections. That will be covered in the next section. The official
documentation is fairly easy to understand and is exhaustive on all the
settings available. It would behoove you to read that in addition to what is
covered here as some things may change.
Of secondary interest is the logging destination. By default, everything is
logged to postmaster.log in the DATA_DIR directory. There is
an entire subsection of postgresql.conf that covers a slew of
options for how, what and where to log. The subsection is marked: ERROR
REPORTING AND LOGGING.
Other than listen_addresses and the logging options, the rest of the
defaults in postgresql.conf are reasonable enough to get you going.
pg_hba.conf
The pg_hba.conf file states who is allowed to connect to the
database server and which authentication method must be used to establish the
connection. Again, the documentation is quite exhaustive on the settings and
what they all mean, but a few things are covered here for clarification.
Code Listing 3.1: Default pg_hba.conf |
local all all trust
host all all 127.0.0.1/32 trust
host all all ::1/128 trust
|
As has been mentioned before, by default the server is secure. Kind of. There is
only one database role that is available for log in by default:
postgres. And, the only way to initiate a connection to the database is
through the /var/run/postgresql/.s.PGSQL.5432 Unix socket, which is
owned by the postgres system user and system group, or via localhost. Now
for the "kind of" bit: Any user on the system can make a connection to the
database through the localhost. Even as the postgres database superuser.
To make a connection through the Unix socket, however, the users —
including the users for other services such as apache — must be in
the postgres system group. Use gpasswd -a user postgres to
add user to the postgres group. Users not in the postgres
group will be rejected with "Permission denied".
Warning:
Never disable the Unix socket entirely. The initscripts require access to it in
order to operate properly. The method can be changed freely.
|
The trust method is what allows any user to log on as any user without a
password. It specifies just what it implies: Trust all connections for the given
type to the given database from the given database user (but not the system
user) from the given location without a password. This is what allows any user
on the system to log on as any user through the localhost connection from the
get go. This is not as dangerous as it seems, but does pose a serious security
risk in most circumstances.
The two methods you will most likely use are: password and
md5. The password method only specifies that a password is required to
start the connection and the password is sent "in-the-clear". This method is
fine when such information will never leave the machine, such as connecting via
the Unix socket or localhost. The md5 method is like password, but protects the
password by using an md5 hash. This is what you want to use whenever the
password is going to traverse a network.
At this point, this author would like to bring your attention to the last two
lines, four lines including comments, of the pg_hba.conf
file. PostgreSQL has native support for IPv6 regardless of your desires for such
support. Additionally, IPv4 addresses are automatically mapped to IPv6
addresses, i.e., 127.0.0.1 will be mapped to ::FFFF:127.0.0.1 and as
"pure" IPv6 ::FFFF:7F00:0001.
There seems to be some misunderstanding, though, as to how host names are mapped
to IP addresses. Let us take a look at the /etc/hosts file.
Code Listing 3.2: Example /etc/hosts |
127.0.0.1 localhost
::1 localhost
|
From the example above you can see that both an IPv4 and an IPv6 IP address are
mapped to localhost. When psql refers to this file, it will grab the
first match and use that as the address; in this case 127.0.0.1. When PostgreSQL
parses this, it will match the IPv6 formatted address as well,
e.g. ::ffff:127.0.0.1. If, however, the IPv6 address appears first, then
psql will map to ::1 alone; ::1 is not the same as ::ffff:127.0.0.1. As
such, if you do not have ::1 as a permitted means of access, psql will
not be able to establish a connection. Furthermore, your kernel needs to support
the IPv6 protocol.
So, it is better to specify IP addresses alone to psql and in
pg_hba.conf rather than to rely on /etc/hosts to be
ordered properly, and it removes any doubt as to which IP addresses are allowed
or to which server you will connect.
4.
Starting the Server
Give It a Go!
Now start PostgreSQL and set the password for the database superuser
postgres. The commands are to be performed as 'root' in the following
code listing:
Code Listing 4.1: Starting the Server |
# nano -w /etc/postgresql-9.0/pg_hba.conf
# /etc/init.d/postgresql-9.0 start
postgresql-9.0 | * Starting PostgreSQL ... [ ok ]
# psql -U postgres
psql (9.0.3)
Type "help" for help.
postgres=# \password
Enter new password:
Enter it again:
postgres=# \q
# nano -w /etc/postgresql-9.0/pg_hba.conf
# /etc/init.d/postgresql-9.0 reload
postgresql-9.0 | * Reloading PostgreSQL configuration ... [ ok ]
# rc-update add postgresql-9.0 default
* service postgresql-9.0 added to runlevel default
|
At this point you are ready to continue on with the official PostgreSQL
Tutorial. The tutorial will guide you through creating roles, databases,
schemata and all that fun and useful stuff.
5.
Migrating PostgreSQL
When You Need to Migrate
There are only two reasons you would need to perform a migration: When moving
from one major version to another, e.g., from PostgreSQL 8.4.7 to 9.0.3,
but not from 9.0.2 to 9.0.3; or when switching from the deprecated
floating-point timestamp format to the new 64-bit integer timestamp format.
Note:
You will need to migrate your database when you move from the obsolete ebuilds
— dev-db/libpq, dev-db/postgresql, dev-db/postgresql-libs, and
dev-db/postgresql-client — to the new ebuilds —
dev-db/postgresql-docs, dev-db/postgresql-base and dev-db/postgresql-server.
|
Post-9.0 Migration
pg_upgrade, a new utility that comes along with 9.0 and later, simplifies
the migration process rather drastically.
However, there are two caveats with using pg_upgrade. Firstly, it does not
support configuration files being in a different directory than where the data
is stored. This can be resolved by using symbolic links. Lastly, you can only
use it to migrate from a database from 8.3 or newer. If you have an older
database you will need to follow the Pre-9.0 Migration
instructions.
Code Listing 5.1: Migrating with pg_upgrade |
# /etc/init.d/postgresql-8.4 stop
# /etc/init.d/postgresql-9.0 stop
# ln -s /etc/postgresql-8.4/*.conf /var/lib/postgresql/8.4/data/
# ln -s /etc/postgresql-9.0/*.conf /var/lib/postgresql/9.0/data/
# nano -w /etc/postgresql-8.4/pg_hba.conf
# nano -w /etc/postgresql-9.0/pg_hba.conf
# su - postgres
$ pg_upgrade -u postgres \
-d /var/lib/postgresql/8.4/data -D /var/lib/postgresql/9.0/data \
-b /usr/lib/postgresql-8.4/bin -B /usr/lib/postgresql-9.0/bin
$ logout
# rm /var/lib/postgresql/8.4/data/*.conf
# rm /var/lib/postgresql/9.0/data/*.conf
# /etc/init.d/postgresql-9.0 start
|
Pre-9.0 Migration: With the New Ebuilds
Because the new ebuilds feature a more advanced slotting method than the
previous ones, the downtime is quite minimal, most likely minutes rather than
hours.
In the following examples, it is assumed that you are using the default
locations and port settings, and that you are migrating from 8.3 to 8.4. Adjust
accordingly if you have deviated from the default.
If you have not already done so, follow the installation instructions before starting the
migration. Such a compile may hamper performance on the database server but it
can keep going.
A couple of files need to be tweaked before beginning the migration. Edit
PGPORT in the /etc/conf.d/postgresql-8.4 configuration file
to 6543. (Any port number other than what your old installation is bound to will
do.)
Next, edit /etc/postgresql-8.3/pg_hba.conf so that only the
database superuser postgres can access the database cluster via the Unix
socket.
Code Listing 5.2: Migrate with the New Ebuilds |
# cp -p /etc/postgresql-8.3/pg_hba.conf /etc/postgresql-8.4/
# cp -p /etc/postgresql-8.3/postgresql.conf /etc/postgresql-8.4/
# /etc/init.d/postgresql-8.3 reload
# /etc/init.d/postgresql-8.4 start
# pg_dumpall -U postgres -p 5432 | psql -U postgres -d postgres -p 6543
# /etc/init.d/postgresql-8.3 stop
# /etc/init.d/postgresql-8.4 stop
# nano -w /etc/conf.d/postgresql-8.4
# nano -w /etc/postgresql-8.4/pg_hba.conf
# /etc/init.d/postgresql-8.4 start
# rc-update del postgresql-8.3 && rc-update add postgresql-8.4 default
|
Hopefully everything went according to plan and you have a successfully updated
server that contains precisely the same data, bit for bit, as the old server.
Pre-9.0 Migration: From the Obsolete Ebuilds
You will need to schedule some downtime for your server. The old ebuilds
cannot be installed at the same time as the new ebuilds. As such, assume
that the server will have to be down for a few hours. Maybe for the weekend,
even.
Before starting, you will need to deny access to the server, so that no changes
are made. You may also want to backup your postgresql.conf and
pg_hba.conf and any other configuration file that you deem
important.
Code Listing 5.3: Steps to Migrate from the Obsolete Ebuilds |
# pg_dumpall -U postgres > backup_file
# /etc/init.d/postgresql stop
# emerge -C dev-db/postgresql dev-db/libpq dev-db/postgresql-client \
dev-db/postgresql-client
# /etc/init.d/postgresql-8.4 start
# psql -f backup_file postgres
|
You may break some packages that were built against those packages, but once you
have installed dev-db/postgresql-base and/or dev-db/postgresql-server you can
run revdep-rebuild to reemerge any packages that may have been broken.
6.
Utilities
pgAdmin III
pgAdmin III is a graphical utility
for managing PostgreSQL.
7.
Troubleshooting
Server Lacks Instrumentation Functions
This problem is easy to solve. What is difficult about it is finding the
answer. What is required is an import from a file that already exists on the
storage drive: adminpack.sql. To resolve this issue, run this
command:
Code Listing 7.1: Command to Add Instrumentation Functions |
# psql -U postgres --file /usr/share/postgresql-9.0/contrib/adminpack.sql
|
The contents of this document, unless otherwise expressly stated, are licensed under the CC-BY-SA-2.5 license. The Gentoo Name and Logo Usage Guidelines apply.
|