br コマンドラインマニュアル

このドキュメントでは、 brコマンドの定義、コンポーネント、共通オプション、およびbrコマンドを使用してスナップショットのバックアップと復元、ログのバックアップとポイントインタイムリカバリ (PITR) を実行する方法について説明します。

`br`コマンドラインの説明

brコマンドは、サブコマンド、オプション、パラメータで構成されます。サブコマンドとは、 -または--含まない文字です。オプションとは、 -または--で始まる文字です。パラメータとは、サブコマンドまたはオプションの直後に続く文字で、サブコマンドまたはオプションに渡されます。

以下は完全なbrコマンドです。

tiup br backup full --pd "${PD_IP}:2379" \
--storage "s3://backup-data/snapshot-202209081330/"

上記のコマンドの説明は次のとおりです。

backup : tiup brのサブコマンド。
full : tiup br backupのサブコマンド。
-s (または--storage ): バックアップファイルが保存されるパスを指定するオプション。4 は"s3://backup-data/snapshot-202209081330/" -sパラメーターです。
--pd : PD サービスアドレスを指定するオプション"${PD_IP}:2379"は--pdのパラメーターです。

コマンドとサブコマンド

tiup brコマンドは複数のサブコマンドの階層で構成されています。現在、br コマンドラインツールには以下のサブコマンドがあります。

tiup br backup : TiDB クラスターのデータをバックアップするために使用されます。
tiup br log : ログバックアップタスクの開始と管理に使用されます。
tiup br restore : TiDB クラスターのバックアップデータを復元するために使用されます。
tiup br debug : バックアップメタデータの解析、バックアップデータのチェックなどに使用されます。

tiup br backupおよびtiup br restoreは次のサブコマンドが含まれます。

full : すべてのクラスターデータをバックアップまたは復元するために使用されます。
db : クラスターの指定されたデータベースをバックアップまたは復元するために使用されます。
table : クラスターの指定されたデータベース内の単一のテーブルをバックアップまたは復元するために使用されます。

tiup br debugには次のサブコマンドが含まれます。

checksum : (隠しパラメーター) バックアップデータの整合性をオフラインでチェックし、すべてのバックアップファイルがADMIN CHECKSUM TABLEで計算された CRC64 チェックサム結果と一致することを確認するために使用されます。
backupmeta : バックアップデータファイル間に交差が存在するかどうかを確認するために使用されます。通常、バックアップデータファイルは交差しません。
decode : 完全バックアップのメタデータファイルbackupmeta JSON形式に解析するために使用されます。さらに、 --fieldパラメータを使用して特定のフィールドを解析することもできます。
encode : 完全バックアップのbackupmeta.jsonメタデータファイルを、データの復元中に使用される protobuf 形式にエンコードするために使用されます。
reset-pd-config-as-default : (非推奨) データ回復プロセス中に変更された PD 構成をデフォルト構成に復元するために使用されます。
search-log-backup : ログバックアップデータ内の特定のキー情報を検索するために使用されます。

一般的なオプション

--pd : PDサービスアドレスを指定します。例： "${PD_IP}:2379" 。
-s （または--storage ）: バックアップファイルを保存するパスを指定します。バックアップデータの保存には、Amazon S3、Google Cloud Storage（GCS）、Azure Blob Storage、NFSがサポートされています。詳細については、外部ストレージサービスのURI形式を参照してください。
--ca : PEM 形式の信頼された CA 証明書へのパスを指定します。
--cert : PEM 形式の SSL 証明書へのパスを指定します。
--key : PEM 形式の SSL 証明書キーへのパスを指定します。
--status-addr : br Prometheus に統計を提供するリスニングアドレスを指定します。
--concurrency : バックアップタスクを複数のリクエストに分割し、同じ TiKV ノードに同時に送信する方法を制御します。このパラメータは主にBRから TiKV へのリクエスト分割の粒度に影響し、全体的なバックアップスループットを直接決定するものではありません。ほとんどの場合、この値を変更する必要はありません。バックアップパフォーマンスを向上させるには、代わりにtikv.backup.num-threads調整する必要があります。
--pitr-concurrency : ログ復元中の同時タスクの数。
--tikv-max-restore-concurrency : スナップショット復元中の TiKV ノードあたりの同時タスクの最大数。
--compression : バックアップファイルの生成に使用する圧縮アルゴリズムを決定します。2、4、6 lz4サポートし、デフォルトはzstdです（通常は変更する必要zstdありません）。異なる圧縮アルゴリズムの選択に関するガイダンスについては、この文書をsnappyしてください。
--compression-level : バックアップに選択した圧縮アルゴリズムに対応する圧縮レベルを設定します。2 zstdのデフォルトの圧縮レベルは 3 です。ほとんどの場合、このオプションを設定する必要はありません。

フルバックアップのコマンド

クラスターデータをバックアップするには、 tiup br backupコマンドを実行します。3 またはfull tableコマンドを追加して、バックアップ操作の範囲（クラスター全体（ full ）または単一のテーブル（ table ））を指定できます。

ログバックアップのコマンド

ログバックアップを開始し、ログバックアップタスクを管理するには、 tiup br logコマンドを実行します。

バックアップデータの復元コマンド

クラスターデータを復元するには、コマンドtiup br restoreを実行します。サブコマンドfull 、 db 、またはtableを追加して、復元範囲を指定できます。復元範囲は、クラスター全体 ( full )、単一のデータベース ( db )、または単一のテーブル ( table ) です。