pg_receivewal — PostgreSQLサーバから先行書き込みログをストリームする
pg_receivewal [option...]
pg_receivewalは実行中のPostgreSQLクラスタから先行書き込みログをストリームするために使用されます。 先行書き込みログはストリーミングレプリケーションプロトコルを使用してストリームされ、ローカルディレクトリのファイルとして書き出されます。 このディレクトリはポイントインタイムリカバリ（25.3参照）を用いてリストアする際のアーカイブ場所として使用することができます。
pg_receivewalは先行書き込みログをサーバで生成に合わせてリアルタイムでストリームし、archive_commandとは異なり、セグメントが完了するまで待機することはありません。 このため、pg_receivewalを使用する場合にはarchive_timeoutを設定する必要はありません。
PostgreSQLのスタンバイサーバのWALレシーバと異なり、pg_receivewalはデフォルトでは、WALファイルがクローズされた時にのみ、WALデータをフラッシュします。
WALデータをリアルタイムでフラッシュするには--synchronousオプションを指定する必要があります。
pg_receivewalはWALを適用しないので、synchronous_commitがremote_applyのときにこれを同期スタンバイにすることはできません。
そのようにした場合、決してキャッチアップすることのないスタンバイになり、トランザクションコミットのブロックをひき起こします。
これを避けるには、synchronous_standby_namesに適切な値を設定するか、pg_receivewalに対して一致しないapplication_nameを指定する、あるいは、synchronous_commitの値をremote_apply以外の値に変更してください。
先行書き込みログは通常のPostgreSQL接続を経由して、そしてレプリケーションプロトコルを使用して、ストリームされます。
この接続はスーパーユーザまたはREPLICATION権限（21.2参照）を持つユーザで確立されなければなりません。
そしてpg_hba.confでレプリケーション用の接続を許可しなければなりません。
またサーバではストリーム用に利用できるセッションが少なくとも１つ存在できるためにmax_wal_sendersを十分大きく設定しなければなりません。
接続が失われた場合、または、致命的ではないエラーで初期確立ができなかった場合、pg_receivewalは無期限に接続を再試行しできるだけ早くストリーミングを再確立します。
この動作を止めるためには-nパラメータを使用してください。
致命的なエラーが無い場合、pg_receivewalはSIGINTシグナル（Control+C）で停止されるまで実行を続けます。
-D directory--directory=directory出力を書き出すディレクトリです。
このパラメータは必須です。
-E lsn--endpos=lsn受信が指定したLSNに達したなら、自動的にレプリケーションを停止して、通常の終了ステータス0で終了します。
lsnとちょうど等しいLSNのレコードがある場合、そのレコードは処理されます。
--if-not-exists
--create-slotが指定され、指定された名前のスロットが既に存在していた場合に、エラーを発生させません。
-n--no-loop接続エラー時に繰り返しません。 代わりにエラーですぐに終了します。
--no-sync
このオプションはpg_receivewalがWALデータをディスクに強制的にフラッシュさせないようにします。
これはより高速ですが、オペレーションシステムのクラッシュ後にWALセグメントが破損している可能性があります。
一般に、このオプションはテストには有益ですが、本番配備でWALのアーカイビングを行うときに使うべきではありません。
このオプションは--synchronousと両立しません。
-s interval--status-interval=intervalサーバに状態パケットを返答する間隔を秒単位で指定します。 これによりサーバからより簡単に進行状況を監視することができます。 ゼロという値は状態の定期的な更新を完全に無効にします。 しかしタイムアウトによる切断を防ぐために、サーバから要求された時には更新を送信します。 デフォルト値は１０秒です。
-S slotname--slot=slotnamepg_receivewalが既存のレプリケーションスロットを使うようにします(26.2.6を参照してください)。 このオプションが使われると、pg_receivewalはフラッシュ位置をサーバに報告します。 これは、各セグメントがいつディスクに同期されたかを示し、それによりサーバが必要のなくなったセグメントを削除できるようになります。
pg_receivewalのレプリケーションクライアントが同期スタンバイとしてサーバ上で構成されている場合、レプリケーションスロットを利用するとフラッシュ位置がサーバに報告されますが、それはWALファイルがクローズされる時のみです。
したがって、その構成ではプライマリ上のトランザクションが長時間待たされることになり、結果的に満足する動作を得られません。
これを正しく動作させるには、追加で--synchronousオプション（以下を参照）を指定する必要があります。
--synchronous
WALデータを受け取ると即座にディスクにフラッシュします。
またフラッシュした直後に、--status-intervalの値が何であれ、ステータスパケットをサーバに送り返します。
pg_receivewalのレプリケーションクライアントが同期スタンバイとしてサーバ上で構成されている場合、フィードバックが遅延なくサーバに送り返されることを確実にするため、このオプションを指定すべきです。
-v--verbose冗長モードを有効にします。
-Z level--compress=level
先行書き込みログのgzip圧縮を有効にし、圧縮レベルを指定します（0から9まで、0は圧縮なし、9が最大圧縮）。
すべてのファイル名に、拡張子.gzが自動的に追加されます。
以下のコマンドラインオプションはデータベース接続パラメータを制御します。
-d connstr--dbname=connstrサーバに接続するために使用するパラメータを、接続文字列として指定します。 詳細については34.1.1を参照してください。
このオプションは他のクライアントアプリケーションとの整合性のために--dbnameと呼ばれます。
しかし、pg_receivewalはクラスタ内のどの特定のデータベースにも接続しませんので、接続文字列内のデータベース名は無視されます。
-h host--host=host
サーバが稼働しているマシンのホスト名を指定します。
名前がスラッシュから始まる場合、Unixドメインソケット用のディレクトリとして使用されます。
デフォルトは環境変数PGHOSTが設定されていればその値から取られ、設定されていない場合はUnixドメインソケット接続が試行されます。
-p port--port=port
サーバが接続を待ち受けるTCPポートまたはUnixドメインソケットファイルの拡張子を指定します
デフォルトは環境変数PGPORTが指定されていればその値から取られ、設定されていない場合はコンパイル時のデフォルト値から取られます。
-U username--username=username接続するユーザ名です。
-w--no-password
パスワード入力を促しません。
サーバがパスワード認証を必要とし、かつ、.pgpassファイルなど他の手段でパスワードが入手できない場合、接続試行は失敗します。
このオプションは、パスワードを入力するユーザが存在しないバッチジョブやスクリプトで有用になります。
-W--passwordpg_receivewalはデータベースに接続する前にパスワード入力を強制的に促します。
このオプションは重要ではありません。
pg_receivewalは、サーバがパスワード認証を要求した場合に自動的にパスワードを促すためです。
しかしpg_receivewalは、サーバがパスワードを要求するかどうかを確認するために接続試行を浪費します。
-Wと入力して無駄な接続試行を防止することが有意である場合があります。
pg_receivewalは物理的なレプリケーションスロットを制御するため、以下の2つの動作のうちの1つを実行できます。
--create-slot
--slotで指定された名前の新しい物理的なレプリケーションスロットを作成して終了します。
--drop-slot
--slotで指定された名前の物理的なレプリケーションスロットを削除して終了します。
この他に以下のオプションも使用することができます。
-V--versionpg_receivewalのバージョンを表示し、終了します。
-?--helppg_receivewalコマンドライン引数についてのヘルプを表示し、終了します。
pg_receivewalはSIGINTシグナルで終了されたとき、ステータス0で終了します。 （これは止めるための通常の方法です。そのためエラーではありません。） 致命的エラーや他のシグナルに対しては、終了ステータスは非ゼロになります。
他のほとんどのPostgreSQLユーティリティと同様、このユーティリティはlibpqでサポートされる環境変数（34.14参照）を使用します。
archive_commandの代わりにpg_receivewalをWALのバックアップのメインの方法として使用する場合、レプリケーションスロットを使用することを強く推奨します。 そうしなければ、サーバはarchive_commandとレプリケーションスロットのいずれからもWALのストリームがどこまでアーカイブされているかの情報を得られないため、先行書き込みログファイルがバックアップされる前にそれを再利用または削除するかもしれないのです。 しかし、WALデータを受け取る側がそのフェッチに追いつけない場合、レプリケーションスロットがサーバのディスクスペースを一杯にしてしまうかもしれないことに注意してください。
pg_receivewalは、ソースクラスタでグループパーミッションが有効である場合、受け取ったWALファイルのグループパーミッションを維持します。
先行書き込みログをmydbserverにあるサーバからストリームし、それをローカルディレクトリ/usr/local/pgsql/archiveに格納します。
$pg_receivewal -h mydbserver -D /usr/local/pgsql/archive