pg_dump

ダンプ（抽出）するデータベースの名前を指定します。 指定されていない場合は、PGDATABASE環境変数が使われます。 この変数も設定されていない場合は、接続のために指定されたユーザ名が使用されます。

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

このオプションは、プレインテキスト形式の場合にのみ有効です。 アーカイブ形式では、pg_restoreを呼び出す時にこのオプションを指定することができます。

ラージオブジェクトをダンプに含めます。 これはデフォルトの動作ですが、--schema、--table、--schema-onlyが指定された場合は例外です。 したがって、-bオプションは選択的なダンプにラージオブジェクトを追加する場合にのみ有用です。

データベースオブジェクトを作成するコマンドの前に、データベースをクリーンアップ（削除）するコマンドを書き出します。

このオプションは、プレインテキスト形式の場合にのみ有効です。 アーカイブ形式では、pg_restoreを呼び出す時にこのオプションを指定することができます。

初めにデータベース自体を作成するコマンドを出力し、その後、作成したデータベースに接続するコマンドを出力します （このようなスクリプトを使用すると、スクリプトを実行する前にどのデータベースに接続すればよいかという問題を考える必要がなくなります）。

このオプションは、プレインテキスト形式の場合にのみ有効です。 アーカイブ形式では、pg_restoreを呼び出す時にこのオプションを指定することができます。

データを（COPYではなく）INSERTコマンドの形式でダンプします。 これを行うとリストアに非常に時間がかかります。 主にPostgreSQL以外のデータベースへロード可能なダンプを作成する時に有用です。 また、このオプションは各行に対して別々のコマンドを生成しますので、一行を再ロードする時にエラーになったとしても、テーブルの内容まるごと失われることなく、一行のみが失われるだけです。 列の順序を変更した場合はリストアが失敗する可能性があることに注意してください。 -Dの方がより処理が遅くなりますが、列の順序変更に対して安全です。

明示的に列名を付けたINSERTコマンド（INSERT INTO table (column, ...)VALUES...）としてデータをダンプします。 これによりリストアは非常に遅くなります。 主にPostgreSQL以外のデータベースへロード可能なダンプを作成する時に有用です。 また、このオプションは各行に対して別々のコマンドを生成しますので、一行を再ロードする時にエラーになったとしても、テーブルの内容まるごと失われることなく、一行のみが失われるだけです。

指定した文字セット符号化方式でダンプを作成します。 デフォルトでは、ダンプはデータベースの符号化方式で作成されます （PGCLIENTENCODING環境変数を好みのダンプ時の符号化方式に設定することで、同じ結果を得ることができます）。

出力を指定のファイルに送ります。 省略時は標準出力が使用されます。

出力形式を選択します。 formatには、以下のいずれかが入ります。

pg_dumpとデータベースサーバのバージョンの不一致を無視します。

pg_dumpは、実行中の過去のリリースのPostgreSQLからダンプすることができますが、（現時点では7.0より前の）非常に古いバージョンのデータベースはサポートしていません。 使用するpg_dumpより新しいサーバからダンプすることはほとんどの場合できません。 バージョンチェックを無効にする必要がある場合には、このオプションを使います（この場合、pg_dumpが失敗しても、警告がなかったとは言わないでください）。

schemaに一致するスキーマのみをダンプします。 これはスキーマ自体とそこに含まれるオブジェクトすべてを選択します。 このオプションが指定されなければ、対象データベース内にあるシステム以外のスキーマ全てがダンプされます。 複数の-nオプションを記述することで、複数のスキーマを選択することができます。 また、schemaパラメータはpsqlの\dコマンドと同じ規則に従うパターンとして解釈されます。 （パターン参照） ですので、ワイルドカード文字をパターン内に記述することで、複数のスキーマを選択することもできます。 ワイルドカードを使用する時は、シェルによりそのワイルドカードを展開させないように、パターンを引用符で括ってください。

schemaパターンに一致するスキーマをダンプしません。 このパターンは-nと同様の規則に従って解釈されます。 -Nを複数指定して、複数のパターンのいずれかに一致するスキーマを除外することができます。

-nと-Nの両方が指定された場合、少なくとも1つの-nに一致し-Nオプションに一致しないスキーマだけがダンプされます。 -nなしで-Nが指定された場合、-Nに一致するスキーマが指定がない通常のダンプから除外されます。

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

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

このオプションは、プレインテキスト形式の場合にのみ有効です。 アーカイブ形式では、pg_restoreを呼び出す時にこのオプションを指定することができます。

このオプションは廃止されましたが、後方互換性を保持するため受け入れられます。

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

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

tableに一致するテーブル（またはビューやシーケンス）のみをダンプします。 複数の-tオプションを記述することで複数のテーブルを選択することができます。 また、tableパラメータはpsqlの \dコマンドで使用される規則と同じ規則に従うパターンとして解釈されます。 ですので、ワイルドカード文字をパターン内に記述することで、複数のテーブルを選択することもできます。 ワイルドカードを使用する時は、シェルによりそのワイルドカードを展開させないように、パターンを引用符で括ってください。

-tが使用されると、-nおよび-Nオプションの効果はなくなります。 -tで選択したテーブルが、これらのオプションとは関係なくダンプされ、また、非テーブルオブジェクトはダンプされないためです。

tablesパターンに一致する場合、ダンプしません。 このパターンは-tと同じ規則に従って解釈されます。 -Tを複数指定することで、複数のパターンに一致するテーブルを除外させることができます。

-tと-Tの両方が指定された場合、少なくとも1つの-tオプションに一致し、-Tオプションに一致しないテーブルのみがダンプされます。 -tなしで-Tが指定された場合、このオプションが指定されない場合の通常のダンプから-Tに一致するテーブルが除外されます。

冗長モードを指定します。 これを指定すると、pg_dumpは、詳細なオブジェクトコメント、開始時刻、終了時刻をダンプファイルに、進行状況メッセージを標準エラーに出力します。

アクセス権限（grant/revokeコマンド）のダンプを抑制します。

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

このオプションは、データのみのダンプを作成する場合にしか適用されません。 データのリロード中に、pg_dumpに対し、対象テーブル上のトリガを一時的に無効にするコマンドを出力するよう指示します。 このオプションは、データのリロード中には呼び出したくない参照整合性検査やその他のトリガがテーブル上にある場合に使用します。

現在のところ、--disable-triggersを指定してコマンドを実行するのは、スーパーユーザでなければなりません。 そのため、ユーザは-Sでスーパーユーザを指定するか、あるいは、十分に注意してスーパーユーザ権限でスクリプトを開始する必要があります（後者の方がより望ましい方法です）。

このオプションは、プレインテキスト形式の場合にのみ有効です。 他の形式では、pg_restoreを呼び出す時にこのオプションを指定することができます。

オブジェクトの所有権を決定するために、ALTER OWNERコマンドの代わりに標準SQLのSET SESSION AUTHORIZATIONコマンドを出力します。 これにより、ダンプの標準への互換性が高まりますが、ダンプ内のオブジェクトの履歴によっては正しくリストアされない可能性が生じます。 また、SET SESSION AUTHORIZATIONを使用したダンプを正しくリストアするためには、確実にスーパーユーザ権限が必要となります。 ALTER OWNERで必要な権限はこれよりも少なくなります。

使用する圧縮レベルを指定します。 ゼロは非圧縮を意味します。 カスタムアーカイブ形式では、これは個々のテーブルデータセグメントの圧縮を指定し、デフォルトでは中間レベルで圧縮します。 平文出力では、非ゼロの圧縮レベルを設定すると、あたかもgzipに渡したかのように、出力ファイル全体が圧縮されます。 しかしデフォルトは非圧縮です。 現在tarアーカイブ形式では圧縮をまったくサポートしていません。

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

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

接続ユーザ名です。

データベースに接続する前に、pg_dumpは強制的にパスワード入力を促します。

サーバがパスワード認証を要求する場合pg_dumpは自動的にパスワード入力を促しますので、これが重要になることはありません。 しかし、pg_dumpは、サーバにパスワードが必要かどうかを判断するための接続試行を無駄に行います。 こうした余計な接続試行を防ぐために-Wの入力が有意となる場合もあります。

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