backup.sgml 87.6 KB
Newer Older
1
<!-- $PostgreSQL: pgsql/doc/src/sgml/backup.sgml,v 2.123 2009/03/05 19:50:03 tgl Exp $ -->
2

3 4 5
<chapter id="backup">
 <title>Backup and Restore</title>

6 7
 <indexterm zone="backup"><primary>backup</></>

8
 <para>
9
  As with everything that contains valuable data, <productname>PostgreSQL</>
10
  databases should be backed up regularly. While the procedure is
11
  essentially simple, it is important to have a clear understanding of
12 13 14 15
  the underlying techniques and assumptions.
 </para>

 <para>
16
  There are three fundamentally different approaches to backing up
17
  <productname>PostgreSQL</> data:
18 19 20
  <itemizedlist>
   <listitem><para><acronym>SQL</> dump</para></listitem>
   <listitem><para>File system level backup</para></listitem>
21
   <listitem><para>Continuous archiving</para></listitem>
22
  </itemizedlist>
23
  Each has its own strengths and weaknesses.
24
  Each is discussed in turn below.
25 26
 </para>

27
 <sect1 id="backup-dump">
28 29 30
  <title><acronym>SQL</> Dump</title>

  <para>
31
   The idea behind this dump method is to generate a text file with SQL
32 33
   commands that, when fed back to the server, will recreate the
   database in the same state as it was at the time of the dump.
34
   <productname>PostgreSQL</> provides the utility program
35
   <xref linkend="app-pgdump"> for this purpose. The basic usage of this
36 37 38 39 40 41 42 43 44
   command is:
<synopsis>
pg_dump <replaceable class="parameter">dbname</replaceable> &gt; <replaceable class="parameter">outfile</replaceable>
</synopsis>
   As you see, <application>pg_dump</> writes its results to the
   standard output. We will see below how this can be useful.
  </para>

  <para>
45
   <application>pg_dump</> is a regular <productname>PostgreSQL</>
46 47 48
   client application (albeit a particularly clever one). This means
   that you can do this backup procedure from any remote host that has
   access to the database. But remember that <application>pg_dump</>
49
   does not operate with special permissions. In particular, it must
50
   have read access to all tables that you want to back up, so in
51
   practice you almost always have to run it as a database superuser.
52 53 54
  </para>

  <para>
Bruce Momjian's avatar
Bruce Momjian committed
55
   To specify which database server <application>pg_dump</> should
56 57 58 59 60 61 62 63 64 65 66
   contact, use the command line options <option>-h
   <replaceable>host</></> and <option>-p <replaceable>port</></>. The
   default host is the local host or whatever your
   <envar>PGHOST</envar> environment variable specifies. Similarly,
   the default port is indicated by the <envar>PGPORT</envar>
   environment variable or, failing that, by the compiled-in default.
   (Conveniently, the server will normally have the same compiled-in
   default.)
  </para>

  <para>
67
   Like any other <productname>PostgreSQL</> client application,
68
   <application>pg_dump</> will by default connect with the database
69
   user name that is equal to the current operating system user name. To override
70 71 72 73
   this, either specify the <option>-U</option> option or set the
   environment variable <envar>PGUSER</envar>. Remember that
   <application>pg_dump</> connections are subject to the normal
   client authentication mechanisms (which are described in <xref
74 75 76 77 78
   linkend="client-authentication">).
  </para>

  <para>
   Dumps created by <application>pg_dump</> are internally consistent,
79 80
   that is, the dump represents a snapshot of the database as of the time
   <application>pg_dump</> begins running. <application>pg_dump</> does not
81 82
   block other operations on the database while it is working.
   (Exceptions are those operations that need to operate with an
83
   exclusive lock, such as most forms of <command>ALTER TABLE</command>.)
84 85 86 87
  </para>

  <important>
   <para>
88
    If your database schema relies on OIDs (for instance as foreign
89 90
    keys) you must instruct <application>pg_dump</> to dump the OIDs
    as well. To do this, use the <option>-o</option> command line
91
    option.
92 93 94
   </para>
  </important>

95
  <sect2 id="backup-dump-restore">
96 97 98 99 100 101 102 103 104 105 106
   <title>Restoring the dump</title>

   <para>
    The text files created by <application>pg_dump</> are intended to
    be read in by the <application>psql</application> program. The
    general command form to restore a dump is
<synopsis>
psql <replaceable class="parameter">dbname</replaceable> &lt; <replaceable class="parameter">infile</replaceable>
</synopsis>
    where <replaceable class="parameter">infile</replaceable> is what
    you used as <replaceable class="parameter">outfile</replaceable>
107
    for the <application>pg_dump</> command. The database <replaceable
108
    class="parameter">dbname</replaceable> will not be created by this
109 110 111 112
    command, so you must create it yourself from <literal>template0</>
    before executing <application>psql</> (e.g., with
    <literal>createdb -T template0 <replaceable
    class="parameter">dbname</></literal>).  <application>psql</>
113
    supports options similar to <application>pg_dump</>'s for specifying
114 115
    the database server to connect to and the user name to use. See
    the <xref linkend="app-psql"> reference page for more information.
116 117 118
   </para>

   <para>
119 120 121 122 123
    Before restoring a SQL dump, all the users who own objects or were
    granted permissions on objects in the dumped database must already
    exist. If they do not, then the restore will fail to recreate the
    objects with the original ownership and/or permissions.
    (Sometimes this is what you want, but usually it is not.)
124 125
   </para>

126
   <para>
127
    By default, the <application>psql</> script will continue to
128
    execute after an SQL error is encountered. You might wish to use the
129 130 131 132 133 134
    following command at the top of the script to alter that
    behaviour and have <application>psql</application> exit with an
    exit status of 3 if an SQL error occurs:
<programlisting>
\set ON_ERROR_STOP
</programlisting>
135 136
    Either way, you will have an only partially restored database.
    Alternatively, you can specify that the whole dump should be
137 138 139 140 141
    restored as a single transaction, so the restore is either fully
    completed or fully rolled back. This mode can be specified by
    passing the <option>-1</> or <option>--single-transaction</>
    command-line options to <application>psql</>. When using this
    mode, be aware that even the smallest of errors can rollback a
142
    restore that has already run for many hours. However, that might
143 144
    still be preferable to manually cleaning up a complex database
    after a partially restored dump.
145 146
   </para>

147 148
   <para>
    The ability of <application>pg_dump</> and <application>psql</> to
Tom Lane's avatar
Tom Lane committed
149
    write to or read from pipes makes it possible to dump a database
150
    directly from one server to another, for example:
151 152 153 154
<programlisting>
pg_dump -h <replaceable>host1</> <replaceable>dbname</> | psql -h <replaceable>host2</> <replaceable>dbname</>
</programlisting>
   </para>
155

156 157 158 159
   <important>
    <para>
     The dumps produced by <application>pg_dump</> are relative to
     <literal>template0</>. This means that any languages, procedures,
160
     etc. added via <literal>template1</> will also be dumped by
161 162 163 164 165 166
     <application>pg_dump</>. As a result, when restoring, if you are
     using a customized <literal>template1</>, you must create the
     empty database from <literal>template0</>, as in the example
     above.
    </para>
   </important>
167

168
   <para>
169 170 171 172 173 174 175
    After restoring a backup, it is wise to run <xref
    linkend="sql-analyze" endterm="sql-analyze-title"> on each
    database so the query optimizer has useful statistics. An easy way
    to do this is to run <command>vacuumdb -a -z</>; this is
    equivalent to running <command>VACUUM ANALYZE</> on each database
    manually.  For more advice on how to load large amounts of data
    into <productname>PostgreSQL</> efficiently, refer to <xref
176 177
    linkend="populate">.
   </para>
178 179
  </sect2>

180
  <sect2 id="backup-dump-all">
181
   <title>Using <application>pg_dumpall</></title>
182 183

   <para>
184 185 186 187 188
    <application>pg_dump</> dumps only a single database at a time,
    and it does not dump information about roles or tablespaces
    (because those are cluster-wide rather than per-database).
    To support convenient dumping of the entire contents of a database
    cluster, the <xref linkend="app-pg-dumpall"> program is provided.
189
    <application>pg_dumpall</> backs up each database in a given
190 191
    cluster, and also preserves cluster-wide data such as role and
    tablespace definitions. The basic usage of this command is:
192 193 194
<synopsis>
pg_dumpall &gt; <replaceable>outfile</>
</synopsis>
195 196
    The resulting dump can be restored with <application>psql</>:
<synopsis>
197
psql -f <replaceable class="parameter">infile</replaceable> postgres
198 199
</synopsis>
    (Actually, you can specify any existing database name to start from,
200 201
    but if you are reloading into an empty cluster then <literal>postgres</>
    should usually be used.)  It is always necessary to have
202
    database superuser access when restoring a <application>pg_dumpall</>
203 204 205
    dump, as that is required to restore the role and tablespace information.
    If you use tablespaces, be careful that the tablespace paths in the
    dump are appropriate for the new installation.
206
   </para>
207 208 209 210 211 212 213 214

   <para>
    <application>pg_dumpall</> works by emitting commands to re-create
    roles, tablespaces, and empty databases, then invoking
    <application>pg_dump</> for each database.  This means that while
    each database will be internally consistent, the snapshots of
    different databases might not be exactly in-sync.
   </para>
215 216
  </sect2>

217
  <sect2 id="backup-dump-large">
218
   <title>Handling large databases</title>
219 220

   <para>
221
    Since <productname>PostgreSQL</productname> allows tables larger
222
    than the maximum file size on your system, it can be problematic
223
    to dump such a table to a file, since the resulting file will likely
224
    be larger than the maximum size allowed by your system. Since
225
    <application>pg_dump</> can write to the standard output, you can
226
    use standard Unix tools to work around this possible problem.
227
    There are several ways to do it:
228 229 230 231 232
   </para>

   <formalpara>
    <title>Use compressed dumps.</title>
    <para>
233
     You can use your favorite compression program, for example
234
     <application>gzip</application>:
235 236 237 238 239

<programlisting>
pg_dump <replaceable class="parameter">dbname</replaceable> | gzip &gt; <replaceable class="parameter">filename</replaceable>.gz
</programlisting>

240
     Reload with:
241 242 243 244 245

<programlisting>
gunzip -c <replaceable class="parameter">filename</replaceable>.gz | psql <replaceable class="parameter">dbname</replaceable>
</programlisting>

246
     or:
247 248 249 250 251 252 253 254

<programlisting>
cat <replaceable class="parameter">filename</replaceable>.gz | gunzip | psql <replaceable class="parameter">dbname</replaceable>
</programlisting>
    </para>
   </formalpara>

   <formalpara>
255
    <title>Use <command>split</>.</title>
256
    <para>
257 258
     The <command>split</command> command
     allows you to split the output into pieces that are
259 260 261 262 263 264 265
     acceptable in size to the underlying file system. For example, to
     make chunks of 1 megabyte:

<programlisting>
pg_dump <replaceable class="parameter">dbname</replaceable> | split -b 1m - <replaceable class="parameter">filename</replaceable>
</programlisting>

266
     Reload with:
267 268

<programlisting>
269
cat <replaceable class="parameter">filename</replaceable>* | psql <replaceable class="parameter">dbname</replaceable>
270 271 272 273
</programlisting>
    </para>
   </formalpara>

274
   <formalpara>
275
    <title>Use <application>pg_dump</>'s custom dump format.</title>
276
    <para>
277 278 279 280 281 282
     If <productname>PostgreSQL</productname> was built on a system with the
     <application>zlib</> compression library installed, the custom dump
     format will compress data as it writes it to the output file. This will
     produce dump file sizes similar to using <command>gzip</command>, but it
     has the added advantage that tables can be restored selectively. The
     following command dumps a database using the custom dump format:
283 284

<programlisting>
285
pg_dump -Fc <replaceable class="parameter">dbname</replaceable> &gt; <replaceable class="parameter">filename</replaceable>
286 287
</programlisting>

288
     A custom-format dump is not a script for <application>psql</>, but
289 290 291 292 293 294
     instead must be restored with <application>pg_restore</>, for example:

<programlisting>
pg_restore -d <replaceable class="parameter">dbname</replaceable> <replaceable class="parameter">filename</replaceable>
</programlisting>

295 296
     See the <xref linkend="app-pgdump"> and <xref
     linkend="app-pgrestore"> reference pages for details.
297 298 299
    </para>
   </formalpara>

300 301 302 303 304
   <para>
    For very large databases, you might need to combine <command>split</>
    with one of the other two approaches.
   </para>

305 306 307
  </sect2>
 </sect1>

308
 <sect1 id="backup-file">
309
  <title>File System Level Backup</title>
310 311 312

  <para>
   An alternative backup strategy is to directly copy the files that
313
   <productname>PostgreSQL</> uses to store the data in the database. In
314 315 316
   <xref linkend="creating-cluster"> it is explained where these files
   are located, but you have probably found them already if you are
   interested in this method. You can use whatever method you prefer
317
   for doing usual file system backups, for example:
318

319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
<programlisting>
tar -cf backup.tar /usr/local/pgsql/data
</programlisting>
  </para>

  <para>
   There are two restrictions, however, which make this method
   impractical, or at least inferior to the <application>pg_dump</>
   method:

   <orderedlist>
    <listitem>
     <para>
      The database server <emphasis>must</> be shut down in order to
      get a usable backup. Half-way measures such as disallowing all
334
      connections will <emphasis>not</emphasis> work
335 336 337 338
      (in part because <command>tar</command> and similar tools do not take
      an atomic snapshot of the state of the file system,
      but also because of internal buffering within the server).
      Information about stopping the server can be found in
339
      <xref linkend="server-shutdown">.  Needless to say that you
340
      also need to shut down the server before restoring the data.
341 342 343 344 345
     </para>
    </listitem>

    <listitem>
     <para>
346
      If you have dug into the details of the file system layout of the
347
      database, you might be tempted to try to back up or restore only certain
348 349 350
      individual tables or databases from their respective files or
      directories. This will <emphasis>not</> work because the
      information contained in these files contains only half the
351 352
      truth. The other half is in the commit log files
      <filename>pg_clog/*</filename>, which contain the commit status of
353 354
      all transactions. A table file is only usable with this
      information. Of course it is also impossible to restore only a
355
      table and the associated <filename>pg_clog</filename> data
356
      because that would render all other tables in the database
357
      cluster useless.  So file system backups only work for complete
358
      backup and restoration of an entire database cluster.
359 360 361 362 363 364
     </para>
    </listitem>
   </orderedlist>
  </para>

  <para>
Peter Eisentraut's avatar
Peter Eisentraut committed
365 366
   An alternative file-system backup approach is to make a
   <quote>consistent snapshot</quote> of the data directory, if the
367 368 369 370 371 372 373
   file system supports that functionality (and you are willing to
   trust that it is implemented correctly).  The typical procedure is
   to make a <quote>frozen snapshot</> of the volume containing the
   database, then copy the whole data directory (not just parts, see
   above) from the snapshot to a backup device, then release the frozen
   snapshot.  This will work even while the database server is running.
   However, a backup created in this way saves
Peter Eisentraut's avatar
Peter Eisentraut committed
374 375
   the database files in a state where the database server was not
   properly shut down; therefore, when you start the database server
376 377
   on the backed-up data, it will think the previous server instance had
   crashed and replay the WAL log.  This is not a problem, just be aware of
378
   it (and be sure to include the WAL files in your backup).
Peter Eisentraut's avatar
Peter Eisentraut committed
379 380 381
  </para>

  <para>
382 383
   If your database is spread across multiple file systems, there might not
   be any way to obtain exactly-simultaneous frozen snapshots of all
384 385
   the volumes.  For example, if your data files and WAL log are on different
   disks, or if tablespaces are on different file systems, it might
386 387
   not be possible to use snapshot backup because the snapshots
   <emphasis>must</> be simultaneous.
Peter Eisentraut's avatar
Peter Eisentraut committed
388
   Read your file system documentation very carefully before trusting
389 390 391 392 393 394 395 396 397 398 399
   to the consistent-snapshot technique in such situations.
  </para>

  <para>
   If simultaneous snapshots are not possible, one option is to shut down
   the database server long enough to establish all the frozen snapshots.
   Another option is perform a continuous archiving base backup (<xref
   linkend="backup-base-backup">) because such backups are immune to file
   system changes during the backup.  This requires enabling continuous
   archiving just during the backup process; restore is done using
   continuous archive recovery (<xref linkend="backup-pitr-recovery">).
400 401
  </para>

402 403
  <para>
   Another option is to use <application>rsync</> to perform a file
404 405 406 407
   system backup.  This is done by first running <application>rsync</>
   while the database server is running, then shutting down the database
   server just long enough to do a second <application>rsync</>.  The
   second <application>rsync</> will be much quicker than the first,
408 409
   because it has relatively little data to transfer, and the end result
   will be consistent because the server was down.  This method
410
   allows a file system backup to be performed with minimal downtime.
411 412
  </para>

413 414
  <para>
   Note that a file system backup will not necessarily be
415 416
   smaller than an SQL dump. On the contrary, it will most likely be
   larger. (<application>pg_dump</application> does not need to dump
417
   the contents of indexes for example, just the commands to recreate
418
   them.)  However, taking a file system backup might be faster.
419
  </para>
420 421
 </sect1>

422 423
 <sect1 id="continuous-archiving">
  <title>Continuous Archiving and Point-In-Time Recovery (PITR)</title>
424

425
  <indexterm zone="backup">
426
   <primary>continuous archiving</primary>
427 428 429 430 431 432
  </indexterm>

  <indexterm zone="backup">
   <primary>point-in-time recovery</primary>
  </indexterm>

433 434 435 436
  <indexterm zone="backup">
   <primary>PITR</primary>
  </indexterm>

437
  <para>
438 439 440 441 442 443 444
   At all times, <productname>PostgreSQL</> maintains a
   <firstterm>write ahead log</> (WAL) in the <filename>pg_xlog/</>
   subdirectory of the cluster's data directory. The log describes
   every change made to the database's data files.  This log exists
   primarily for crash-safety purposes: if the system crashes, the
   database can be restored to consistency by <quote>replaying</> the
   log entries made since the last checkpoint.  However, the existence
445
   of the log makes it possible to use a third strategy for backing up
Peter Eisentraut's avatar
Peter Eisentraut committed
446
   databases: we can combine a file-system-level backup with backup of
447 448 449 450 451
   the WAL files.  If recovery is needed, we restore the backup and
   then replay from the backed-up WAL files to bring the backup up to
   current time.  This approach is more complex to administer than
   either of the previous approaches, but it has some significant
   benefits:
452 453 454 455 456 457
  <itemizedlist>
   <listitem>
    <para>
     We do not need a perfectly consistent backup as the starting point.
     Any internal inconsistency in the backup will be corrected by log
     replay (this is not significantly different from what happens during
Peter Eisentraut's avatar
Peter Eisentraut committed
458
     crash recovery).  So we don't need file system snapshot capability,
459 460 461 462 463 464
     just <application>tar</> or a similar archiving tool.
    </para>
   </listitem>
   <listitem>
    <para>
     Since we can string together an indefinitely long sequence of WAL files
465
     for replay, continuous backup can be achieved simply by continuing to archive
466
     the WAL files.  This is particularly valuable for large databases, where
467
     it might not be convenient to take a full backup frequently.
468 469 470 471 472 473 474 475 476 477 478 479 480 481
    </para>
   </listitem>
   <listitem>
    <para>
     There is nothing that says we have to replay the WAL entries all the
     way to the end.  We could stop the replay at any point and have a
     consistent snapshot of the database as it was at that time.  Thus,
     this technique supports <firstterm>point-in-time recovery</>: it is
     possible to restore the database to its state at any time since your base
     backup was taken.
    </para>
   </listitem>
   <listitem>
    <para>
482 483
     If we continuously feed the series of WAL files to another
     machine that has been loaded with the same base backup file, we
484
     have a <firstterm>warm standby</> system: at any point we can bring up
485 486
     the second machine and it will have a nearly-current copy of the
     database.
487 488 489 490 491 492
    </para>
   </listitem>
  </itemizedlist>
  </para>

  <para>
Peter Eisentraut's avatar
Peter Eisentraut committed
493
   As with the plain file-system-backup technique, this method can only
494
   support restoration of an entire database cluster, not a subset.
495
   Also, it requires a lot of archival storage: the base backup might be bulky,
496 497 498 499
   and a busy system will generate many megabytes of WAL traffic that
   have to be archived.  Still, it is the preferred backup technique in
   many situations where high reliability is needed.
  </para>
500

501
  <para>
502 503
   To recover successfully using continuous archiving (also called
   <quote>online backup</> by many database vendors), you need a continuous
504
   sequence of archived WAL files that extends back at least as far as the
505
   start time of your backup.  So to get started, you should set up and test
506 507 508 509 510 511 512 513 514 515 516
   your procedure for archiving WAL files <emphasis>before</> you take your
   first base backup.  Accordingly, we first discuss the mechanics of
   archiving WAL files.
  </para>

  <sect2 id="backup-archiving-wal">
   <title>Setting up WAL archiving</title>

   <para>
    In an abstract sense, a running <productname>PostgreSQL</> system
    produces an indefinitely long sequence of WAL records.  The system
517
    physically divides this sequence into WAL <firstterm>segment
518 519
    files</>, which are normally 16MB apiece (although the segment size
    can be altered when building <productname>PostgreSQL</>).  The segment
520 521 522 523 524 525 526
    files are given numeric names that reflect their position in the
    abstract WAL sequence.  When not using WAL archiving, the system
    normally creates just a few segment files and then
    <quote>recycles</> them by renaming no-longer-needed segment files
    to higher segment numbers.  It's assumed that a segment file whose
    contents precede the checkpoint-before-last is no longer of
    interest and can be recycled.
527 528 529
   </para>

   <para>
530
    When archiving WAL data, we need to capture the contents of each segment
531 532 533 534
    file once it is filled, and save that data somewhere before the segment
    file is recycled for reuse.  Depending on the application and the
    available hardware, there could be many different ways of <quote>saving
    the data somewhere</>: we could copy the segment files to an NFS-mounted
535
    directory on another machine, write them onto a tape drive (ensuring that
536
    you have a way of identifying the original name of each file), or batch
537 538
    them together and burn them onto CDs, or something else entirely.  To
    provide the database administrator with as much flexibility as possible,
539
    <productname>PostgreSQL</> tries not to make any assumptions about how
540 541 542
    the archiving will be done.  Instead, <productname>PostgreSQL</> lets
    the administrator specify a shell command to be executed to copy a
    completed segment file to wherever it needs to go.  The command could be
543
    as simple as a <literal>cp</>, or it could invoke a complex shell
544
    script &mdash; it's all up to you.
545 546 547
   </para>

   <para>
548 549 550 551 552 553 554
    To enable WAL archiving, set the <xref
    linkend="guc-archive-mode"> configuration parameter to <literal>on</>,
    and specify the shell command to use in the <xref
    linkend="guc-archive-command"> configuration parameter.  In practice
    these settings will always be placed in the
    <filename>postgresql.conf</filename> file.
    In <varname>archive_command</>,
555
    any <literal>%p</> is replaced by the path name of the file to
556
    archive, while any <literal>%f</> is replaced by the file name only.
557
    (The path name is relative to the current working directory,
558
    i.e., the cluster's data directory.)
559 560
    Write <literal>%%</> if you need to embed an actual <literal>%</>
    character in the command.  The simplest useful command is something
561
    like:
562
<programlisting>
563
archive_command = 'cp -i %p /mnt/server/archivedir/%f &lt;/dev/null'
564 565
</programlisting>
    which will copy archivable WAL segments to the directory
566
    <filename>/mnt/server/archivedir</>.  (This is an example, not a
567 568 569 570 571 572 573
    recommendation, and might not work on all platforms.)  After the
    <literal>%p</> and <literal>%f</> parameters have been replaced,
    the actual command executed might look like this:
<programlisting>
cp -i pg_xlog/00000001000000A900000065 /mnt/server/archivedir/00000001000000A900000065 &lt;/dev/null
</programlisting>
    A similar command will be generated for each new file to be archived.
574 575 576 577 578 579 580 581 582 583 584 585 586 587
   </para>

   <para>
    The archive command will be executed under the ownership of the same
    user that the <productname>PostgreSQL</> server is running as.  Since
    the series of WAL files being archived contains effectively everything
    in your database, you will want to be sure that the archived data is
    protected from prying eyes; for example, archive into a directory that
    does not have group or world read access.
   </para>

   <para>
    It is important that the archive command return zero exit status if and
    only if it succeeded.  Upon getting a zero result,
588 589 590 591
    <productname>PostgreSQL</> will assume that the file has been
    successfully archived, and will remove or recycle it.  However, a nonzero
    status tells <productname>PostgreSQL</> that the file was not archived;
    it will try again periodically until it succeeds.
592 593
   </para>

594 595 596 597 598 599 600 601 602 603 604 605
   <para>
    The archive command should generally be designed to refuse to overwrite
    any pre-existing archive file.  This is an important safety feature to
    preserve the integrity of your archive in case of administrator error
    (such as sending the output of two different servers to the same archive
    directory).
    It is advisable to test your proposed archive command to ensure that it
    indeed does not overwrite an existing file, <emphasis>and that it returns
    nonzero status in this case</>.  We have found that <literal>cp -i</> does
    this correctly on some platforms but not others.  If the chosen command
    does not itself handle this case correctly, you should add a command
    to test for pre-existence of the archive file.  For example, something
606
    like:
607 608 609 610 611 612 613 614
<programlisting>
archive_command = 'test ! -f .../%f &amp;&amp; cp %p .../%f'
</programlisting>
    works correctly on most Unix variants.
   </para>

   <para>
    While designing your archiving setup, consider what will happen if
615
    the archive command fails repeatedly because some aspect requires
616
    operator intervention or the archive runs out of space. For example, this
617
    could occur if you write to tape without an autochanger; when the tape
618 619
    fills, nothing further can be archived until the tape is swapped.
    You should ensure that any error condition or request to a human operator
620 621
    is reported appropriately so that the situation can be
    resolved reasonably quickly. The <filename>pg_xlog/</> directory will
622
    continue to fill with WAL segment files until the situation is resolved.
623 624 625 626
    (If the filesystem containing <filename>pg_xlog/</> fills up,
    <productname>PostgreSQL</> will do a PANIC shutdown.  No prior
    transactions will be lost, but the database will be unavailable until
    you free some space.)
627 628
   </para>

629
   <para>
630
    The speed of the archiving command is not important, so long as it can keep up
631 632 633 634 635 636 637 638
    with the average rate at which your server generates WAL data.  Normal
    operation continues even if the archiving process falls a little behind.
    If archiving falls significantly behind, this will increase the amount of
    data that would be lost in the event of a disaster. It will also mean that
    the <filename>pg_xlog/</> directory will contain large numbers of
    not-yet-archived segment files, which could eventually exceed available
    disk space. You are advised to monitor the archiving process to ensure that
    it is working as you intend.
639 640 641
   </para>

   <para>
642
    In writing your archive command, you should assume that the file names to
643
    be archived can be up to 64 characters long and can contain any
644
    combination of ASCII letters, digits, and dots.  It is not necessary to
645
    remember the original relative path (<literal>%p</>) but it is necessary to
646 647
    remember the file name (<literal>%f</>).
   </para>
648 649 650

   <para>
    Note that although WAL archiving will allow you to restore any
651
    modifications made to the data in your <productname>PostgreSQL</> database,
652
    it will not restore changes made to configuration files (that is,
653
    <filename>postgresql.conf</>, <filename>pg_hba.conf</> and
654 655
    <filename>pg_ident.conf</>), since those are edited manually rather
    than through SQL operations.
656
    You might wish to keep the configuration files in a location that will
657 658 659
    be backed up by your regular file system backup procedures.  See
    <xref linkend="runtime-config-file-locations"> for how to relocate the
    configuration files.
660
   </para>
661 662 663

   <para>
    The archive command is only invoked on completed WAL segments.  Hence,
664
    if your server generates only little WAL traffic (or has slack periods
665 666 667 668 669 670 671 672 673 674 675 676 677 678
    where it does so), there could be a long delay between the completion
    of a transaction and its safe recording in archive storage.  To put
    a limit on how old unarchived data can be, you can set
    <xref linkend="guc-archive-timeout"> to force the server to switch
    to a new WAL segment file at least that often.  Note that archived
    files that are ended early due to a forced switch are still the same
    length as completely full files.  It is therefore unwise to set a very
    short <varname>archive_timeout</> &mdash; it will bloat your archive
    storage.  <varname>archive_timeout</> settings of a minute or so are
    usually reasonable.
   </para>

   <para>
    Also, you can force a segment switch manually with
679
    <function>pg_switch_xlog</>, if you want to ensure that a
680
    just-finished transaction is archived as soon as possible.  Other utility
681 682
    functions related to WAL management are listed in <xref
    linkend="functions-admin-backup-table">.
683
   </para>
684 685 686 687 688 689 690 691

   <para>
    When <varname>archive_mode</> is <literal>off</> some SQL commands
    are optimized to avoid WAL logging, as described in <xref
    linkend="populate-pitr">. If archiving were turned on during execution
    of one of these statements, WAL would not contain enough information
    for archive recovery.  (Crash recovery is unaffected.)  For
    this reason, <varname>archive_mode</> can only be changed at server
692 693 694 695 696 697
    start.  However, <varname>archive_command</> can be changed with a
    configuration file reload.  If you wish to temporarily stop archiving,
    one way to do it is to set <varname>archive_command</> to the empty
    string (<literal>''</>).
    This will cause WAL files to accumulate in <filename>pg_xlog/</> until a
    working <varname>archive_command</> is re-established.
698
   </para>
699 700 701 702 703 704 705 706 707 708 709 710 711 712 713
  </sect2>

  <sect2 id="backup-base-backup">
   <title>Making a Base Backup</title>

   <para>
    The procedure for making a base backup is relatively simple:
  <orderedlist>
   <listitem>
    <para>
     Ensure that WAL archiving is enabled and working.
    </para>
   </listitem>
   <listitem>
    <para>
714
     Connect to the database as a superuser, and issue the command:
715 716 717 718
<programlisting>
SELECT pg_start_backup('label');
</programlisting>
     where <literal>label</> is any string you want to use to uniquely
719 720 721 722 723
     identify this backup operation.  (One good practice is to use the
     full path where you intend to put the backup dump file.)
     <function>pg_start_backup</> creates a <firstterm>backup label</> file,
     called <filename>backup_label</>, in the cluster directory with
     information about your backup.
724 725 726
    </para>

    <para>
727
     It does not matter which database within the cluster you connect to to
728
     issue this command.  You can ignore the result returned by the function;
729 730
     but if it reports an error, deal with that before proceeding.
    </para>
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746

    <para>
     <function>pg_start_backup</> can take a long time to finish.
     This is because it performs a checkpoint, and the I/O
     required for a checkpoint will be spread out over a significant
     period of time, by default half your inter-checkpoint interval
     (see the configuration parameter
     <xref linkend="guc-checkpoint-completion-target">).  Usually
     this is what you want because it minimizes the impact on query
     processing.  If you just want to start the backup as soon as
     possible, execute a <command>CHECKPOINT</> command
     (which performs a checkpoint as quickly as possible) and then
     immediately execute <function>pg_start_backup</>.  Then there
     will be very little for <function>pg_start_backup</>'s checkpoint
     to do, and it won't take long.
    </para>
747 748 749
   </listitem>
   <listitem>
    <para>
Peter Eisentraut's avatar
Peter Eisentraut committed
750
     Perform the backup, using any convenient file-system-backup tool
751 752 753 754 755 756 757
     such as <application>tar</> or <application>cpio</>.  It is neither
     necessary nor desirable to stop normal operation of the database
     while you do this.
    </para>
   </listitem>
   <listitem>
    <para>
758
     Again connect to the database as a superuser, and issue the command:
759 760 761
<programlisting>
SELECT pg_stop_backup();
</programlisting>
762 763 764 765
     This terminates the backup mode and performs an automatic switch to
     the next WAL segment.  The reason for the switch is to arrange that
     the last WAL segment file written during the backup interval is
     immediately ready to archive.
766 767 768 769
    </para>
   </listitem>
   <listitem>
    <para>
770 771
     Once the WAL segment files used during the backup are archived, you are
     done.  The file identified by <function>pg_stop_backup</>'s result is
772 773 774 775 776 777 778 779 780 781 782 783 784
     the last segment that is required to form a complete set of backup files. 
     <function>pg_stop_backup</> does not return until the last segment has
     been archived. 
     Archiving of these files happens automatically since you have
     already configured <varname>archive_command</>. In most cases this
     happens quickly, but you are advised to monitor your archive
     system to ensure there are no delays.
     If the archive process has fallen behind
     because of failures of the archive command, it will keep retrying
     until the archive succeeds and the backup is complete.
     If you wish to place a time limit on the execution of
     <function>pg_stop_backup</>, set an appropriate
     <varname>statement_timeout</varname> value.
785 786 787 788 789
    </para>
   </listitem>
  </orderedlist>
   </para>

790
   <para>
791 792
    Some backup tools that you might wish to use emit warnings or errors
    if the files they are trying to copy change while the copy proceeds.
793 794
    This situation is normal, and not an error, when taking a base backup
    of an active database; so you need to ensure that you can distinguish
795
    complaints of this sort from real errors.  For example, some versions
796 797 798
    of <application>rsync</> return a separate exit code for
    <quote>vanished source files</>, and you can write a driver script to
    accept this exit code as a non-error case.  Also, some versions of
799 800 801
    GNU <application>tar</> return an error code indistinguishable from
    a fatal error if a file was truncated while <application>tar</> was
    copying it.  Fortunately, GNU <application>tar</> versions 1.16 and
802
    later exit with <literal>1</> if a file was changed during the backup,
803
    and <literal>2</> for other errors.
804 805
   </para>

806 807 808 809
   <para>
    It is not necessary to be very concerned about the amount of time elapsed
    between <function>pg_start_backup</> and the start of the actual backup,
    nor between the end of the backup and <function>pg_stop_backup</>; a
810
    few minutes' delay won't hurt anything.  (However, if you normally run the
811
    server with <varname>full_page_writes</> disabled, you might notice a drop
812
    in performance between <function>pg_start_backup</> and
813 814 815 816
    <function>pg_stop_backup</>, since <varname>full_page_writes</> is
    effectively forced on during backup mode.)  You must ensure that these
    steps are carried out in sequence without any possible
    overlap, or you will invalidate the backup.
817 818 819 820
   </para>

   <para>
    Be certain that your backup dump includes all of the files underneath
821
    the database cluster directory (e.g., <filename>/usr/local/pgsql/data</>).
822 823 824 825 826 827 828
    If you are using tablespaces that do not reside underneath this directory,
    be careful to include them as well (and be sure that your backup dump
    archives symbolic links as links, otherwise the restore will mess up
    your tablespaces).
   </para>

   <para>
829
    You can, however, omit from the backup dump the files within the
830
    <filename>pg_xlog/</> subdirectory of the cluster directory.  This
831 832
    slight complication is worthwhile because it reduces the risk
    of mistakes when restoring.  This is easy to arrange if
833
    <filename>pg_xlog/</> is a symbolic link pointing to someplace outside
834 835 836 837 838
    the cluster directory, which is a common setup anyway for performance
    reasons.
   </para>

   <para>
839
    To make use of the backup, you will need to keep around all the WAL
840
    segment files generated during and after the file system backup.
841
    To aid you in doing this, the <function>pg_stop_backup</> function
842 843 844 845 846 847 848
    creates a <firstterm>backup history file</> that is immediately
    stored into the WAL archive area. This file is named after the first
    WAL segment file that you need to have to make use of the backup.
    For example, if the starting WAL file is
    <literal>0000000100001234000055CD</> the backup history file will be
    named something like
    <literal>0000000100001234000055CD.007C9330.backup</>. (The second
849
    part of the file name stands for an exact position within the WAL
850
    file, and can ordinarily be ignored.) Once you have safely archived
851 852 853
    the file system backup and the WAL segment files used during the
    backup (as specified in the backup history file), all archived WAL
    segments with names numerically less are no longer needed to recover
854
    the file system backup and can be deleted. However, you should
855
    consider keeping several backup sets to be absolutely certain that
856
    you can recover your data.
857
   </para>
858

859 860 861
   <para>
    The backup history file is just a small text file. It contains the
    label string you gave to <function>pg_start_backup</>, as well as
862
    the starting and ending times and WAL segments of the backup.
863
    If you used the label to identify where the associated dump file is kept,
864
    then the archived history file is enough to tell you which dump file to
865
    restore, should you need to do so.
866 867 868 869
   </para>

   <para>
    Since you have to keep around all the archived WAL files back to your
870 871 872
    last base backup, the interval between base backups should usually be
    chosen based on how much storage you want to expend on archived WAL
    files.  You should also consider how long you are prepared to spend
873
    recovering, if recovery should be necessary &mdash; the system will have to
874 875
    replay all those WAL segments, and that could take awhile if it has
    been a long time since the last base backup.
876 877 878 879
   </para>

   <para>
    It's also worth noting that the <function>pg_start_backup</> function
880
    makes a file named <filename>backup_label</> in the database cluster
881 882 883 884 885 886 887 888 889 890 891
    directory, which is then removed again by <function>pg_stop_backup</>.
    This file will of course be archived as a part of your backup dump file.
    The backup label file includes the label string you gave to
    <function>pg_start_backup</>, as well as the time at which
    <function>pg_start_backup</> was run, and the name of the starting WAL
    file.  In case of confusion it will
    therefore be possible to look inside a backup dump file and determine
    exactly which backup session the dump file came from.
   </para>

   <para>
892
    It is also possible to make a backup dump while the server is
893
    stopped.  In this case, you obviously cannot use
894 895 896
    <function>pg_start_backup</> or <function>pg_stop_backup</>, and
    you will therefore be left to your own devices to keep track of which
    backup dump is which and how far back the associated WAL files go.
897
    It is generally better to follow the continuous archiving procedure above.
898 899 900 901
   </para>
  </sect2>

  <sect2 id="backup-pitr-recovery">
902
   <title>Recovering using a Continuous Archive Backup</title>
903 904 905 906 907 908 909

   <para>
    Okay, the worst has happened and you need to recover from your backup.
    Here is the procedure:
  <orderedlist>
   <listitem>
    <para>
910
     Stop the server, if it's running.
911 912 913 914 915
    </para>
   </listitem>
   <listitem>
    <para>
     If you have the space to do so,
916
     copy the whole cluster data directory and any tablespaces to a temporary
917
     location in case you need them later. Note that this precaution will
918
     require that you have enough free space on your system to hold two
919
     copies of your existing database. If you do not have enough space,
920
     you need at the least to copy the contents of the <filename>pg_xlog</>
921
     subdirectory of the cluster data directory, as it might contain logs which
922
     were not archived before the system went down.
923
    </para>
924 925
   </listitem>
   <listitem>
926
    <para>
927 928
     Clean out all existing files and subdirectories under the cluster data
     directory and under the root directories of any tablespaces you are using.
929 930 931 932
    </para>
   </listitem>
   <listitem>
    <para>
Bruce Momjian's avatar
Bruce Momjian committed
933
     Restore the database files from your base backup.  Be careful that they
934
     are restored with the right ownership (the database system user, not
935 936
     <literal>root</>!) and with the right permissions.  If you are using
     tablespaces,
937
     you should verify that the symbolic links in <filename>pg_tblspc/</>
938 939 940 941 942
     were correctly restored.
    </para>
   </listitem>
   <listitem>
    <para>
943
     Remove any files present in <filename>pg_xlog/</>; these came from the
944
     backup dump and are therefore probably obsolete rather than current.
945
     If you didn't archive <filename>pg_xlog/</> at all, then recreate it,
946 947
     being careful to ensure that you re-establish it as a symbolic link
     if you had it set up that way before.
948 949 950 951
    </para>
   </listitem>
   <listitem>
    <para>
952
     If you had unarchived WAL segment files that you saved in step 2,
953 954 955
     copy them into <filename>pg_xlog/</>.  (It is best to copy them,
     not move them, so that you still have the unmodified files if a
     problem occurs and you have to start over.)
956 957 958 959
    </para>
   </listitem>
   <listitem>
    <para>
960
     Create a recovery command file <filename>recovery.conf</> in the cluster
961
     data directory (see <xref linkend="recovery-config-settings">). You might
962
     also want to temporarily modify <filename>pg_hba.conf</> to prevent
963
     ordinary users from connecting until you are sure the recovery has worked.
964 965 966 967
    </para>
   </listitem>
   <listitem>
    <para>
968
     Start the server.  The server will go into recovery mode and
969 970 971
     proceed to read through the archived WAL files it needs.  Should the
     recovery be terminated because of an external error, the server can
     simply be restarted and it will continue recovery.  Upon completion
972
     of the recovery process, the server will rename
973
     <filename>recovery.conf</> to <filename>recovery.done</> (to prevent
974 975 976 977 978 979 980 981
     accidentally re-entering recovery mode in case of a crash later) and then
     commence normal database operations.
    </para>
   </listitem>
   <listitem>
    <para>
     Inspect the contents of the database to ensure you have recovered to
     where you want to be.  If not, return to step 1.  If all is well,
982
     let in your users by restoring <filename>pg_hba.conf</> to normal.
983 984 985 986 987 988
    </para>
   </listitem>
  </orderedlist>
   </para>

   <para>
989
    The key part of all this is to set up a recovery command file that
990 991
    describes how you want to recover and how far the recovery should
    run.  You can use <filename>recovery.conf.sample</> (normally
992
    installed in the installation <filename>share/</> directory) as a
993
    prototype.  The one thing that you absolutely must specify in
994 995 996
    <filename>recovery.conf</> is the <varname>restore_command</>,
    which tells <productname>PostgreSQL</> how to get back archived
    WAL file segments.  Like the <varname>archive_command</>, this is
997
    a shell command string.  It can contain <literal>%f</>, which is
998
    replaced by the name of the desired log file, and <literal>%p</>,
999
    which is replaced by the path name to copy the log file to.
1000
    (The path name is relative to the current working directory,
1001
    i.e., the cluster's data directory.)
1002
    Write <literal>%%</> if you need to embed an actual <literal>%</>
1003
    character in the command.  The simplest useful command is
1004
    something like:
1005 1006 1007 1008
<programlisting>
restore_command = 'cp /mnt/server/archivedir/%f %p'
</programlisting>
    which will copy previously archived WAL segments from the directory
1009
    <filename>/mnt/server/archivedir</>.  You could of course use something
1010 1011 1012 1013 1014 1015
    much more complicated, perhaps even a shell script that requests the
    operator to mount an appropriate tape.
   </para>

   <para>
    It is important that the command return nonzero exit status on failure.
1016
    The command <emphasis>will</> be asked for files that are not present
1017
    in the archive; it must return nonzero when so asked.  This is not an
1018 1019 1020 1021 1022
    error condition.  Not all of the requested files will be WAL segment
    files; you should also expect requests for files with a suffix of
    <literal>.backup</> or <literal>.history</>. Also be aware that
    the base name of the <literal>%p</> path will be different from
    <literal>%f</>; do not expect them to be interchangeable.
1023 1024 1025 1026
   </para>

   <para>
    WAL segments that cannot be found in the archive will be sought in
1027
    <filename>pg_xlog/</>; this allows use of recent un-archived segments.
1028
    However segments that are available from the archive will be used in
1029 1030
    preference to files in <filename>pg_xlog/</>.  The system will not
    overwrite the existing contents of <filename>pg_xlog/</> when retrieving
1031 1032 1033 1034 1035
    archived files.
   </para>

   <para>
    Normally, recovery will proceed through all available WAL segments,
1036
    thereby restoring the database to the current point in time (or as
1037
    close as we can get given the available WAL segments).  So a normal
1038 1039
    recovery will end with a <quote>file not found</> message, the exact text
    of the error message depending upon your choice of
1040 1041 1042
    <varname>restore_command</>.  You may also see an error message
    at the start of recovery for a file named something like
    <filename>00000001.history</>.  This is also normal and does not
1043
    indicate a problem in simple recovery situations. See
1044 1045 1046 1047 1048
    <xref linkend="backup-timelines"> for discussion.
   </para>

   <para>
    If you want to recover to some previous point in time (say, right before
1049 1050 1051 1052 1053
    the junior DBA dropped your main transaction table), just specify the
    required stopping point in <filename>recovery.conf</>.  You can specify
    the stop point, known as the <quote>recovery target</>, either by
    date/time or by completion of a specific transaction ID.  As of this
    writing only the date/time option is very usable, since there are no tools
1054
    to help you identify with any accuracy which transaction ID to use.
1055
   </para>
1056

1057 1058
   <note>
     <para>
1059
      The stop point must be after the ending time of the base backup, i.e.,
1060
      the end time of <function>pg_stop_backup</>.  You cannot use a base backup
1061 1062 1063 1064
      to recover to a time when that backup was still going on.  (To
      recover to such a time, you must go back to your previous base backup
      and roll forward from there.)
     </para>
1065 1066 1067 1068
   </note>

   <para>
    If recovery finds a corruption in the WAL data then recovery will
1069
    complete at that point and the server will not start. In such a case the
1070
    recovery process could be re-run from the beginning, specifying a
1071 1072
    <quote>recovery target</> before the point of corruption so that recovery
    can complete normally.
1073
    If recovery fails for an external reason, such as a system crash or
1074 1075 1076 1077 1078 1079
    if the WAL archive has become inaccessible, then the recovery can simply
    be restarted and it will restart almost from where it failed.
    Recovery restart works much like checkpointing in normal operation:
    the server periodically forces all its state to disk, and then updates
    the <filename>pg_control</> file to indicate that the already-processed
    WAL data need not be scanned again.
1080 1081
   </para>

1082 1083

    <sect3 id="recovery-config-settings" xreflabel="Recovery Settings">
1084 1085
     <title>Recovery Settings</title>

1086 1087 1088 1089 1090 1091
     <para>
      These settings can only be made in the <filename>recovery.conf</>
      file, and apply only for the duration of the recovery. They must be
      reset for any subsequent recovery you wish to perform. They cannot be
      changed once recovery has begun.
     </para>
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102

     <variablelist>

     <varlistentry id="restore-command" xreflabel="restore_command">
      <term><varname>restore_command</varname> (<type>string</type>)</term>
      <listitem>
       <para>
        The shell command to execute to retrieve an archived segment of
        the WAL file series. This parameter is required.
        Any <literal>%f</> in the string is
        replaced by the name of the file to retrieve from the archive,
1103
        and any <literal>%p</> is replaced by the path name to copy
1104
        it to on the server.
1105
        (The path name is relative to the current working directory,
1106
        i.e., the cluster's data directory.)
1107
        Any <literal>%r</> is replaced by the name of the file containing the
Peter Eisentraut's avatar
Peter Eisentraut committed
1108
        last valid restart point. That is the earliest file that must be kept
1109 1110 1111
        to allow a restore to be restartable, so this information can be used
        to truncate the archive to just the minimum required to support
        restart of the current restore. <literal>%r</> would only be used in a
1112
        warm-standby configuration (see <xref linkend="warm-standby">).
1113
        Write <literal>%%</> to embed an actual <literal>%</> character
1114
        in the command.
1115 1116
       </para>
       <para>
1117 1118
        It is important for the command to return a zero exit status if and
        only if it succeeds.  The command <emphasis>will</> be asked for file
1119 1120
        names that are not present in the archive; it must return nonzero
        when so asked.  Examples:
1121 1122
<programlisting>
restore_command = 'cp /mnt/server/archivedir/%f "%p"'
1123
restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"'  # Windows
1124 1125 1126 1127 1128 1129
</programlisting>
       </para>
      </listitem>
     </varlistentry>

     <varlistentry id="recovery-target-time" xreflabel="recovery_target_time">
1130
      <term><varname>recovery_target_time</varname>
1131 1132 1133 1134
           (<type>timestamp</type>)
      </term>
      <listitem>
       <para>
Peter Eisentraut's avatar
Peter Eisentraut committed
1135
        This parameter specifies the time stamp up to which recovery
1136 1137 1138 1139
        will proceed.
        At most one of <varname>recovery_target_time</> and
        <xref linkend="recovery-target-xid"> can be specified.
        The default is to recover to the end of the WAL log.
1140
        The precise stopping point is also influenced by
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
        <xref linkend="recovery-target-inclusive">.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry id="recovery-target-xid" xreflabel="recovery_target_xid">
      <term><varname>recovery_target_xid</varname> (<type>string</type>)</term>
      <listitem>
       <para>
        This parameter specifies the transaction ID up to which recovery
1151 1152
        will proceed. Keep in mind
        that while transaction IDs are assigned sequentially at transaction
1153 1154 1155 1156 1157 1158
        start, transactions can complete in a different numeric order.
        The transactions that will be recovered are those that committed
        before (and optionally including) the specified one.
        At most one of <varname>recovery_target_xid</> and
        <xref linkend="recovery-target-time"> can be specified.
        The default is to recover to the end of the WAL log.
1159
        The precise stopping point is also influenced by
1160 1161 1162 1163 1164
        <xref linkend="recovery-target-inclusive">.
       </para>
      </listitem>
     </varlistentry>

1165
     <varlistentry id="recovery-target-inclusive"
1166
                   xreflabel="recovery_target_inclusive">
1167
      <term><varname>recovery_target_inclusive</varname>
1168 1169 1170 1171 1172
        (<type>boolean</type>)
      </term>
      <listitem>
       <para>
        Specifies whether we stop just after the specified recovery target
1173
        (<literal>true</literal>), or just before the recovery target
1174 1175 1176 1177 1178 1179 1180 1181 1182 1183
        (<literal>false</literal>).
        Applies to both <xref linkend="recovery-target-time">
        and <xref linkend="recovery-target-xid">, whichever one is
        specified for this recovery.  This indicates whether transactions
        having exactly the target commit time or ID, respectively, will
        be included in the recovery.  Default is <literal>true</>.
       </para>
      </listitem>
     </varlistentry>

1184
     <varlistentry id="recovery-target-timeline"
1185
                   xreflabel="recovery_target_timeline">
1186
      <term><varname>recovery_target_timeline</varname>
1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204
        (<type>string</type>)
      </term>
      <listitem>
       <para>
        Specifies recovering into a particular timeline.  The default is
        to recover along the same timeline that was current when the
        base backup was taken.  You would only need to set this parameter
        in complex re-recovery situations, where you need to return to
        a state that itself was reached after a point-in-time recovery.
        See <xref linkend="backup-timelines"> for discussion.
       </para>
      </listitem>
     </varlistentry>

   </variablelist>

   </sect3>

1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217
  </sect2>

  <sect2 id="backup-timelines">
   <title>Timelines</title>

  <indexterm zone="backup">
   <primary>timelines</primary>
  </indexterm>

   <para>
    The ability to restore the database to a previous point in time creates
    some complexities that are akin to science-fiction stories about time
    travel and parallel universes.  In the original history of the database,
1218 1219
    perhaps you dropped a critical table at 5:15PM on Tuesday evening, but
    didn't realize your mistake until Wednesday noon.
1220 1221 1222 1223
    Unfazed, you get out your backup, restore to the point-in-time 5:14PM
    Tuesday evening, and are up and running.  In <emphasis>this</> history of
    the database universe, you never dropped the table at all.  But suppose
    you later realize this wasn't such a great idea after all, and would like
1224 1225
    to return to sometime Wednesday morning in the original history.
    You won't be able
1226 1227 1228 1229 1230 1231 1232 1233 1234
    to if, while your database was up-and-running, it overwrote some of the
    sequence of WAL segment files that led up to the time you now wish you
    could get back to.  So you really want to distinguish the series of
    WAL records generated after you've done a point-in-time recovery from
    those that were generated in the original database history.
   </para>

   <para>
    To deal with these problems, <productname>PostgreSQL</> has a notion
1235 1236 1237
    of <firstterm>timelines</>.  Whenever an archive recovery is completed,
    a new timeline is created to identify the series of WAL records
    generated after that recovery.  The timeline
1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269
    ID number is part of WAL segment file names, and so a new timeline does
    not overwrite the WAL data generated by previous timelines.  It is
    in fact possible to archive many different timelines.  While that might
    seem like a useless feature, it's often a lifesaver.  Consider the
    situation where you aren't quite sure what point-in-time to recover to,
    and so have to do several point-in-time recoveries by trial and error
    until you find the best place to branch off from the old history.  Without
    timelines this process would soon generate an unmanageable mess.  With
    timelines, you can recover to <emphasis>any</> prior state, including
    states in timeline branches that you later abandoned.
   </para>

   <para>
    Each time a new timeline is created, <productname>PostgreSQL</> creates
    a <quote>timeline history</> file that shows which timeline it branched
    off from and when.  These history files are necessary to allow the system
    to pick the right WAL segment files when recovering from an archive that
    contains multiple timelines.  Therefore, they are archived into the WAL
    archive area just like WAL segment files.  The history files are just
    small text files, so it's cheap and appropriate to keep them around
    indefinitely (unlike the segment files which are large).  You can, if
    you like, add comments to a history file to make your own notes about
    how and why this particular timeline came to be.  Such comments will be
    especially valuable when you have a thicket of different timelines as
    a result of experimentation.
   </para>

   <para>
    The default behavior of recovery is to recover along the same timeline
    that was current when the base backup was taken.  If you want to recover
    into some child timeline (that is, you want to return to some state that
    was itself generated after a recovery attempt), you need to specify the
1270
    target timeline ID in <filename>recovery.conf</>.  You cannot recover into
1271 1272 1273
    timelines that branched off earlier than the base backup.
   </para>
  </sect2>
1274

1275 1276 1277 1278
  <sect2 id="backup-tips">
   <title>Tips and Examples</title>

   <para>
1279
    Some tips for configuring continuous archiving are given here.
1280 1281 1282
   </para>

    <sect3 id="backup-standalone">
1283
     <title>Standalone hot backups</title>
1284 1285

     <para>
1286 1287 1288 1289 1290 1291
      It is possible to use <productname>PostgreSQL</>'s backup facilities to
      produce standalone hot backups. These are backups that cannot be used
      for point-in-time recovery, yet are typically much faster to backup and
      restore than <application>pg_dump</> dumps.  (They are also much larger
      than <application>pg_dump</> dumps, so in some cases the speed advantage
      could be negated.)
1292 1293 1294
     </para>

     <para>
1295 1296 1297
      To prepare for standalone hot backups, set <varname>archive_mode</> to
      <literal>on</>, and set up an <varname>archive_command</> that performs
      archiving only when a <quote>switch file</> exists.  For example:
1298
<programlisting>
1299
archive_command = 'test ! -f /var/lib/pgsql/backup_in_progress || cp -i %p /var/lib/pgsql/archive/%f &lt; /dev/null'
1300
</programlisting>
1301 1302 1303 1304 1305 1306 1307 1308 1309
      This command will perform archiving when
      <filename>/var/lib/pgsql/backup_in_progress</> exists, and otherwise
      silently return zero exit status (allowing <productname>PostgreSQL</>
      to recycle the unwanted WAL file).
     </para>

     <para>
      With this preparation, a backup can be taken using a script like the
      following:
1310 1311 1312
<programlisting>
touch /var/lib/pgsql/backup_in_progress
psql -c "select pg_start_backup('hot_backup');"
1313
tar -cf /var/lib/pgsql/backup.tar /var/lib/pgsql/data/
1314 1315 1316
psql -c "select pg_stop_backup();"
sleep 20
rm /var/lib/pgsql/backup_in_progress
1317
tar -rf /var/lib/pgsql/backup.tar /var/lib/pgsql/archive/
1318 1319
</programlisting>
      The switch file <filename>/var/lib/pgsql/backup_in_progress</> is
1320
      created first, enabling archiving of completed WAL files to occur.
1321 1322 1323
      After the backup the switch file is removed. Archived WAL files are
      then added to the backup so that both base backup and all required
      WAL files are part of the same <application>tar</> file.
1324
      Please remember to add error handling to your backup scripts.
1325
     </para>
1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342

     <para>
      If archive storage size is a concern, use <application>pg_compresslog</>,
      <ulink url="http://pglesslog.projects.postgresql.org"></ulink>, to
      remove unnecessary <xref linkend="guc-full-page-writes"> and trailing
      space from the WAL files.  You can then use
      <application>gzip</application> to further compress the output of
      <application>pg_compresslog</>:
<programlisting>
archive_command = 'pg_compresslog %p - | gzip &gt; /var/lib/pgsql/archive/%f'
</programlisting>
      You will then need to use <application>gunzip</> and
      <application>pg_decompresslog</> during recovery:
<programlisting>
restore_command = 'gunzip &lt; /mnt/server/archivedir/%f | pg_decompresslog - %p'
</programlisting>
     </para>
1343 1344 1345 1346 1347 1348
    </sect3>

    <sect3 id="backup-scripts">
     <title><varname>archive_command</varname> scripts</title>

     <para>
1349
      Many people choose to use scripts to define their
1350
      <varname>archive_command</varname>, so that their
1351
      <filename>postgresql.conf</> entry looks very simple:
1352 1353 1354
<programlisting>
archive_command = 'local_backup_script.sh'
</programlisting>
1355 1356
      Using a separate script file is advisable any time you want to use
      more than a single command in the archiving process.
1357 1358
      This allows all complexity to be managed within the script, which
      can be written in a popular scripting language such as
1359 1360 1361 1362
      <application>bash</> or <application>perl</>.
      Any messages written to <literal>stderr</> from the script will appear
      in the database server log, allowing complex configurations to be
      diagnosed easily if they fail.
1363
     </para>
1364

1365
     <para>
1366
      Examples of requirements that might be solved within a script include:
1367 1368 1369
      <itemizedlist>
       <listitem>
        <para>
1370
         Copying data to secure off-site data storage
1371 1372 1373 1374
        </para>
       </listitem>
       <listitem>
        <para>
1375 1376
         Batching WAL files so that they are transferred every three hours,
         rather than one at a time
1377 1378 1379 1380 1381 1382 1383 1384 1385
        </para>
       </listitem>
       <listitem>
        <para>
         Interfacing with other backup and recovery software
        </para>
       </listitem>
       <listitem>
        <para>
1386
         Interfacing with monitoring software to report errors
1387 1388 1389 1390 1391 1392 1393
        </para>
       </listitem>
      </itemizedlist>
     </para>
    </sect3>
  </sect2>

1394
  <sect2 id="continuous-archiving-caveats">
1395 1396 1397
   <title>Caveats</title>

   <para>
1398
    At this writing, there are several limitations of the continuous archiving
1399
    technique.  These will probably be fixed in future releases:
1400 1401 1402 1403

  <itemizedlist>
   <listitem>
    <para>
1404 1405 1406 1407
     Operations on hash indexes are not presently WAL-logged, so
     replay will not update these indexes.  The recommended workaround
     is to manually <xref linkend="sql-reindex" endterm="sql-reindex-title">
     each such index after completing a recovery operation.
1408 1409
    </para>
   </listitem>
1410

1411 1412
   <listitem>
    <para>
1413 1414 1415 1416 1417 1418 1419 1420
     If a <xref linkend="sql-createdatabase" endterm="sql-createdatabase-title">
     command is executed while a base backup is being taken, and then
     the template database that the <command>CREATE DATABASE</> copied
     is modified while the base backup is still in progress, it is
     possible that recovery will cause those modifications to be
     propagated into the created database as well.  This is of course
     undesirable.  To avoid this risk, it is best not to modify any
     template databases while taking a base backup.
1421 1422 1423
    </para>
   </listitem>

1424 1425
   <listitem>
    <para>
1426 1427 1428 1429 1430 1431 1432 1433 1434 1435
     <xref linkend="sql-createtablespace" endterm="sql-createtablespace-title">
     commands are WAL-logged with the literal absolute path, and will
     therefore be replayed as tablespace creations with the same
     absolute path.  This might be undesirable if the log is being
     replayed on a different machine.  It can be dangerous even if the
     log is being replayed on the same machine, but into a new data
     directory: the replay will still overwrite the contents of the
     original tablespace.  To avoid potential gotchas of this sort,
     the best practice is to take a new base backup after creating or
     dropping tablespaces.
1436 1437
    </para>
   </listitem>
1438 1439
  </itemizedlist>
   </para>
1440 1441

   <para>
1442
    It should also be noted that the default <acronym>WAL</acronym>
1443
    format is fairly bulky since it includes many disk page snapshots.
1444
    These page snapshots are designed to support crash recovery, since
1445 1446
    we might need to fix partially-written disk pages.  Depending on
    your system hardware and software, the risk of partial writes might
1447 1448 1449 1450 1451 1452 1453 1454
    be small enough to ignore, in which case you can significantly
    reduce the total volume of archived logs by turning off page
    snapshots using the <xref linkend="guc-full-page-writes">
    parameter.  (Read the notes and warnings in <xref linkend="wal">
    before you do so.)  Turning off page snapshots does not prevent
    use of the logs for PITR operations.  An area for future
    development is to compress archived WAL data by removing
    unnecessary page copies even when <varname>full_page_writes</> is
1455
    on.  In the meantime, administrators might wish to reduce the number
1456 1457
    of page snapshots included in WAL by increasing the checkpoint
    interval parameters as much as feasible.
1458
   </para>
1459
  </sect2>
1460 1461
 </sect1>

1462 1463 1464 1465
 <sect1 id="warm-standby">
  <title>Warm Standby Servers for High Availability</title>

  <indexterm zone="backup">
1466
   <primary>warm standby</primary>
1467 1468 1469
  </indexterm>

  <indexterm zone="backup">
1470
   <primary>PITR standby</primary>
1471 1472 1473
  </indexterm>

  <indexterm zone="backup">
1474
   <primary>standby server</primary>
1475 1476 1477
  </indexterm>

  <indexterm zone="backup">
1478
   <primary>log shipping</primary>
1479 1480 1481
  </indexterm>

  <indexterm zone="backup">
1482
   <primary>witness server</primary>
1483 1484 1485 1486 1487 1488 1489
  </indexterm>

  <indexterm zone="backup">
   <primary>STONITH</primary>
  </indexterm>

  <indexterm zone="backup">
1490
   <primary>high availability</primary>
1491 1492 1493
  </indexterm>

  <para>
1494 1495
   Continuous archiving can be used to create a <firstterm>high
   availability</> (HA) cluster configuration with one or more
1496 1497 1498
   <firstterm>standby servers</> ready to take over operations if the
   primary server fails. This capability is widely referred to as
   <firstterm>warm standby</> or <firstterm>log shipping</>.
1499 1500 1501
  </para>

  <para>
1502 1503 1504 1505
   The primary and standby server work together to provide this capability,
   though the servers are only loosely coupled. The primary server operates
   in continuous archiving mode, while each standby server operates in
   continuous recovery mode, reading the WAL files from the primary. No
1506
   changes to the database tables are required to enable this capability,
1507 1508 1509
   so it offers low administration overhead in comparison with some other
   replication approaches. This configuration also has relatively low
   performance impact on the primary server.
1510 1511 1512
  </para>

  <para>
1513
   Directly moving WAL records from one database server to another
1514 1515
   is typically described as log shipping. <productname>PostgreSQL</>
   implements file-based log shipping, which means that WAL records are
1516 1517 1518 1519
   transferred one file (WAL segment) at a time. WAL files (16MB) can be
   shipped easily and cheaply over any distance, whether it be to an
   adjacent system, another system on the same site or another system on
   the far side of the globe. The bandwidth required for this technique
1520 1521 1522
   varies according to the transaction rate of the primary server.
   Record-based log shipping is also possible with custom-developed
   procedures, as discussed in <xref linkend="warm-standby-record">.
1523 1524 1525
  </para>

  <para>
1526 1527 1528 1529 1530 1531 1532 1533 1534 1535
   It should be noted that the log shipping is asynchronous, i.e. the WAL
   records are shipped after transaction commit. As a result there is a
   window for data loss should the primary server suffer a catastrophic
   failure: transactions not yet shipped will be lost.  The length of the
   window of data loss can be limited by use of the
   <varname>archive_timeout</varname> parameter, which can be set as low
   as a few seconds if required.  However such low settings will
   substantially increase the bandwidth requirements for file shipping.
   If you need a window of less than a minute or so, it's probably better
   to look into record-based log shipping.
1536 1537 1538
  </para>

  <para>
1539
   The standby server is not available for access, since it is continually
1540
   performing recovery processing. Recovery performance is sufficiently
1541
   good that the standby will typically be only moments away from full
1542
   availability once it has been activated. As a result, we refer to this
1543 1544 1545
   capability as a warm standby configuration that offers high
   availability. Restoring a server from an archived base backup and
   rollforward will take considerably longer, so that technique only
1546
   offers a solution for disaster recovery, not high availability.
1547 1548 1549 1550 1551 1552
  </para>

  <sect2 id="warm-standby-planning">
   <title>Planning</title>

   <para>
1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569
    It is usually wise to create the primary and standby servers
    so that they are as similar as possible, at least from the
    perspective of the database server.  In particular, the path names
    associated with tablespaces will be passed across as-is, so both
    primary and standby servers must have the same mount paths for
    tablespaces if that feature is used.  Keep in mind that if
    <xref linkend="sql-createtablespace" endterm="sql-createtablespace-title">
    is executed on the primary, any new mount point needed for it must
    be created on both the primary and all standby servers before the command
    is executed. Hardware need not be exactly the same, but experience shows
    that maintaining two identical systems is easier than maintaining two
    dissimilar ones over the lifetime of the application and system.
    In any case the hardware architecture must be the same &mdash; shipping
    from, say, a 32-bit to a 64-bit system will not work.
   </para>

   <para>
1570 1571
    In general, log shipping between servers running different major
    <productname>PostgreSQL</> release
1572 1573
    levels will not be possible. It is the policy of the PostgreSQL Global
    Development Group not to make changes to disk formats during minor release
1574
    upgrades, so it is likely that running different minor release levels
1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587
    on primary and standby servers will work successfully. However, no
    formal support for that is offered and you are advised to keep primary
    and standby servers at the same release level as much as possible.
    When updating to a new minor release, the safest policy is to update
    the standby servers first &mdash; a new minor release is more likely
    to be able to read WAL files from a previous minor release than vice
    versa.
   </para>

   <para>
    There is no special mode required to enable a standby server. The
    operations that occur on both primary and standby servers are entirely
    normal continuous archiving and recovery tasks. The only point of
1588
    contact between the two database servers is the archive of WAL files
1589
    that both share: primary writing to the archive, standby reading from
1590
    the archive. Care must be taken to ensure that WAL archives for separate
1591 1592
    primary servers do not become mixed together or confused. The archive
    need not be large, if it is only required for the standby operation.
1593 1594 1595
   </para>

   <para>
1596
    The magic that makes the two loosely coupled servers work together is
1597 1598 1599
    simply a <varname>restore_command</> used on the standby that,
    when asked for the next WAL file, waits for it to become available from
    the primary. The <varname>restore_command</> is specified in the
1600 1601 1602
    <filename>recovery.conf</> file on the standby server. Normal recovery
    processing would request a file from the WAL archive, reporting failure
    if the file was unavailable.  For standby processing it is normal for
1603 1604 1605 1606 1607 1608 1609 1610 1611
    the next WAL file to be unavailable, so we must be patient and wait for
    it to appear. For files ending in <literal>.backup</> or
    <literal>.history</> there is no need to wait, and a non-zero return
    code must be returned. A waiting <varname>restore_command</> can be
    written as a custom script that loops after polling for the existence of
    the next WAL file. There must also be some way to trigger failover, which
    should interrupt the <varname>restore_command</>, break the loop and
    return a file-not-found error to the standby server. This ends recovery
    and the standby will then come up as a normal server.
1612 1613 1614
   </para>

   <para>
1615
    Pseudocode for a suitable <varname>restore_command</> is:
1616 1617
<programlisting>
triggered = false;
1618
while (!NextWALFileReady() &amp;&amp; !triggered)
1619
{
1620
    sleep(100000L);         /* wait for ~0.1 sec */
1621 1622 1623 1624 1625 1626 1627 1628
    if (CheckForExternalTrigger())
        triggered = true;
}
if (!triggered)
        CopyWALFileForRecovery();
</programlisting>
   </para>

1629 1630
   <para>
    A working example of a waiting <varname>restore_command</> is provided
1631 1632 1633 1634
    as a <filename>contrib</> module named <application>pg_standby</>. It
    should be used as a reference on how to correctly implement the logic
    described above. It can also be extended as needed to support specific
    configurations or environments.
1635 1636
   </para>

1637
   <para>
1638
    <productname>PostgreSQL</productname> does not provide the system
1639 1640 1641 1642
    software required to identify a failure on the primary and notify
    the standby system and then the standby database server. Many such
    tools exist and are well integrated with other aspects required for
    successful failover, such as IP address migration.
1643 1644 1645
   </para>

   <para>
1646
    The means for triggering failover is an important part of planning and
1647 1648 1649 1650 1651 1652 1653
    design. The <varname>restore_command</> is executed in full once
    for each WAL file. The process running the <varname>restore_command</>
    is therefore created and dies for each file, so there is no daemon
    or server process and so we cannot use signals and a signal
    handler. A more permanent notification is required to trigger the
    failover. It is possible to use a simple timeout facility,
    especially if used in conjunction with a known
1654 1655
    <varname>archive_timeout</> setting on the primary. This is
    somewhat error prone since a network problem or busy primary server might
1656 1657 1658
    be sufficient to initiate failover. A notification mechanism such
    as the explicit creation of a trigger file is less error prone, if
    this can be arranged.
1659
   </para>
1660 1661 1662 1663

   <para>
    The size of the WAL archive can be minimized by using the <literal>%r</>
    option of the <varname>restore_command</>. This option specifies the
Peter Eisentraut's avatar
Peter Eisentraut committed
1664
    last archive file name that needs to be kept to allow the recovery to
1665 1666 1667 1668
    restart correctly. This can be used to truncate the archive once
    files are no longer required, if the archive is writable from the
    standby server.
   </para>
1669 1670 1671 1672 1673 1674
  </sect2>

  <sect2 id="warm-standby-config">
   <title>Implementation</title>

   <para>
1675
    The short procedure for configuring a standby server is as follows. For
1676 1677 1678 1679
    full details of each step, refer to previous sections as noted.
    <orderedlist>
     <listitem>
      <para>
1680
       Set up primary and standby systems as near identically as
1681 1682
       possible, including two identical copies of
       <productname>PostgreSQL</> at the same release level.
1683 1684 1685 1686
      </para>
     </listitem>
     <listitem>
      <para>
1687
       Set up continuous archiving from the primary to a WAL archive located
1688 1689 1690 1691
       in a directory on the standby server. Ensure that
       <xref linkend="guc-archive-mode">,
       <xref linkend="guc-archive-command"> and
       <xref linkend="guc-archive-timeout">
1692 1693
       are set appropriately on the primary
       (see <xref linkend="backup-archiving-wal">).
1694 1695 1696 1697
      </para>
     </listitem>
     <listitem>
      <para>
1698 1699
       Make a base backup of the primary server (see <xref
       linkend="backup-base-backup">), and load this data onto the standby.
1700 1701 1702 1703
      </para>
     </listitem>
     <listitem>
      <para>
1704
       Begin recovery on the standby server from the local WAL
1705 1706
       archive, using a <filename>recovery.conf</> that specifies a
       <varname>restore_command</> that waits as described
1707
       previously (see <xref linkend="backup-pitr-recovery">).
1708 1709 1710 1711 1712 1713
      </para>
     </listitem>
    </orderedlist>
   </para>

   <para>
1714 1715 1716 1717 1718
    Recovery treats the WAL archive as read-only, so once a WAL file has
    been copied to the standby system it can be copied to tape at the same
    time as it is being read by the standby database server.
    Thus, running a standby server for high availability can be performed at
    the same time as files are stored for longer term disaster recovery
1719
    purposes.
1720 1721 1722
   </para>

   <para>
1723
    For testing purposes, it is possible to run both primary and standby
1724
    servers on the same system. This does not provide any worthwhile
1725
    improvement in server robustness, nor would it be described as HA.
1726 1727 1728 1729 1730 1731 1732
   </para>
  </sect2>

  <sect2 id="warm-standby-failover">
   <title>Failover</title>

   <para>
1733
    If the primary server fails then the standby server should begin
1734 1735 1736 1737
    failover procedures.
   </para>

   <para>
1738 1739
    If the standby server fails then no failover need take place. If the
    standby server can be restarted, even some time later, then the recovery
1740
    process can also be immediately restarted, taking advantage of
1741
    restartable recovery. If the standby server cannot be restarted, then a
1742
    full new standby server instance should be created.
1743 1744 1745
   </para>

   <para>
1746 1747
    If the primary server fails and then immediately restarts, you must have
    a mechanism for informing it that it is no longer the primary. This is
1748
    sometimes known as STONITH (Shoot the Other Node In The Head), which is
1749
    necessary to avoid situations where both systems think they are the
1750
    primary, which will lead to confusion and ultimately data loss.
1751 1752 1753
   </para>

   <para>
1754
    Many failover systems use just two systems, the primary and the standby,
1755
    connected by some kind of heartbeat mechanism to continually verify the
1756
    connectivity between the two and the viability of the primary. It is
1757 1758 1759
    also possible to use a third system (called a witness server) to prevent
    some cases of inappropriate failover, but the additional complexity
    might not be worthwhile unless it is set up with sufficient care and
1760 1761 1762 1763
    rigorous testing.
   </para>

   <para>
1764
    Once failover to the standby occurs, we have only a
1765
    single server in operation. This is known as a degenerate state.
1766
    The former standby is now the primary, but the former primary is down
1767
    and might stay down.  To return to normal operation we must
1768 1769 1770 1771
    fully recreate a standby server,
    either on the former primary system when it comes up, or on a third,
    possibly new, system. Once complete the primary and standby can be
    considered to have switched roles. Some people choose to use a third
1772 1773
    server to provide backup to the new primary until the new standby
    server is recreated,
1774
    though clearly this complicates the system configuration and
1775
    operational processes.
1776 1777 1778
   </para>

   <para>
1779
    So, switching from primary to standby server can be fast but requires
1780
    some time to re-prepare the failover cluster. Regular switching from
1781 1782 1783
    primary to standby is useful, since it allows regular downtime on
    each system for maintenance. This also serves as a test of the
    failover mechanism to ensure that it will really work when you need it.
1784
    Written administration procedures are advised.
1785 1786 1787 1788
   </para>
  </sect2>

  <sect2 id="warm-standby-record">
1789
   <title>Record-based Log Shipping</title>
1790 1791

   <para>
1792 1793 1794
    <productname>PostgreSQL</productname> directly supports file-based
    log shipping as described above. It is also possible to implement
    record-based log shipping, though this requires custom development.
1795 1796 1797
   </para>

   <para>
1798 1799
    An external program can call the <function>pg_xlogfile_name_offset()</>
    function (see <xref linkend="functions-admin">)
Peter Eisentraut's avatar
Peter Eisentraut committed
1800
    to find out the file name and the exact byte offset within it of
1801 1802 1803 1804 1805
    the current end of WAL.  It can then access the WAL file directly
    and copy the data from the last known end of WAL through the current end
    over to the standby server(s).  With this approach, the window for data
    loss is the polling cycle time of the copying program, which can be very
    small, but there is no wasted bandwidth from forcing partially-used
1806
    segment files to be archived.  Note that the standby servers'
1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831
    <varname>restore_command</> scripts still deal in whole WAL files,
    so the incrementally copied data is not ordinarily made available to
    the standby servers.  It is of use only when the primary dies &mdash;
    then the last partial WAL file is fed to the standby before allowing
    it to come up.  So correct implementation of this process requires
    cooperation of the <varname>restore_command</> script with the data
    copying program.
   </para>
  </sect2>

  <sect2 id="backup-incremental-updated">
   <title>Incrementally Updated Backups</title>

  <indexterm zone="backup">
   <primary>incrementally updated backups</primary>
  </indexterm>

  <indexterm zone="backup">
   <primary>change accumulation</primary>
  </indexterm>

   <para>
    In a warm standby configuration, it is possible to offload the expense of
    taking periodic base backups from the primary server; instead base backups
    can be made by backing
1832 1833
    up a standby server's files.  This concept is generally known as
    incrementally updated backups, log change accumulation, or more simply,
1834 1835 1836 1837
    change accumulation.
   </para>

   <para>
Bruce Momjian's avatar
Bruce Momjian committed
1838
    If we take a backup of the standby server's data directory while it is processing
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852
    logs shipped from the primary, we will be able to reload that data and
    restart the standby's recovery process from the last restart point.
    We no longer need to keep WAL files from before the restart point.
    If we need to recover, it will be faster to recover from the incrementally
    updated backup than from the original base backup.
   </para>

   <para>
    Since the standby server is not <quote>live</>, it is not possible to
    use <function>pg_start_backup()</> and <function>pg_stop_backup()</>
    to manage the backup process; it will be up to you to determine how
    far back you need to keep WAL segment files to have a recoverable
    backup.  You can do this by running <application>pg_controldata</>
    on the standby server to inspect the control file and determine the
1853
    current checkpoint WAL location, or by using the
1854
    <varname>log_checkpoints</> option to print values to the server log.
1855 1856 1857 1858
   </para>
  </sect2>
 </sect1>

1859
 <sect1 id="migration">
Peter Eisentraut's avatar
Peter Eisentraut committed
1860
  <title>Migration Between Releases</title>
Peter Eisentraut's avatar
Peter Eisentraut committed
1861 1862 1863 1864 1865 1866 1867 1868 1869

  <indexterm zone="migration">
   <primary>upgrading</primary>
  </indexterm>

  <indexterm zone="migration">
   <primary>version</primary>
   <secondary>compatibility</secondary>
  </indexterm>
1870

1871 1872 1873 1874 1875 1876 1877
  <para>
   This section discusses how to migrate your database data from one
   <productname>PostgreSQL</> release to a newer one.
   The software installation procedure <foreignphrase>per se</> is not the
   subject of this section; those details are in <xref linkend="installation">.
  </para>

1878 1879
  <para>
   As a general rule, the internal data storage format is subject to
Peter Eisentraut's avatar
Peter Eisentraut committed
1880 1881 1882
   change between major releases of <productname>PostgreSQL</> (where
   the number after the first dot changes). This does not apply to
   different minor releases under the same major release (where the
1883
   number after the second dot changes); these always have compatible
1884 1885
   storage formats. For example, releases 8.1.1, 8.2.3, and 8.3 are
   not compatible, whereas 8.2.3 and 8.2.4 are. When you update
1886
   between compatible versions, you can simply replace the executables
1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899
   and reuse the data directory on disk. Otherwise you need to back
   up your data and restore it on the new server.  This has to be done
   using <application>pg_dump</>; file system level backup methods
   obviously won't work. There are checks in place that prevent you
   from using a data directory with an incompatible version of
   <productname>PostgreSQL</productname>, so no great harm can be done by
   trying to start the wrong server version on a data directory.
  </para>

  <para>
   It is recommended that you use the <application>pg_dump</> and
   <application>pg_dumpall</> programs from the newer version of
   <productname>PostgreSQL</>, to take advantage of any enhancements
1900
   that might have been made in these programs.  Current releases of the
1901
   dump programs can read data from any server version back to 7.0.
1902 1903 1904 1905 1906
  </para>

  <para>
   The least downtime can be achieved by installing the new server in
   a different directory and running both the old and the new servers
1907
   in parallel, on different ports. Then you can use something like:
1908

1909
<programlisting>
1910
pg_dumpall -p 5432 | psql -d postgres -p 6543
1911
</programlisting>
1912

1913
   to transfer your data.  Or use an intermediate file if you want.
1914 1915
   Then you can shut down the old server and start the new server at
   the port the old one was running at. You should make sure that the
1916 1917
   old database is not updated after you begin to run
   <application>pg_dumpall</>, otherwise you will lose that data. See <xref
1918
   linkend="client-authentication"> for information on how to prohibit
1919 1920 1921
   access.
  </para>

1922
  <para>
1923 1924
   It is also possible to use replication methods, such as
   <productname>Slony</>, to create a slave server with the updated version of
1925 1926 1927 1928 1929 1930
   <productname>PostgreSQL</>.  The slave can be on the same computer or
   a different computer.  Once it has synced up with the master server
   (running the older version of <productname>PostgreSQL</>), you can
   switch masters and make the slave the master and shut down the older
   database instance.  Such a switch-over results in only several seconds
   of downtime for an upgrade.
1931 1932
  </para>

1933
  <para>
1934
   If you cannot or do not want to run two servers in parallel, you can
1935
   do the backup step before installing the new version, bring down
1936
   the server, move the old version out of the way, install the new
1937
   version, start the new server, and restore the data. For example:
1938

1939
<programlisting>
1940
pg_dumpall &gt; backup
1941
pg_ctl stop
1942
mv /usr/local/pgsql /usr/local/pgsql.old
1943
cd ~/postgresql-&version;
1944 1945
gmake install
initdb -D /usr/local/pgsql/data
1946
postgres -D /usr/local/pgsql/data
1947
psql -f backup postgres
1948
</programlisting>
1949

1950 1951 1952 1953 1954 1955 1956 1957
   See <xref linkend="runtime"> about ways to start and stop the
   server and other details. The installation instructions will advise
   you of strategic places to perform these steps.
  </para>

  <note>
   <para>
    When you <quote>move the old installation out of the way</quote>
1958
    it might no longer be perfectly usable. Some of the executable programs
1959
    contain absolute paths to various installed programs and data files.
1960
    This is usually not a big problem, but if you plan on using two
1961
    installations in parallel for a while you should assign them
1962
    different installation directories at build time.  (This problem
1963 1964 1965 1966 1967 1968 1969
    is rectified in <productname>PostgreSQL</> 8.0 and later, so long
    as you move all subdirectories containing installed files together;
    for example if <filename>/usr/local/postgres/bin/</> goes to
    <filename>/usr/local/postgres.old/bin/</>, then
    <filename>/usr/local/postgres/share/</> must go to
    <filename>/usr/local/postgres.old/share/</>.  In pre-8.0 releases
    moving an installation like this will not work.)
1970 1971
   </para>
  </note>
1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034

  <para>
   In practice you probably want to test your client applications on the
   new version before switching over completely.  This is another reason
   for setting up concurrent installations of old and new versions.  When
   testing a <productname>PostgreSQL</> major upgrade, consider the
   following categories of possible changes:
  </para>

  <variablelist>

   <varlistentry>
    <term>Administration</term>
    <listitem>
     <para>
      The capabilities available for administrators to monitor and control
      the server often change and improve in each major release.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>SQL</term>
    <listitem>
     <para>
      Typically this includes new SQL command capabilities and not changes
      in behavior, unless specifically mentioned in the release notes.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>Library API</term>
    <listitem>
     <para>
      Typically libraries like <application>libpq</> only add new
      functionality, again unless mentioned in the release notes.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>System Catalogs</term>
    <listitem>
     <para>
      System catalog changes usually only affect database management tools.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>Server C-language API</term>
    <listitem>
     <para>
      This involved changes in the backend function API, which is written
      in the C programming language.  Such changes effect code that
      references backend functions deep inside the server.
     </para>
    </listitem>
   </varlistentry>

  </variablelist>

2035 2036
 </sect1>
</chapter>