コマンドリファレンス
導入
コマンドは、さまざまな pgBackRest 関数を実行するために使用されます。ここでは、コマンド オプションが網羅的にリストされています。つまり、コマンドに適用される各オプションは、1 つ以上の他のコマンドに適用される場合でも、そのコマンドとともにリストされます。これには、pgbackrest.conf で構成できるすべてのオプションが含まれます。
pgbackrest.conf で構成された非ブール型オプションは、reset- プレフィックスを使用してコマンドラインでデフォルトにリセットできます。この機能は、バックアップをリポジトリ ホストに直接復元するために使用できます。通常、pgBackRest はデータベース ホストがリモートにあり、復元をリモートで実行できないことがわかるため、エラーが発生します。コマンドラインに --reset-pg1-host を追加すると、pgBackRest はリモート データベース ホストを無視し、ローカルに復元します。特定のパス (データベース ホストで使用されているパスではない) で復元を強制的に実行するには、新しい --pg1-path を渡すことが必要な場合があります。
no- プレフィックスは、コマンドラインでブール型オプションを false に設定するために使用できます。
PGBACKREST_ プレフィックスと、- を _ に置き換えるすべて大文字のオプション名を使用して、任意のオプションを環境変数に設定できます。 pg1-path は PGBACKREST_PG1_PATH になり、stanza は PGBACKREST_STANZA になります。ブール値オプションは、設定ファイル内にあるものと同じように表現されます。 PGBACKREST_COMPRESS="n" および reset-* のバリアントは許可されません。コマンドラインまたは構成ファイルで複数回指定できるオプションは、値をコロンで区切ることで表すことができます。 PGBACKREST_DB_INCLUDE="db1:db2"。
コマンドライン オプションは、構成ファイル オプションをオーバーライドする環境オプションをオーバーライドします。
オプションの種類については、構成の概要 を参照してください。
コマンド
| コマンド | 概要 |
|---|---|
annotate | バックアップの作成後に、バックアップの注釈を追加、変更、または削除します。 |
archive-get | 復元、PITR、またはレプリカのリカバリのために、アーカイブされた WAL セグメントをフェッチします。 |
archive-push | PostgreSQL から WAL セグメントを受け入れ、構成されたリポジトリにプッシュします。 |
backup | ターゲット リポジトリ (デフォルトでは最も優先度の高いリポジトリ) にバックアップを作成します。 |
check | スタンザのバックアップ/アーカイブ構成と WAL アーカイブの健全性を検証します。 |
expire | 構成された保持ポリシーに基づいて、バックアップとアーカイブされた WAL を期限切れにします。 |
help | コマンドおよびオプションのヘルプを一般、コマンド、またはオプションのレベルで表示します。 |
info | スタンザとバックアップのステータス/メタデータをテキストまたは JSON 形式で表示します。 |
repo-get | 管理、調査、テストのためにリポジトリ ファイル (cat など) を読み取ります。 |
repo-ls | 管理、調査、テストのためにリポジトリ ファイル/パス (ls など) をリストします。 |
restore | オプションのポイントインタイムリカバリを使用して、バックアップ (デフォルトでは最新) から復元します。 |
server | SSH を使用しないリモート ホスト アクセスには、pgBackRest TLS サーバーを実行します。 |
server-ping | pgBackRest TLS サーバーに ping を実行して、接続が受け入れられていることを確認します。 |
stanza-create | 構成されているすべてのリポジトリにスタンザ メタデータを作成します。 |
stanza-delete | スタンザのすべてのバックアップとアーカイブを完全に削除します。 |
stanza-upgrade | PostgreSQL メジャー バージョンのアップグレード後にスタンザ メタデータをアップグレードします。 |
start | 前回の stop の後に pgBackRest プロセスが実行できるようにします。 |
stop | 新しい pgBackRest プロセスを防止し、オプションで実行中のプロセスを強制停止します。 |
verify | リポジトリ内のバックアップおよびアーカイブ データが有効であることを確認します。 |
version | インストールされている pgBackRest のバージョンを表示します。 |