src/bin/pg_dump/README

   1 $PostgreSQL$
   2
   3 Notes on pg_dump
   4 ================
   5
   6 1. pg_dump, by default, still outputs text files.
   7
   8 2. pg_dumpall forces all pg_dump output to be text, since it also outputs text into the same output stream.
   9
  10 3. The plain text output format cannot be used as input into pg_restore.
  11
  12
  13 To dump a database into the new custom format, type:
  14
  15     pg_dump <db-name> -Fc > <backup-file>
  16
  17 or, to dump in TAR format
  18
  19         pg_dump <db-name> -Ft > <backup-file>
  20
  21 To restore, try
  22
  23    To list contents:
  24
  25        pg_restore -l <backup-file> | less
  26
  27    or to list tables:
  28
  29        pg_restore <backup-file> --table | less
  30
  31    or to list in a different order
  32
  33        pg_restore <backup-file> -l --oid --rearrange | less
  34
  35 Once you are happy with the list, just remove the '-l', and an SQL script will be output.
  36
  37
  38 You can also dump a listing:
  39
  40        pg_restore -l <backup-file> > toc.lis
  41   or
  42        pg_restore -l <backup-file> -f toc.lis
  43
  44 edit it, and rearrange the lines (or delete some):
  45
  46     vi toc.lis
  47
  48 then use it to restore selected items:
  49
  50     pg_restore <backup-file> --use=toc.lis -l | less
  51
  52 When you like the list, type
  53
  54     pg_restore backup.bck --use=toc.lis > script.sql
  55
  56 or, simply:
  57
  58     createdb newdbname
  59     pg_restore backup.bck --use=toc.lis | psql newdbname
  60
  61
  62 TAR
  63 ===
  64
  65 The TAR archive that pg_dump creates currently has a blank username & group for the files,
  66 but should be otherwise valid. It also includes a 'restore.sql' script which is there for
  67 the benefit of humans. The script is never used by pg_restore.
  68
  69 Note: the TAR format archive can only be used as input into pg_restore if it is in TAR form.
  70 (ie. you should not extract the files then expect pg_restore to work).
  71
  72 You can extract, edit, and tar the files again, and it should work, but the 'toc'
  73 file should go at the start, the data files be in the order they are used, and
  74 the BLOB files at the end.
  75
  76
  77 Philip Warner, 16-Jul-2000
  78 pjw@rhyme.com.au