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 がサポートされています。詳細については外部ストレージサービスの URI 形式を参照してください。
--ca : 信頼できる CA 証明書へのパスを PEM 形式で指定します。
--cert : PEM 形式の SSL 証明書へのパスを指定します。
--key : SSL 証明書キーへのパスを PEM 形式で指定します。
--status-addr : br Prometheus に統計を提供する際に使用するリスニングアドレスを指定します。
--concurrency : バックアップまたは復元中の同時タスクの数。
--compression ：バックアップファイルの生成に使用される圧縮アルゴリズムを決定します。 lz4 、 snappy 、およびzstdをサポートしており、デフォルトはzstdです (通常は変更する必要はありません)。さまざまな圧縮アルゴリズムの選択に関するガイダンスについては、このドキュメントを参照してください。
--compression-level ：バックアップ用に選択した圧縮アルゴリズムに対応する圧縮レベルを設定します。 zstdのデフォルトの圧縮レベルは 3 です。ほとんどの場合、このオプションを設定する必要はありません。

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

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

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

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

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

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