3.2 pgx_dmpall

名前

pgx_dmpall -- データディレクトリ、テーブル空間および設定ファイルのバックアップ

概要

pgx_dmpall [option…]

説明

データディレクトリ、テーブル空間、および設定ファイルをバックアップします。バックアップデータの格納先は、postgresql.confのbackup_destinationパラメータで指定したバックアップ格納ディレクトリです。また、バックアップの正常終了時に不要なアーカイブ済みWALを削除します。

オプション

-c

設定ファイルのみをバックアップします。設定ファイルは以下の3ファイルです。

postgresql.confファイル（postgresql.conf）
ホストベース認証用ファイル（pg_hba.conf）
ident認証用設定ファイル（pg_ident.conf）

なお、postgresql.confのincludeなど、外部参照が設定されている場合は、参照先のファイルもバックアップします。

-C fast|spread --checkpoint=fast|spread: チェックポイントをfastまたはspread（デフォルト）に設定します。fastを指定すると、バックアップ開始時のチェックポイント処理は高速になりますが、集中したI/Oのために動作中のアプリケーションへの性能の影響が大きくなります。spreadではチェックポイントはゆっくり実行されるためアプリケーションへの影響は小さいですが、バックアップに時間がかかります。

-D datadir: データディレクトリを指定します。省略時は、環境変数 PGDATA が有効となります。

-f config_file: 設定ファイルpostgresql.confを指定します。postgresql.confファイルのdata_directoryパラメータに設定したデータディレクトリと設定ファイルを、異なるディレクトリで運用している場合に設定します。

-P tablespaces_list_file --tablespaces-list-file=tablespaces_list_file: コピーコマンドでバックアップ対象とするテーブル空間の名前を記述したファイルパス名を1024バイト未満の長さで指定します。

以下に、ファイル内の形式を説明します。

テーブル空間の名前＜改行＞
テーブル空間の名前＜改行＞
・・・

ファイル内に記述されなかったテーブル空間は、バックアップ格納ディレクトリにバックアップします。また、本オプションの指定がなければ、すべてのテーブル空間をコピーコマンドによってバックアップします。
本オプションは、-Yオプションが指定されている場合に指定可能であり、コピーコマンドでバックアップするテーブル空間を限定する場合に指定します。

-U username --username=username: データベースのスーパーユーザーのユーザー名を指定します。このコマンドを実行している実効ユーザーの名前がデフォルトです。

-Y copy_command_file --copy-command=copy_command_file: バックアップ用コピーコマンドのファイルパス名を1024バイト未満の長さで指定します。本プションは-cオプションと同時に指定することはできません。

-w --no-password: パスワードの入力を促しません。サーバがパスワード認証を必要とし、かつ、.pgpassファイルなどの他の方法が利用できない場合、接続試行は失敗します。バッチジョブやパスワードを入力するユーザーが存在しない場合にこのオプションは有用かもしれません。

-W --password

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

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

--maintenance-db=dbname

接続先となるデータベースの名前を指定します。指定がなければ、postgresデータベースが使用されます。もし存在しなければtemplate1が使用されます。

接続可能であれば、どのデータベースを指定しても構いません。

--exclude-copy-cluster: データベースクラスタをコピーコマンドのバックアップ対象から除外します。本オプションは-Yオプションが指定されている場合に指定可能です。本オプションの指定がなければ、データベースクラスタをコピーコマンドによってバックアップします。

環境

PGDATA: データディレクトリを指定します。-Dオプションを使用して上書きすることができます。

診断

0: 正常終了

0以外: 異常終了

注釈

このコマンドは、データベースサーバの稼働中にのみ実行できます。

このコマンドは、PostgreSQLユーザーアカウントで実行してください。

バックアップ格納ディレクトリ内のファイルを更新、および削除しないでください。データディレクトリを復旧できなくなる可能性があります。

バックアップ格納ディレクトリには、ほかのファイルを格納しないでください。

このコマンドはデータベースに接続するため、接続を1つ使用します。接続を確立するために、WindowsではIPv4のループバック・アドレス127.0.0.1を、それ以外のOSではUNIXドメイン・ソケットを使用します。そのため、pg_hba.confファイルでこれらの接続を許可してください。

本コマンドは、スタンバイサーバでは実行できません。

例

以下は、データディレクトリ、テーブル空間および設定ファイルをバックアップする例です。このとき、バックアップにより不要になったアーカイブ済みWALも破棄されます。

    $ pgx_dmpall