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
: バックアップまたは復元中の同時タスクの数。--compression
: バックアップ ファイルの生成に使用する圧縮アルゴリズムを決定します。lz4
、snappy
、zstd
をサポートし、デフォルトはzstd
です (通常は変更する必要はありません)。さまざまな圧縮アルゴリズムの選択に関するガイダンスについては、 この文書を参照してください。--compression-level
: バックアップ用に選択された圧縮アルゴリズムに対応する圧縮レベルを設定します。zstd
のデフォルトの圧縮レベルは 3 です。ほとんどの場合、このオプションを設定する必要はありません。
フルバックアップのコマンド
クラスターデータをバックアップするには、 tiup br backup
コマンドを実行します。3 またはfull
サブコマンドを追加して、バックアップ操作の範囲(クラスター全体table
full
) または単一のテーブル ( table
))を指定できます。
- TiDB クラスターのスナップショットをバックアップする
- データベースをバックアップする
- テーブルをバックアップする
- テーブルフィルターを使用して複数のテーブルをバックアップする
- スナップショットを暗号化する
ログバックアップのコマンド
ログ バックアップを開始し、ログ バックアップ タスクを管理するには、 tiup br log
コマンドを実行します。
- ログバックアップタスクを開始する
- バックアップステータスを照会する
- ログバックアップタスクを一時停止して再開する
- ログバックアップタスクを停止して再開する
- バックアップデータをクリーンアップする
- バックアップメタデータをビュー
バックアップデータを復元するコマンド
クラスターデータを復元するには、 tiup br restore
コマンドを実行します。 full
、 db
、またはtable
サブコマンドを追加して、復元の範囲(クラスター全体 ( full
)、単一のデータベース ( db
)、または単一のテーブル ( table
))を指定できます。