NAME

       pg_dump - 將一個PostgreSQL數據庫抽出到一個腳本文件或者其它歸檔文件中

SYNOPSIS

       pg_dump [ option... ] [ dbname ]

DESCRIPTION 描述

       pg_dump  是一個用於備份 PostgreSQL  數據庫的工具。它甚至可以在數據庫正在併發使用的時候進行
       完整一致的備份。 pg_dump 並不阻塞其它用戶對數據庫的訪問（讀或者寫）。

        轉儲格式可以是一個腳本或者歸檔文件。 這個腳本文件的格式是純文本，它包含許多 SQL 命令， 這
       些  SQL  命令可以用於重建該數據庫並將之恢復到保存成腳本的時候的狀態。 要恢復這些腳本，使用
       psql(1)。 它們甚至可以用於在其它機器甚至是其它硬件體系的機器上重建該數據庫，  通過對腳本進
       行一些修改，甚至可以在其它 SQL 數據庫產品上重建該數據庫。

        另外，還有候選的歸檔文件格式可以和   pg_restore(1)   一起使用重建數據庫，  並且它們也允許
       pg_restore(1) 對恢復什麼東西進行選擇，  或者甚至是在恢復之前對需要恢復的條目進行重新排序。
       歸檔文件也是設計成可以跨平臺移植的。

        如果一種候選文件格式和 pg_restore(1)  結合，那麼pg_dump就能提供一種靈活的歸檔和傳輸機制。
       pg_dump 可以用於備份整個數據庫， 然後就可以使用 pg_restore 檢查這個歸檔和/或選擇要恢復的數
       據庫部分。  最靈活等輸出文件格式是 ``custom(客戶化)'' 格式（-Fc）。 它允許對歸檔元素進行選
       取和重新排列， 並且缺省時是壓縮的。tar 格式（-Ft）不是壓縮的並且我們在裝載等時候不可能重排
       列， 不過它也很靈活；還有，它可以用其它工具，比如 tar 處理。

        在運行  pg_dump 的時候，我們應該檢查輸出， 看看是否有任何警告存在（在標準錯誤上打印），特
       別是下面列出的限制。

OPTIONS 選項

        下面的命令行參數用於控制輸出格式。

       dbname
               聲明將要轉儲的數據庫名。 如果沒有聲明這個參數，那麼使用環境變量 PGDATABASE。  如果
              那個環境變量也沒聲明，那麼用發起連接的用戶名。

       -a

       --data-only
               只輸出數據，不輸出結構（表定義）。

               這個選項只是對純文本格式有意義。對於其它格式，你可以在調用 pg_restore 的時候聲明選
              項。

       -b

       --blobs
               在轉儲中包含大對象。

       -c

       --clean
               輸出在創建數據庫創建命令之前先清理（刪除）該數據庫對象的命令。

               這個選項只是對純文本格式有意義。對於其它格式，你可以在調用 pg_restore 的時候聲明選
              項。

       -C

       --create
               以一條創建該數據庫本身並且與這個數據庫聯接等命令開頭進行輸出。  （如果是這種形式的
              腳本，那麼你在運行腳本之前和哪個數據庫聯接就不重要了。）

               這個選項只對純文本格式有意義。對於其它格式，你可以在調用 pg_restore 的時候聲明該選
              項。

       -d

       --inserts
               將數據輸出爲的 INSERT 命令（而不是 COPY）。 這樣會導致恢復非常緩慢。但卻令歸檔更容
              易移植到其它 SQL 數據庫。

       -D

       --column-inserts

       --attribute-inserts
               把數據轉儲爲帶有明確字段名的 INSERT 命令。 （INSERT INTO table(column, ...) VALUES
              ...）。 這樣會導致恢復非常緩慢，但是如果你想重新排列字段的順序，那麼它是必須的。

       -f file

       --file=file
               把輸出發往指定的文件。如果忽略這些，則使用標準輸出。

       -F format

       --format=format
               選擇輸出的格式。format可以是下列之一：

              p
                      輸出純文本SQL腳本文件（缺省）

              t
                      輸出適合輸入到 pg_restore  裏的tar歸檔文件。 使用這個歸檔允許在恢復數據庫時
                     重新排序和/或把表結構排除在外。 同時也可能可以在恢復的時候限制對哪些數據進行
                     恢復。

              c
                      輸出適於給 pg_restore 用的客戶化歸檔。 這是最靈活的格式，它允許對裝載的數據
                     和綱要元素進行重新排列。 這個格式缺省的時候是壓縮的。

       -i

       --ignore-version
               忽略在 pg_dump  和數據庫服務器之間的版本差別。

              pg_dump 可以處理來自以前版本的PostgreSQL   的數據庫，但是太老的版本則不被支持了（目
              前是支持到 7.0）。 如果你需要跨越版本檢查時才使用這個選項（ 而且如 pg_dump 失效，別
              說我沒警告你）。

       -n namespace

       --schema=schema
               只轉儲 schema 的內容。  如果沒有聲明這個選項，所有目標數據庫中的非系統模式都會被轉
              儲出來。

              Note:  注意:   在這個模式裏，pg_dump 並不試圖轉儲任何其它選定模式可能依賴的數據庫對
              象。 因此，系統不保證單一的一個模式的轉儲就可以成功地恢復到一個乾淨的數據庫中去。

       -o

       --oids
               爲每個表都輸出對象標識（OID）。    如果你的應用在某種程度上引用了OID字段的話，（比
              如，在外鍵約束中用到）。 那麼使用這個選項。否則，不應該使用這個選項。

       -O

       --no-owner
               不把對象的所有權設置爲對應源數據庫。   By  default,  pg_dump  issues  SET  SESSION
              AUTHORIZATION statements to  set  ownership  of  created  schema  elements.   These
              statements will fail when the script is run unless it is started by a superuser (or
              the same user that owns all of the objects in the script).  To make a  script  that
              can  be restored by any user, but will give that user ownership of all the objects,
              specify -O.

               這個選項只是對純文本格式有意義。對於其它格式，在你調用 pg_restore 的時候你可以聲明
              該選項。

       -R

       --no-reconnect
               這個選項已經過時，但是出於向下兼容的考慮，仍然接受這個選項。

       -s

       --schema-only
               只輸出表綱要（定義），不輸出數據。

       -S username

       --superuser=username
               聲明關閉觸發器時需要用到的超級用戶名。  它只有使用了 --disable-triggers 的時候纔有
              關係。 （通常，我們最好不要輸入這個參數，而是用超級用戶啓動生成的腳本。）

       -t table

       --table=table
               只輸出表 table 的數據。 很可能是在不同模式裏面有多個同名表；如果這樣，那麼所有匹配
              的表都將被轉儲出來。 同時聲明 --schema 和 --table 則只選擇一個表。

              Note:
               注意:   在這個模式裏，pg_dump  並不試圖轉儲任何其它選定表可能依賴的數據庫對象。 因
              此，系統不保證單一的一個表的轉儲就可以成功地恢復到一個乾淨的數據庫中去。

       -v

       --verbose
               聲明冗餘模式。 這樣將令 pg_dump 在標準錯誤上打印進度信息。

       -x

       --no-privileges

       --no-acl
               避免輸出 ACL（賦予/撤消 命令）和表的所有者關係信息。

       -X use-set-session-authorization

       --use-set-session-authorization
               這個選項廢棄了，保留它是爲了向下兼容。 pg_dump  現在表現得總是想正式選取了這個選項
              一樣。

       -X disable-triggers

       --disable-triggers
               這個選項只是和創建僅有數據的轉儲相關。它告訴 pg_dump  包含在恢復數據時，臨時關閉目
              標表上面的觸發器的命令。 如果你在表上有參考完整性檢查或者其它觸發器，而恢復數據的時
              候你不想重載他們，那麼你就應該使用這個選項。

               目前，爲  --disable-triggers  發出的命令必須用超級用戶來做。 因此，你應該同時用 -S
              聲明一個超級用戶名，或者最好是用一個超級用戶的身份來啓動這個生成的腳本。

               這個選項只對純文本格式有意義。對於其它格式，你可以在調用 pg_restore 的時候聲明這個
              選項。

       -Z 0..9

       --compress=0..9
               聲明在那些支持壓縮的格式中使用的壓縮級別。 （目前只有客戶化格式支持壓縮）。

        下面的命令行參數控制數據庫爲聯接參數。

       -h host

       --host=host
               聲明運行服務器的機器的主機名。  如果數值以斜扛開頭，則它被用做到 Unix 域套接字的路
              徑。 缺省是從  PGHOST  環境變量中取得的，如果設置了這個環境變量的話，否則，嘗試一個
              Unix 域套接字連接。

       -p port

       --port=port
               聲明服務器正在偵聽並等待聯接的 TCP 端口或本地 Unix 主控套接字文件句柄。 缺省時使用
              環境變量 PGPORT 的值（如果存在），或者是編譯時的缺省值。

       -U username
               以給出用戶身分聯接。

       -W
               強制口令提示。如果服務器需要口令認證，那麼這個動作應該自動發生。

ENVIRONMENT 環境

       PGDATABASE

       PGHOST

       PGPORT

       PGUSER
               缺省連接參數

DIAGNOSTICS 診斷

       pg_dump 在內部使用 SELECT 語句。如果你運行 pg_dump  時碰到問題，確認你能夠使用象   psql(1)
       這樣的程序從數據庫選取信息。

NOTES 注意

        如果你的數據庫給template1數據庫增加了任何你自己的東西， 那麼請注意把 pg_dump 的輸出恢復到
       一個真正空的數據庫中；  否則你可能會收到因爲重複定義所追加的對象而造成的錯誤信息。要製作一
       個沒有任何本地附屬物的數據庫， 可以從template0而不是template1拷貝，比如：

       CREATE DATABASE foo WITH TEMPLATE template0;

       pg_dump 有幾個限制：

       •
          在轉儲一個表或者作爲純文本轉儲時，pg_dump 無法操作大對象。 大對象必須整數據庫地使用非文
         本歸檔格式之一進行轉儲。

       •
          在進行純數據轉儲時，並且使用了選項 --disable-triggers  的時候，pg_dump 發出一些查詢先關
         閉在用戶表上面的觸發器， 然後插入數據，數據插入完成後再發出查詢打開觸發器。 如果恢復動作
         在中間停止，那麼系統表可能就會處於一種錯誤狀態。

        tar 歸檔的成員的大小限制於 8 GB。（這個限制是 tar 文件格式的固有限制。） 因此這個格式無法
       用於那些一個表的大小超過這個尺寸的原文表現。  tar 歸檔和任何其它輸出格式的總大小是不受限制
       的，只是可能會又操作系統的限制。

        恢復完之後，我們建議在每個已恢復的對象上運行 ANALYZE。 這樣優化器就可以得到有用的統計。

EXAMPLES 例子

        轉儲一個數據庫：

       $ pg_dump mydb > db.out

        重載這個數據庫：

       $ psql -d database -f db.out

        輸出一個叫 mydb 的包含BLOB  的數據庫到一個 tar 文件：

       $ pg_dump -Ft -b mydb > db.tar

        把這個數據庫（連同BLOB）一起恢復到一個現有的叫 newdb 的數據庫：

       $ pg_restore -d newdb db.tar

HISTORY 歷史

       pg_dump 工具最早出現在 Postgres95 版本 0.02。 非純文本輸出格式在 PostgreSQL 版本 7.1  時引
       入。

SEE ALSO 參見

       pg_dumpall(1), pg_restore(1), psql(1)

譯者

       Postgresql 中文網站 何偉平 <laser@pgsqldb.org>

跋

       本頁面中文版由中文 man 手冊頁計劃提供。
       中文 man 手冊頁計劃：https://github.com/man-pages-zh/manpages-zh