`barman restore`#

概要#

restore
    [ --aws-region AWS_REGION } ]
    [ --azure-resource-group AZURE_RESOURCE_GRP ]
    [ --bwlimit KBPS ]
    [ --exclusive ]
    [ --gcp-zone GCP_ZONE ]
    [ { --get-wal | --no-get-wal } ]
    [ { -h | --help } ]
    [ { -j | --jobs } PARALLEL_WORKERS ]
    [ --jobs-start-batch-period SECONDS ]
    [ --jobs-start-batch-size NUMBER ]
    [ --local-staging-path PATH ]
    [ { --network-compression | --no-network-compression } ]
    [ --no-retry ]
    [ --recovery-conf-filename FILENAME ]
    [ --recovery-staging-path PATH ]
    [ --staging-path STAGING_PATH ]
    [ --staging-location STAGING_LOCATION ]
    [ --combine-mode COMBINE_MODE ]
    [ --remote-ssh-command STRING ]
    [ --retry-sleep SECONDS ]
    [ --retry-times NUMBER ]
    [ --snapshot-recovery-instance INSTANCE_NAME ]
    [ --snapshot-recovery-zone GCP_ZONE ]
    [ --standby-mode ]
    [ --tablespace NAME:LOCATION [ --tablespace NAME:LOCATION ... ] ]
    [ --target-action { pause | shutdown | promote } ]
    [ --target-immediate ]
    [ --target-lsn LSN ]
    [ --target-name RESTORE_POINT_NAME ]
    [ --target-time TIMESTAMP ]
    [ --target-tli TLI ]
    [ --target-xid XID ]
    [ --staging-wal-directory ]
    SERVER_NAME BACKUP_ID DESTINATION_DIR

説明#

PostreSQLサーバーの復元操作を実行します。 Barmanは、宛先ディレクトリのサーバーからバックアップを復元します。復元は、ローカルにbarmanノード自分自身でまたはリモートでSSH経由でアクセス可能な別のマシンで実行できます。場所は、 --remote-ssh-command オプションを使用するかどうかによって決まります。このコマンドの詳細については、 --remote-ssh-command セクションを参照してください。 BACKUP_ID の代わりにショートカットを使用できます。

パラメーター#

SERVER_NAME

barmanノードのサーバーの名前

BACKUP_ID

barmanカタログのバックアップのID。 auto を使用して、 Barmanが復元操作に最適なバックアップを自動的に見つけます。

DESTINATION_DIR

バックアップを復元する宛先ディレクトリ。

--aws-region

スナップショットリカバリー用のインスタンスとディスクが存在するAWSリージョンを指定します。このオプションを使用すると、 Barman構成の aws_region 値をオーバーライドできます。

--azure-resource-group

スナップショットリカバリーのインスタンスとディスクを含むAzureリソースグループを指定します。このオプションを使用すると、 Barman構成の azure_resource_group 値をオーバーライドできます。

--bwlimit

最大転送速度をキロバイト/秒で指定します。 0 の値は、制限がないことを示します。この設定は、 bandwidth_limit 構成オプションをオーバーライドします。

--delta-restore / --no-delta-restore

デルタリカバリーでの delta-restore の使用を有効/無効にします。デフォルトは recovery_options 設定に基づいています。

--exclusive

ターゲット時間、XID、またはLSNを非包括的に設定します。

--gcp-zone

スナップショットリカバリーのインスタンスとディスクが存在するGCPゾーンを指定します。このオプションを使用すると、 Barman構成の gcp_zone 値をオーバーライドできます。

--get-wal / --no-get-wal

リカバリー中のWAL取得での get-wal の使用を有効/無効にします。デフォルトは recovery_options 設定に基づいています。

-h / --help

ヘルプメッセージを表示して終了します。コマンドの使用法に関する情報を提供します。

-j / --jobs

バックアップ中にファイルのコピーに使用するパラレルワーカーの数を指定します。この設定は、構成ファイルで指定されている場合、 parallel_jobs パラメーターをオーバーライドします。

--jobs-start-batch-period

ジョブの単一のバッチを開始する時間を秒単位で指定します。この値は、構成ファイルで設定されている場合、 parallel_jobs_start_batch_period パラメーターをオーバーライドします。デフォルトは 1 秒です。

--jobs-start-batch-size

単一のバッチで開始するパラレルワーカーの最大数を指定します。この値は、構成ファイルで定義されている場合、 parallel_jobs_start_batch_size パラメーターをオーバーライドします。デフォルトは 10 ワーカーです。

--local-staging-path

宛先ディレクトリにコピーされる前にバックアップチェーンが結合されるBarmanホスト上のパスを指定します。ステージングパス内で作成されたコンテンツは、復元プロセスが完了すると削除されます。このオプションは、ブロックレベルのインクリメンタルバックアップから復元するために必要であり、それ以外の場合は効果がありません。

バージョン 3.15 で非推奨: --local-staging-path は非推奨であり、将来のリリースで削除される予定です。代わりに --staging-path および --staging-location を使用してください。

--network-compression / --no-network-compression

リモート復元中のネットワーク圧縮を有効/無効にします。デフォルトは network_compression 構成設定に基づいています。

--no-retry

エラーが発生した場合の再試行はありません。 --retry-times 0 の設定と同じです。

--recovery-conf-filename

Postgresバージョン12以降のバックアップを復旧するときに、 Barmanが復旧オプションを書き込むファイルの名前を指定します。デフォルトでは、これは postgresql.auto.conf に設定されます。ただし、 --recovery-conf-filename が指定されている場合、リカバリオプションは代わりに指定された値に書き込まれます。デフォルト値はほとんどのPostgresインストールに適していますが、このオプションにより、 Postgresが構成メカニズムを変更するツールで管理されている場合たとえば、 postgresql.auto.conf が /dev/null にシンボリックリンクされている場合、代替の場所を指定できます。

--recovery-staging-path

圧縮バックアップのファイルが宛先ディレクトリに解凍される前にステージングされる復旧ホスト上のパスを指定します。バックアップは、命名規則 barman-staging-SERVER_NAME-BACKUP_ID に従って、ステージングパス内の独自のディレクトリにステージングされます。このステージングディレクトリは、復元プロセスが完了すると削除されます。このオプションは圧縮バックアップから復元するために必須であり、それ以外の場合は効果がありません。

バージョン 3.15 で非推奨: --recovery-staging-path は非推奨であり、将来のリリースで削除される予定です。代わりに --staging-path および --staging-location を使用してください。

--staging-path

リストア中に中間ファイルがステージングされるパス。圧縮されたバックアップを復元する場合、最終的な宛先にコピーする前に、解凍の一時的な場所として機能します。インクリメンタルバックアップを復元する場合、最終的な宛先にコピーする前にバックアップが結合されます。この場所には、解凍/結合されたバックアップを保存するための十分な領域が必要です。

--staging-location

--staging-path がローカルパスかリモートパスであるかを指定します。有効な値は local および remote です。

--combine-mode

リストア中にインクリメンタルバックアップを組み合わせる場合、 pg_combinebackup のコピーモードを指定します。

オプションには次のものが含まれます

copy デフォルトインクリメンタルバックアップを組み合わせる場合、標準のファイルコピーを使用します。
link インクリメンタルバックアップを組み合わせる場合、ハードリンクを使用します。合成バックアップの再構成はより速くなりファイルコピーなし、使用するディスク領域は少なくなります。
clone 新しいデータディレクトリにファイルをコピーする代わりに、効率的なファイルクローン作成一部のシステムでは「reflink」としても知られますを使用します。これにより、データファイルのほぼ瞬時のコピーが行われます。
copy-file-range copy_file_range システムコールを使用して、効率的なコピーを行います。一部のファイルシステムでは、これにより clone と同様の結果が得られ、物理ディスクブロックを共有しますが、他のファイルシステムでは、ブロックをコピーする場合がありますが、最適化されたパスを介して実行します。

各モードの詳細と制限については、 pg_combinebackup documentation を参照してください。

--remote-ssh-command

このオプションは、リモートホストで実行するsecure Shellコマンドを指定することにより、リモート復元を有効にします。これは、リモートリストアの構成ファイル 'ssh USER@SERVER' の ssh_command サーバーオプションと同様に機能します。

--retry-sleep

コピーが失敗した後、再試行するまでに待機する秒数を指定します。この設定は、バックアップとリストア操作の両方に適用され、構成ファイルで定義されている場合 basebackup_retry_sleep パラメーターをオーバーライドします。

--retry-times

エラーが発生した場合に、ベースバックアップコピーを再試行する回数を指定します。これは、バックアップ操作とリストア操作の両方に適用され、構成ファイルに設定されている場合 basebackup_retry_times パラメーターをオーバーライドします。

--snapshot-recovery-instance

スナップショットから復元されたディスクが接続されているインスタンスの名前を指定します。このオプションは、 backup_method=snapshot で作成されたバックアップをリカバリする場合に必要です。

--snapshot-recovery-zone 非推奨

スナップショットリカバリーのインスタンスとディスクを含むゾーン非推奨: --gcp-zone に置き換えられます。

--standby-mode

Postgresサーバーをスタンバイとして起動するかどうか。

--tablespace

テーブルスペースの再配置ルールを指定します。 NAME はテーブルスペース名であり、 LOCATION はテーブルスペースを復元するための復旧ホスト宛先パスです。

--target-action

回復目標に到達すると、指定されたアクションをトリガーします。このオプションでは、これらのアクションのいずれかとともにターゲットを定義する必要があります。可能な値は次のとおりです。

pause 復旧目標に到達すると、サーバーは一時停止状態で起動され、ユーザーはインスタンスを検査できます
promote 復旧ターゲットに到達すると、サーバーは復旧オペレーションを終了し、マスターとして昇格します。
shutdown 復旧目標に到達すると、サーバーはシャットダウンされます。

--target-immediate

一貫した状態に到達すると、リカバリは完了しますベースバックアップの終了。

--target-lsn

指定されたLSNログシーケンス番号にリカバリします。 Postgres 10以上が必要です。

--target-name

pg_create_restore_point(name) で以前に作成した復元ポイントの指定された名前にリカバリーします。

--target-time

指定した時間にリカバリーします。 YYYY-MM-DD HH:MM:SS.mmm 形式を使用します。

--target-tli

指定されたタイムラインを復元します。数値のタイムラインIDに加えて、特別な値 current および latest を使用できます。 Postgresバージョン12以降の場合、デフォルトでは、WALアーカイブの最新のタイムラインにリカバリーします。 12より前のPostgresバージョンの場合、デフォルトでは、バックアップが取得された時点のタイムラインにリカバリーします。

--target-xid

指定されたトランザクションIDにリカバリします。

--staging-wal-directory: PITRを実行する際のWALファイルの宛先ホスト上のステージングディレクトリ。指定しない場合、宛先ディレクトリ内の barman_wal ディレクトリを使用します。

barman restore#

概要#

説明#

パラメーター#

`barman restore`#