ACIM Personal Knowledgebase

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Backup PostgreSQL Databases ======

===== What is PostgreSQL? =====
 

PostgreSQL is a modern database management system. It is frequently used to store and manipulate information related to websites and applications.

As with any kind of valuable data, it is important to implement a backup scheme to protect against data loss. This guide will cover some practical ways that you can backup your PostgreSQL data.

We will be using an Ubuntu 12.04 VPS with PostgreSQL 9.1. Most modern distributions and recent versions of PostgreSQL will operate in a similar way.

===== How to Back Up a PostgreSQL Database Using pg_dump =====

PostgreSQL includes a utility called "pg_dump" that can be used to dump database information into a file for backup purposes.

The pg_dump utility is run from the Linux command line. The basic syntax of the command is:

<code bash>
pg_dump name_of_database > name_of_backup_filr
</code>

The command must be run by a user with privileges to read all of the database information, so it is run as the superuser most of the time.

For a real-world example, we can log into the "postgres" user and execute the command on the default database, also called "postgres":

<code bash>
sudo su - postgres
pg_dump postgres > postgres_db.bak
</code>

This command is actually a PostgreSQL client program, so it can be run from a remote system as long as that system has access to the database.

If you wish to backup a remote system, you can pass the "-h" flag for specifying the remote host, and the "-p" flag to give the remote port:

<code bash>
pg_dump -h remote_host -p remote_port name_of_database > name_of_backup_file
</code>
You can also specify a different user using the "-U" option if necessary. The syntax would be:

<code bash>
pg_dump -U user_name -h remote_host -p remote_port name_of_database > name_of_backup_file
</code>
Keep in mind that the same authentication requirements exist for pg_dump as for any other client program. This means that you must ensure that your log in credentials are valid for the systems you are trying to back up.

===== How to Restore Data Dumps from pg_dump with PostgreSQL =====

To restore a backup created by pg_dump, you can redirect the file into psql standard input:

<code bash>
psql empty_database < backup_file
</code>
Note: this redirection operation does not create the database in question. This must be done in a separate step prior to running the command.

For example, we can create a new database called "restored_database" and then redirect a dump called "database.bak" by issuing these commands:

<code bash>
createdb -T template0 restored_database
psql restored_database < database.bak
</code>
The empty database should be created using "template0" as the base.

Another step that must be performed in order to restore correctly is to recreate any users who own or have grant permissions on objects within the database.

For instance, if your database had a table owned by the user "test_user", you will have to create it on the restoration system prior to importing:

<code bash>
createuser test_user
psql restored_database < database.bak
</code>

===== Dealing with Restoration Errors =====


By default, PostgreSQL will attempt to continue restoring a database, even when it encounters an error along the way.

In many cases, this is undesirable for obvious reasons. It can be painful to try to sort out what operations are needed to restore the database to its proper state.

We can tell PostgreSQL to stop on any error by typing:

<code bash>
psql --set ON_ERROR_STOP=on restored_database < backup_file
</code>

This will cause a PostgreSQL restore operation to halt immediately when an error is encountered.

This will still leave you with a crippled database that hasn't been fully restored, but you can now handle errors as they come up instead of dealing with a list of errors at the end.

A better option in many situations can be the "-1" (the number one) or "--single-transaction" option:

<code bash>
psql -1 restored_database < backup_file
</code>

This option performs all of the restoration details in a single transaction.

The difference between this option and the "ON_ERROR_STOP" setting is that this will either succeed completely or not import anything.

This can be a costly trade-off for larger restorations, but in many cases, the benefit of not leaving you with a partially restored database heavily outweighs that cost.

===== How to Backup & Restore All Databases in PostgreSQL =====

To save time, if you would like to backup all of the databases in your system, there is a utility called "pg_dumpall".

They syntax of the command is very similar to the regular pg_dump command, but it does not specify the database. Instead, the command backs up every available database:

<code bash>
pg_dumpall > backup_file
</code>

You can restore the databases by passing the file to psql, with the default database:

<code bash>
psql -f backup_file postgres
</code>
===== Conclusion =====

Backups are an essential component in any kind of data storage plan. Fortunately, PostgreSQL gives you the utilities necessary to effectively backup your important information.

As with any kind of backup, it is important to test your backups regularly to ensure the copies that are created can be restored correctly. The backups you create are only useful if they can actually be used to recover your system.
ACIM Personal Knowledgebase

User Tools

Site Tools

Page Tools
