PG_DUMPALL(1)

NAME
pg_dumpall - PostgreSQLデータベースクラスタをスクリプトファイルへ抽出する

SYNOPSIS

pg_dumpall [ option... ]

説明

pg_dumpallはクラスタの全てのPostgreSQLデータベースを、1つのスクリプトファイルに書き出す（``ダンプする''）ためのユーティリティです。 スクリプトファイルには、データベースのリストアのためにpsql(1)への入力として使うことのできるSQLコマンドが含まれています。 リストアはクラスタ内の各データベースに対してpg_dump(1)を呼び出すことで行われます。 さらに、pg_dumpallは、全てのデータベースに共通するグローバルオブジェクトもダンプします （pg_dumpはこれらのオブジェクトを保存しません）。 現時点では、これにはデータベースユーザとグループ、データベース全体に適用するアクセス制限に関する情報が含まれています。

pg_dumpallは全てのデータベースからテーブルを読み込むため、完全なダンプを作成するには、おそらくデータベーススーパーユーザとして接続する必要があると思われます。 さらに、ユーザとグループを追加したり、データベースを作成したりするので、保存されたスクリプトを実行するにはスーパーユーザ権限が必要になるでしょう。

SQLスクリプトは標準出力に書き込まれます。それをファイルにリダイレクトするためには、シェルの演算子を使います。

pg_dumpallは、PostgreSQLサーバに何度か接続しなければなりません（データベースごとに接続することになります）。 パスワード認証を使用している場合、その度にパスワードが必要になると思われます。 そのような場合は~/.pgpassファイルを用意しておくと便利です。 詳細はin the documentationを参照してください。

オプション

以下のコマンドラインオプションは内容や出力形式を制御します。

-a

--data-only
    データのみをダンプし、スキーマ（データ定義）をダンプしません。

-c

--clean
    データベースを再作成するコマンドの前に、データベースのクリーンアップ（削除）するコマンドを書き出します。 ロールおよびテーブル空間用のDROPコマンドも同様に追加されます。

-d

--inserts
    データを（COPYではなく）INSERTコマンドとしてダンプします。 これを行うとリストアが非常に遅くなります。 主にPostgreSQL以外のデータベースにロード可能なダンプを作成する時に有用です。 列の順序を変更した場合はリストアが失敗する可能性があることに注意してください。 さらに低速になりますが、-Dオプションの方が安全です。

-D

--column-inserts

--attribute-inserts
    明示的に列名を付けたINSERTコマンド（INSERT INTO table (column, ...) VALUES...）としてダンプします。 これによりリストアは非常に遅くなります。 主に、PostgreSQL以外のデータベースにロードで可能なダンプを作成する時に有用です。

-g

--globals-only
    グローバルオブジェクト（ロールとテーブル空間）のみをダンプし、データベースのダンプを行いません。

-i

--ignore-version
    pg_dumpallとデータベースサーバのバージョンの不一致を無視します。 pg_dumpallは、以前にリリースされたPostgreSQLデータベースを扱うことができますが、非常に古いバージョン（現時点では7.0より前のバージョン）はサポートしていません。 バージョンチェックを無効にする必要がある場合には、このオプションを使います（この場合、pg_dumpallが失敗しても、警告がなかったとは言わないでください）。

-o

--oids
    各テーブルのオブジェクト識別子（OID）をデータの一部としてダンプします。 アプリケーションでOID列を（外部キー制約など）何らかの形で使用している場合は、このオプションを使用してください。 その他の場合は、このオプションは使用しないでください。

-O

--no-owner
    オブジェクトの所有権を元のデータベースに一致させるためのコマンドを出力しません。 デフォルトでは、pg_dumpallはALTER OWNER文またはSET SESSION AUTHORIZATION文を発行して作成したスキーマ要素の所有権を設定します。 スーパーユーザ（もしくは、スクリプト内の全てのオブジェクトを所有するユーザ）以外のユーザがスクリプトを実行した場合、これらの文は失敗します。 任意のユーザがリストアできるスクリプトを作成するには、-Oを指定してください。ただし、この場合は、全てのオブジェクトの所有者がリストアしたユーザとなってしまいます。

-s

--schema-only
    オブジェクト定義（スキーマ）のみをダンプし、データをダンプしません。

-S username

--superuser=username
    トリガを無効にする際に使用するスーパーユーザのユーザ名を指定してください。 これは--disable-triggersを使用する場合にのみ使用されます （通常はこのオプションを使うよりも、出力されたスクリプトをスーパーユーザ権限で実行する方が良いでしょう）。

-v

--verbose
    冗長モードを指定します。 これを指定すると、pg_dumpallは開始時刻と終了時刻をダンプファイルに、進行メッセージを標準エラーに出力するようになります。 また、これによりpg_dumpの冗長出力が有効になります。

-x

--no-privileges

--no-acl
    アクセス権限のダンプ（grant/revokeコマンド）を行いません。

--disable-dollar-quoting
    このオプションは、関数本体用のドル引用符の使用を無効にし、強制的に標準SQLの文字列構文を使用した引用符付けを行います。

--disable-triggers
    このオプションは、データのみのダンプを作成する場合だけに使用します。 データのリロード中に、対象とするテーブル上のトリガを一時的に使用不可にするためのコマンドを出力するようpg_dumpallに指示します。 このオプションは、データのリロード中には呼び出したくない参照整合性検査やその他のトリガがテーブル上にある場合に使用します。 現在のところ、--disable-triggersを指定してコマンドを実行するのは、スーパーユーザでなければなりません。 そのため、ユーザは-Sでスーパーユーザを指定するか、あるいは、十分に注意してスーパーユーザ権限でスクリプトを開始する必要があります（後者の方がより望ましい方法です）。

--use-set-session-authorization
    ALTER OWNERコマンドの代わりに標準SQLのSET SESSION AUTHORIZATIONコマンドを出力します。 これにより、ダンプの標準への互換性が高まりますが、ダンプ内のオブジェクトの履歴によっては正しくリストアされない可能性があります。

以下のコマンドラインオプションは、データベース接続パラメータを制御します。

-h host
    データベースサーバが稼働しているマシンのホスト名を指定します。 この値がスラッシュから始まる場合、Unixドメインソケット用のディレクトリとして使用されます。 デフォルトは、設定されていればPGHOST環境変数から取得されます。設定されていなければ、Unixドメインソケット接続と仮定されます。

-p port
    サーバが接続を監視するTCPポートもしくはローカルUnixドメインソケットファイルの拡張子を指定します。 デフォルトは、設定されている場合、PGPORT環境変数の値になります。設定されていなければ、コンパイル時のデフォルト値となります。

-U username
    指定したユーザとして接続します。

-W  強制的にパスワードのプロンプトを表示します。 これは、パスワード認証が必要なサーバの場合、自動的に行われます。

環境

PGHOST

PGPORT

PGUSER
    デフォルトの接続パラメータです。

また、このユーティリティは、他のほとんどのPostgreSQLユーティリティと同様、libpqでサポートされる環境変数を使用します（in the documentationを参照してください）。

注釈

pg_dumpallは、内部でpg_dumpを呼び出すので、診断メッセージの一部ではpg_dumpを参照しています。

オプティマイザが正確な統計情報を使用できるように、リストア後は、リストアしたテーブルそれぞれに対してANALYZEを実行することを勧めます。 また、vacuumdb -a -zを実行すると、全てのデータベースを解析することができます。

pg_dumpallでは、必要なテーブル空間用のディレクトリがリストア前に存在していることを要求します。 存在しないと、デフォルト以外の場所にあるデータベースに関して、そのデータベース生成が失敗します。

例

全てのデータベースを書き出す場合、以下のようにします。

$ pg_dumpall > db.out

上記で書き出したデータベースを読み込む場合、以下のようにします。

$ psql -f db.out postgres

（ここではどのデータベースに接続するかということは問題になりません。 なぜならpg_dumpallが作成するスクリプトファイルには、保存されたデータベースの作成および接続のためのコマンドが含まれているからです。）

関連項目

考えられるエラーの原因については、pg_dump(1)を参照してください。