br コマンドラインマニュアル
このドキュメントでは、 br
コマンドの定義、コンポーネント、共通オプション、およびbr
コマンドを使用してスナップショット バックアップと復元、およびログ バックアップとポイント イン タイム リカバリ (PITR) を実行する方法について説明します。
br
コマンドラインの説明
br
コマンドは、サブコマンド、オプション、およびパラメーターで構成されます。サブコマンドは-
または--
を除いた文字です。オプションは-
または--
で始まる文字です。パラメータは、直後に続く文字で、サブコマンドまたはオプションに渡されます。
以下は完全なbr
コマンドです。
br backup full --pd "${PD_IP}:2379" \
--storage "s3://backup-data/snapshot-202209081330/"
上記のコマンドの説明は次のとおりです。
backup
:br
のサブコマンド。full
:br backup
のサブコマンド。-s
(または--storage
): バックアップ ファイルが格納されるパスを指定するオプション。"s3://backup-data/snapshot-202209081330/"
-s
のパラメータです。--pd
: PD サービス アドレスを指定するオプション。"${PD_IP}:2379"
--pd
のパラメータです。
コマンドとサブコマンド
br
コマンドは、サブコマンドの複数のレイヤーで構成されます。現在、br コマンドライン ツールには次のサブコマンドがあります。
br backup
: TiDB クラスターのデータをバックアップするために使用されます。br log
: ログ バックアップ タスクの開始と管理に使用されます。br restore
: TiDB クラスターのバックアップ データを復元するために使用されます。
br backup
とbr restore
には、次のサブコマンドが含まれます。
full
: すべてのクラスター データのバックアップまたは復元に使用されます。db
: クラスターの指定されたデータベースのバックアップまたは復元に使用されます。table
: クラスターの指定されたデータベース内の単一のテーブルをバックアップまたは復元するために使用されます。
共通オプション
--pd
: PD サービス アドレスを指定します。たとえば、"${PD_IP}:2379"
です。-s
(または--storage
): バックアップ ファイルが格納されるパスを指定します。バックアップ データの保存には、Amazon S3、Google Cloud Storage (GCS)、Azure Blob Storage、および NFS がサポートされています。詳細については、 バックアップ ストレージの URL 形式を参照してください。--ca
: 信頼できる CA 証明書へのパスを PEM 形式で指定します。--cert
: SSL 証明書へのパスを PEM 形式で指定します。--key
: SSL 証明書キーへのパスを PEM 形式で指定します。--status-addr
:br
Prometheus に統計を提供するためのリスニング アドレスを指定します。
フルバックアップのコマンド
クラスター データをバックアップするには、 br backup
コマンドを実行します。 full
またはtable
サブコマンドを追加して、バックアップ操作の範囲 (クラスター全体 ( full
) または単一のテーブル ( table
)) を指定できます。
ログバックアップのコマンド
ログ バックアップを開始し、ログ バックアップ タスクを管理するには、 br log
コマンドを実行します。
- ログ バックアップ タスクを開始する
- バックアップ ステータスのクエリ
- ログ バックアップ タスクの一時停止と再開
- ログ バックアップ タスクを停止して再開する
- バックアップ データのクリーンアップ
- バックアップ メタデータをビュー
バックアップデータを復元するコマンド
クラスター データを復元するには、 br restore
コマンドを実行します。 full
、 db
、またはtable
サブコマンドを追加して、復元の範囲 (クラスター全体 ( full
)、単一データベース ( db
)、または単一テーブル ( table
)) を指定できます。
このページは役に立ちましたか?
Playground
登録なしで TiDB の機能をワンストップでインタラクティブに体験できます。