コマンドリファレンス
はじめに
コマンドは、pgBackRestのさまざまな機能を実行するために使用します。ここでは、各コマンドのオプションを網羅しています。複数のコマンドに適用されるオプションも、該当する各コマンドのページに記載しています。pgbackrest.confで設定できるオプションもすべて含まれます。
pgbackrest.confに設定した非ブール型のオプションは、コマンドラインでreset-接頭辞を使用するとデフォルト値に戻せます。この機能を使うと、リポジトリホスト上で直接バックアップをリストアできます。通常、pgBackRestはデータベースホストがリモートにあることを認識し、リモートでのリストアはできないためエラーになります。コマンドラインに--reset-pg1-hostを追加すると、リモートのデータベースホストを無視してローカルにリストアします。データベースホストで使用していたパスではなく、特定のパスにリストアするには、--pg1-pathに新しい値を指定する必要がある場合があります。
コマンドラインでno-接頭辞を使用すると、ブール型のオプションを偽に設定できます。
すべてのオプションは、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
|
stanzaのバックアップ・アーカイブ設定と、WALアーカイブの正常性を検証します。 |
expire
|
設定した保持ポリシーに基づき、バックアップとアーカイブ済みWALを期限切れとして削除します。 |
help
|
全般、コマンド、オプションの各レベルでヘルプを表示します。 |
info
|
stanzaとバックアップの状態・メタデータをテキストまたはJSON形式で表示します。 |
repo-get
|
管理、調査、テストのため、catと同様にリポジトリ内のファイルを読み取ります。 |
repo-ls
|
管理、調査、テストのため、lsと同様にリポジトリ内のファイル・パスを一覧表示します。 |
restore
|
バックアップからリストアします。デフォルトでは最新のバックアップを使用し、ポイントインタイムリカバリーも指定できます。 |
server
|
SSHを使わずにリモートホストにアクセスするため、pgBackRestのTLSサーバーを実行します。 |
server-ping
|
pgBackRestのTLSサーバーにpingを送信し、接続を受け付けていることを確認します。 |
stanza-create
|
設定したすべてのリポジトリにstanzaのメタデータを作成します。 |
stanza-delete
|
stanzaのすべてのバックアップとアーカイブを完全に削除します。 |
stanza-upgrade
|
PostgreSQLのメジャーバージョンアップグレード後にstanzaのメタデータを更新します。 |
start
|
stopによって停止したpgBackRestプロセスの実行を再び許可します。 |
stop
|
新しいpgBackRestプロセスの実行を禁止し、指定に応じて実行中のプロセスを強制停止します。 |
verify
|
リポジトリ内のバックアップとアーカイブデータが有効であることを検証します。 |
version
|
インストールされているpgBackRestのバージョンを表示します。 |
pgBackRestのannotateコマンドのオプションと動作のリファレンス。
pgBackRestのarchive-getコマンドのオプションと動作のリファレンス。
pgBackRestのarchive-pushコマンドのオプションと動作のリファレンス。
pgBackRestのbackupコマンドのオプションと動作のリファレンス。
pgBackRestのcheckコマンドのオプションと動作のリファレンス。
pgBackRestのexpireコマンドのオプションと動作のリファレンス。
pgBackRestのhelpコマンドのオプションおよび動作に関するリファレンス。
pgBackRestのinfoコマンドのオプションと動作のリファレンス。
pgBackRestのrepo-getコマンドのオプションと動作のリファレンス。
pgBackRestのrepo-lsコマンドのオプションと動作のリファレンス。
pgBackRestのrestoreコマンドのオプションと動作のリファレンス。
pgBackRestのserverコマンドのオプションと動作のリファレンス。
pgBackRestのserver-pingコマンドのオプションと動作のリファレンス。
pgBackRestのstanza-createコマンドのオプションと動作のリファレンス。
pgBackRestのstanza-deleteコマンドのオプションと動作のリファレンス。
pgBackRestのstanza-upgradeコマンドのオプションと動作のリファレンス。
pgBackRestのstartコマンドのオプションと動作のリファレンス。
pgBackRestのstopコマンドのオプションと動作のリファレンス。
pgBackRestのverifyコマンドのオプションと動作のリファレンス。
pgBackRestのversionコマンドのオプションおよび動作に関するリファレンス。