出力を書き出すディレクトリです。 pg_basebackupは必要ならば、このディレクトリとその親ディレクトリすべてを作成します。 ディレクトリはすでに存在してもかまいませんが、存在しかつ空でない場合はエラーになります。

バックアップがtarモードであり、かつ、指定したディレクトリが-（ダッシュ）の場合、tarファイルはstdoutに書き出されます。

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

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

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

この目的は、実行中のサーバに対するpg_basebackupの影響を制限することです。

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

スタンバイサーバの設定を容易にするために、出力ディレクトリ（tar形式の場合はベースアーカイブファイルの中）に最低限のrecovery.confを書き出します。 recovery.confファイルは接続設定の情報、また、指定があればpg_basebackupが使用しているレプリケーションスロットの情報を記録するので、ストリーミングレプリケーションは後で同じ設定を使用します。

ディレクトリolddirにあるテーブル空間を、バックアップ中にnewdirに再配置します。 これが有効であるためには、olddirが、現在のテーブル空間のパス定義と完全に一致している必要があります(ただし、バックアップに含まれるolddir内にテーブル空間がなくてもエラーにはなりません)。 olddirとnewdirはいずれも絶対パスでなければなりません。 パス名に=記号が含まれるときは、バックスラッシュでエスケープしてください。 このオプションは、複数のテーブル空間に対して複数回指定することができます。 以下の例を参照してください。

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

先行書き込みログのディレクトリの場所を指定します。 waldirは絶対パスでなければなりません。 先行書き込みログのディレクトリは、バックアップがplainモードの場合にのみ指定できます。

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

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

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

tarファイル出力のgzip圧縮を有効にします。 また圧縮レベル（0から9まで、0は圧縮なし、9が最高の圧縮レベル）を指定します。 tarファイルを生成する場合のみ圧縮を利用することができ、すべてのtarファイルの名前に拡張子.gzが自動的に付加されます。

Sets checkpoint mode to fast (immediate) or spread (default) (see 25.3.3).

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

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

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

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

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

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

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

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

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

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

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

このオプションは、サーバによりサポートされている場合であってもバックアップ時に一時レプリケーションスロットを作成しないようにします。

ログストリーミングを使うときにオプション-Sでスロット名が与えられなかった場合、一時レプリケーションスロットはデフォルトで作成されます。

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

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

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

サーバとの接続のために使用するパラメータを、接続文字列として指定します。 詳細については34.1.1を参照してください。

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

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

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

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

接続ユーザ名です。

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

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

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

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

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