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 ): バックアップファイルが保存されるパスを指定するオプション"s3://backup-data/snapshot-202209081330/"は-sのパラメーターです。
--pd : PD サービスアドレス--pd "${PD_IP}:2379"パラメーターです。

コマンドとサブコマンド

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 : バックアップ中の同時タスクの数。
--pitr-concurrency : ログ復元中の同時タスクの数。
--tikv-max-restore-concurrency : スナップショット復元中の TiKV ノードあたりの同時タスクの最大数。
--compression : バックアップファイルの生成に使用する圧縮アルゴリズムを決定します。 lz4 、 snappy 、 zstdをサポートし、デフォルトはzstdです (通常は変更する必要はありません)。さまざまな圧縮アルゴリズムの選択に関するガイダンスについては、この文書を参照してください。
--compression-level : バックアップ用に選択された圧縮アルゴリズムに対応する圧縮レベルを設定します。 zstdのデフォルトの圧縮レベルは 3 です。ほとんどの場合、このオプションを設定する必要はありません。

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

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

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

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

バックアップデータを復元するコマンド

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