出力を書き出す対象のディレクトリを設定します。 pg_basebackupは、存在していなければこのディレクトリ(とその親ディレクトリのうち存在していないものすべて)を作成します。 ディレクトリはすでに存在してもかまいませんが、空でなければなりません。

バックアップがtar形式であり、かつ、対象のディレクトリが-（ダッシュ）の場合、tarファイルをstdoutに書き出します。

このオプションは必須です。

出力形式を選択します。 formatには以下のいずれかを取ることができます。

standby.signal を作成し、対象のディレクトリ（tar形式の場合はベースアーカイブファイルの中）にあるpostgresql.auto.confに接続設定を追加します。 これにより、バックアップの結果を利用するスタンバイサーバの設定が容易になります。

postgresql.auto.confファイルは接続設定の情報、また、指定があればpg_basebackupが使用しているレプリケーションスロットの情報を記録するので、ストリーミングレプリケーションは後で同じ設定を使用します。

ベースバックアップを格納する場所をサーバに指示します。 デフォルトターゲットはclientです。これはpg_basebackupが実行されているマシンにバックアップが送信されるように指定します。 ターゲットがserver:/some/pathに設定されている場合、バックアップはサーバが実行されているマシンの/some/pathディレクトリに格納されます。 サーバにバックアップを格納するには、スーパーユーザ権限またはpg_write_server_filesロールの権限が必要です。 ターゲットがblackholeに設定されている場合、内容は破棄され、どこにも格納されません。 実際のバックアップは作成されないので、これはテスト目的でのみ使用してください。

WALストリーミングはサーバではなくpg_basebackupによって実装されているため、このオプションは-Xstreamと一緒に使用することはできません。 それがデフォルトであるため、このオプションを指定する場合は-Xfetchか-Xnoneも指定する必要があります。

ディレクトリolddirにあるテーブル空間を、バックアップ中にnewdirに再配置します。 これが有効であるためには、olddirが、ソースサーバでのテーブル空間のパス定義と完全に一致している必要があります。 (ただし、ソースサーバのolddir内にテーブル空間がなくてもエラーにはなりません。) 一方、newdirは受け取るホストのファイルシステム内のディレクトリです。 主対象ディレクトリと同様に、newdirは既に存在している必要はありませんが、存在している場合には空でなければなりません。 olddirとnewdirはいずれも絶対パスでなければなりません。 パス名に等号(=)を含む必要がある場合には、バックスラッシュをその前に付けてください。 このオプションは、複数のテーブル空間に対して複数回指定することができます。

この方法でテーブル空間を再配置すると、メインのデータディレクトリ内のシンボリックリンクは、新しい場所を指すように更新されます。 このため、新しいデータディレクトリは、すべてのテーブル空間が更新された場所にあり、新しいサーバインスタンスがすぐに使える状態になっています。

現在、このオプションはplain出力形式でのみ機能します。tar形式が選択されている場合は無視されます。

WAL(先行書き込みログ)ファイルを書き込むディレクトリを設定します。 デフォルトでは、WALファイルは対象のpg_walサブディレクトリに置かれますが、どこか他の場所に置くためにこのオプションが使えます。 waldirは絶対パスでなければなりません。 主対象ディレクトリと同様に、waldirは既に存在している必要はありませんが、存在している場合には空でなければなりません。 このオプションは、バックアップがplain形式の場合にのみ指定できます。

必要なWAL（先行書き込みログ）ファイルをバックアップに含めます。 これはバックアップ中に生成された先行書き込みログをすべて含みます。 方法noneを指定しない場合、ログアーカイブを考慮することなく展開した対象ディレクトリ内でpostmasterを起動することができます。 つまり出力は完全なスタンドアローンバックアップを作成します。

以下の先行書き込みログを収集するためのmethodがサポートされます。

tarファイル出力のデフォルトの圧縮レベルによるgzip圧縮を有効にします。 tarファイルを生成する場合のみ圧縮を利用することができ、すべてのtarファイルの名前に拡張子.gzが自動的に付加されます。

バックアップの圧縮を要求します。 clientまたはserverが含まれている場合、それは圧縮を実行する場所を指定します。 サーバで圧縮すると、転送帯域幅が減少しますが、サーバのCPU消費が増加します。 デフォルトはclientですが、--targetを使用している場合は例外です。 その場合、バックアップはクライアントに送信されないため、サーバ圧縮のみが有効です。 デフォルトの-Xstreamが使用されている場合、サーバ側の圧縮はWALに適用されません。 WALを圧縮するには、クライアント側の圧縮を使用するか、-Xfetchを指定します。

圧縮方法は、gzip、lz4、zstdで、圧縮しない場合はnoneに設定できます。 オプションで圧縮の詳細文字列を指定できます。 詳細文字列が整数の場合は、圧縮レベルを指定します。 それ以外の場合は、keywordまたはkeyword=value形式のカンマ区切りの項目のリストにする必要があります。 現在サポートされているキーワードは、levelおよびworkersです。

圧縮レベルが指定されていない場合、デフォルトの圧縮レベルが使用されます。 アルゴリズムを指定せずにレベルのみが指定されている場合、レベルが0より大きい場合はgzip圧縮が使用され、レベルが0の場合は圧縮が使用されません。

tar形式をgzip、lz4、zstdとともに使用すると、接尾辞.gz、.lz4、.zstがそれぞれすべてのtarファイルに自動的に追加されます。 plain形式を使用する場合、クライアント側の圧縮は指定されない可能性がありますが、サーバ側の圧縮を要求することは可能です。 この場合、サーバは転送用にバックアップを圧縮し、クライアントは展開して抽出します。

このオプションを-Xstreamと組み合わせて使用すると、クライアント側のgzip圧縮が選択されている場合、pg_wal.tarはgzipを使って圧縮されますが、他の圧縮アルゴリズムが選択されている場合やサーバ側の圧縮が選択されている場合は圧縮されません。

チェックポイントモードをfast(即座に発行)またはspread(デフォルト)に設定します(26.3.3を参照してください)。

バックアップ開始前に--slotオプションで名づけられたレプリケーションスロットを作成することを指定します。 スロットが既に存在する場合、エラーが生じます。

バックアップのラベルを設定します。 何も指定がない場合、「pg_basebackup base backup」というデフォルト値が使用されます。

デフォルトでは、pg_basebackupがエラーでアボートするとき、ジョブを完了できないことがわかるより前に作成したすべてのディレクトリ（例えば、対象のディレクトリと先行書き込みログのディレクトリ）を削除します。 このオプションはきれいに片付けることを禁止するので、デバッグのために有用です。

テーブル空間のディレクトリはいずれにせよ削除されないことに注意してください。

デフォルトではpg_basebackupは全てのファイルがディスクに安全に書き出されるのを待ちます。 このオプションでpg_basebackupは待つことなく返ります。これは高速ですが、その後のオペレーションシステムのクラッシュでベースバックアップの破損が残るかもしれないことを意味します。 一般にこのオプションはテスト用に有用なのであって、本番導入の際に使うべきではありません。

進行状況報告を有効にします。 これを有効にすると、バックアップ中におおよその進行状況が報告されます。 データベースはバックアップ中に変更があるかもしれませんので、これはおおよそでしかなくちょうど100%では終わらないかもしれません。 特に、WALログがバックアップに含まれる場合、データ総量は前もって予測することはできません。 このためこの場合、推定対象容量はWALなしの総推定量を過ぎた後増加します。

ソースサーバから収集されるデータの最大転送速度です。 これは、サーバでのpg_basebackupの影響を制限するのに有用です。 値は秒あたりのキロバイト数です。 添字Mを使うと秒あたりのメガバイト数を指定できます。 添字kを使うこともできますが、効果はありません。 有効な値は秒あたり32キロバイトから秒あたり1024メガバイトまでです。

このオプションはデータディレクトリの転送に対しては、常に影響があります。 WALファイルの転送については、収集方法がfetchの場合にのみ影響があります。

このオプションは-X streamと一緒でのみ使用できます。 これはWALストリーミングに指定したレプリケーションスロットを使用させます。 レプリケーションスロットを使うストリーミングレプリケーションのスタンバイとしてベースバックアップを使用するつもりであるなら、スタンバイはprimary_slot_nameと同じレプリケーションスロット名を使うべきです。 これにより、ベースバックアップ終了と新しいスタンバイでのストリーミングレプリケーション開始の間の時間にプライマリサーバが必要なWALデータを削除しないことが確実になります。

指定されたレプリケーションスロットは、オプション-Cも使われている場合を除き、存在していなければなりません。

このオプションが指定されておらず、サーバが一時レプリケーションスロットに対応している（バージョン10以降）場合、WALストリーミングに対して一時レプリケーションスロットが自動的に使われます。

冗長モードを有効にします。 開始時および終了段階でいくつか追加の段階が出力されます。 また進行状況報告も有効な場合、現在処理中のファイル名も正しく出力されます。

バックアップマニフェストに含まれる各ファイル適用されるチェックサムアルゴリズムを指定します。 現在利用できるアルゴリズムはNONE、CRC32C、SHA224、SHA256、SHA384、SHA512です。 デフォルトはCRC32Cです。

NONEが選択されれば、バックアップマニフェストはチェックサムを含みません。 それ以外の場合、バックアップ内の各ファイルの指定したアルゴリズムを使ったチェックサムを含みます。 さらに、マニフェストは自身の内容のSHA256チェックサムを常に含みます。 SHAアルゴリズムはCRC32CよりもかなりCPU集約的なため、そのどれかを1つを選択するとバックアップの完了に掛かる時間が増えるでしょう。

SHAハッシュ関数を使うと、バックアップが変更されていないことを検証したい利用者にとっては暗号学的に安全な各ファイルのダイジェストが提供されますが、一方、CRC32Cアルゴリズムでは計算がずっと速いチェックサムが提供されます。偶発的な変更によるエラーを補足するのには良いですが、悪意のある修正に抵抗力はありません。 バックアップにアクセスした敵に対抗するのに有用なように、バックアップマニフェストは、どこか他のところに安全に保管するか、バックアップが取られて以来変更されたことがないのを検証する必要があることに注意してください。

pg_verifybackupを使ってバックアップマニフェストに対するバックアップの完全性を検査できます。

バックアップマニフェスト内のファイル名をすべて強制的に16進数でエンコードします。 このオプションが指定されなければ、UTF8でないファイル名だけが16進数でエンコードされます。 このオプションは主に、バックアップマニフェストファイルを読むツールが、この場合を正しく扱うか試験することを意図しています。

ストリームされるバックアップデータの総量をサーバが評価しないようにします。その結果、pg_stat_progress_basebackupビューのbackup_total列は常にNULLになります。

このオプションがなければ、バックアップはまずデータベース全体容量を計算し、その後バックアップに戻り、実際の内容を送信します。 これにより、バックアップに要する時間は少し長くなるかもしれません。特に最初のデータが送られるようになるまでの時間がより長くなります。 このオプションは、評価時間が長過ぎる場合にそれを避けるのに有用です。

--progressを使う場合には、このオプションは認められません。

バックアップマニフェストを生成しないようにします。 このオプションが指定されなければ、サーバはpg_verifybackupを使って検証できるバックアップマニフェストを生成し送信します。 マニフェストは、含まれるかもしれないWALファイルを除いて、バックアップの中にある各ファイルの一覧です。 各ファイルの大きさや最終修正時刻、省略可能なチェックサムも保存されます。

バックアップ時に一時レプリケーションスロットを作成しないようにします。

デフォルトでは、ログストリーミングが選択されたものの-Sオプションでスロット名が与えられなかった場合、(ソースサーバがサポートしていれば)一時レプリケーションスロットが作成されます。

このオプションの主な目的は、サーバにレプリケーションスロットの空きが無いときにベースバックアップを取得できるようにすることです。 レプリケーションスロットを使うことは、必要とされるWALがバックアップ中のサーバにより削除されることを防止するため、ほとんどの場合に好ましいです。

ベースバックアップ取得元のサーバでチェックサムの検証が有効になっている場合に、チェックサムの検証を無効化します。

デフォルトでは、チェックサムは検証され、チェックサムエラーは非ゼロの終了ステータスをもたらします。 とはいえ、このような場合には、--no-cleanオプションが使われていたかのように、ベースバックアップは削除されません。 チェックサム検証の失敗はpg_stat_databaseビューでも報告されます。

サーバとの接続のために使用するパラメータを、接続文字列として指定します。 衝突するコマンドラインオプションよりも優先します。

このオプションは他のクライアントアプリケーションとの整合性のために--dbnameと呼ばれます。 しかし、pg_basebackupはクラスタ内の何らかの特定のデータベースに接続しませんので、接続文字列内のデータベース名は無視されます。

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

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

状態パケットがソースサーバに返送される間隔を秒単位で指定します。 より小さな値を指定することで、より正確にサーバからバックアップの進行状況を監視できます。 ゼロという値は定期的な状態更新を完全に無効にします。 しかし、タイムアウトによる切断を防止するために、サーバにより要求された場合には更新が送信されます。 デフォルト値は10秒です。

接続ユーザ名を指定します。

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

ソースサーバに接続する前に、pg_basebackupは強制的にパスワード入力を促します。

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

pg_basebackupのバージョンを表示し終了します。

pg_basebackupコマンドライン引数の使用方法を表示し、終了します。