TiDB スナップショットのバックアップと復元コマンドマニュアル

このドキュメントでは、次のようなアプリケーションシナリオに従って、TiDB スナップショットのバックアップと復元のコマンドについて説明します。

クラスターのスナップショットをバックアップする
データベースのバックアップ
テーブルをバックアップする
テーブルフィルターを使用して複数のテーブルをバックアップする
バックアップデータを暗号化する
クラスターのスナップショットを復元する
データベースを復元する
テーブルを復元する
テーブルフィルターを使用して複数のテーブルを復元する
暗号化されたスナップショットを復元する

スナップショットのバックアップと復元の詳細については、次を参照してください。

クラスターのスナップショットをバックアップする

br backup fullコマンドを使用して、TiDB クラスターの最新または指定されたスナップショットをバックアップできます。コマンドの詳細については、 br backup full --helpコマンドを実行してください。

br backup full \
    --pd "${PD_IP}:2379" \
    --backupts '2022-09-08 13:30:00' \
    --storage "s3://${backup_collection_addr}/snapshot-${date}?access-key=${access-key}&secret-access-key=${secret-access-key}" \
    --ratelimit 128 \
    --log-file backupfull.log

前述のコマンドでは:

--backupts : スナップショットの時点。形式はTSOまたはタイムスタンプ ( 400036290571534337や2018-05-11 01:42:23など) にすることができます。このスナップショットのデータがガベージコレクションされている場合、 br backupコマンドはエラーを返し、'br' は終了します。このパラメーターを指定しない場合、 brバックアップの開始時刻に対応するスナップショットを選択します。
--ratelimit : バックアップタスクを実行するTiKV ごとの最大速度。単位は MiB/s です。
--log-file : brログが書き込まれる対象ファイル。

ノート：
BRツールは、GC への自己適応を既にサポートしています。 backupTS (デフォルトでは最新の PD タイムスタンプ) を PD のsafePointに自動的に登録して、バックアップ中に TiDB の GC セーフポイントが前に移動しないようにするため、手動で GC 構成を設定する必要がなくなります。

バックアップ中は、以下に示すように、進行状況バーがターミナルに表示されます。プログレスバーが 100% まで進むと、バックアップは完了です。

Full Backup <---------/................................................> 17.12%.

データベースまたはテーブルのバックアップ

バックアップと復元 (BR) は、クラスタースナップショットまたは増分データバックアップから、指定されたデータベースまたはテーブルの部分的なデータのバックアップをサポートします。この機能を使用すると、スナップショットバックアップと増分データバックアップから不要なデータを除外し、ビジネスクリティカルなデータのみをバックアップできます。

データベースのバックアップ

クラスター内のデータベースをバックアップするには、 br backup dbコマンドを実行します。

次の例では、 testデータベースを Amazon S3 にバックアップします。

br backup db \
    --pd "${PD_IP}:2379" \
    --db test \
    --storage "s3://${backup_collection_addr}/snapshot-${date}?access-key=${access-key}&secret-access-key=${secret-access-key}" \
    --ratelimit 128 \
    --log-file backuptable.log

上記のコマンドで、 --dbデータベース名を指定し、他のパラメーターはTiDB クラスターのスナップショットをバックアップすると同じです。

テーブルをバックアップする

クラスター内のテーブルをバックアップするには、 br backup tableコマンドを実行します。

次の例では、 test.usertableテーブルを Amazon S3 にバックアップします。

br backup table \
    --pd "${PD_IP}:2379" \
    --db test \
    --table usertable \
    --storage "s3://${backup_collection_addr}/snapshot-${date}?access-key=${access-key}&secret-access-key=${secret-access-key}" \
    --ratelimit 128 \
    --log-file backuptable.log

上記のコマンドで、 --dbと--tableそれぞれデータベース名とテーブル名を指定し、その他のパラメーターはTiDB クラスターのスナップショットをバックアップすると同じです。

テーブルフィルターを使用して複数のテーブルをバックアップする

複数の基準で複数のテーブルをバックアップするには、 br backup fullコマンドを実行し、 --filterまたは-fでテーブルフィルターを指定します。

次の例では、 db*.tbl*フィルタールールに一致するテーブルを Amazon S3 にバックアップします。

br backup full \
    --pd "${PD_IP}:2379" \
    --filter 'db*.tbl*' \
    --storage "s3://${backup_collection_addr}/snapshot-${date}?access-key=${access-key}&secret-access-key=${secret-access-key}" \
    --ratelimit 128 \
    --log-file backupfull.log

バックアップデータを暗号化する

警告

これは実験的機能です。本番環境で使用することはお勧めしません。

BR は、バックアップAmazon S3にバックアップする際のstorage側でのバックアップデータの暗号化をサポートしています。必要に応じて、いずれかの暗号化方式を選択できます。

TiDB v5.3.0 以降、次のパラメータを設定することでバックアップデータを暗号化できます。

--crypter.method : 暗号化アルゴリズム。 aes128-ctr 、 aes192-ctr 、またはaes256-ctrのいずれかです。デフォルト値はplaintextで、データが暗号化されていないことを示します。
--crypter.key : 16 進文字列形式の暗号化キー。アルゴリズムaes128-ctrでは 128 ビット (16 バイト) の鍵、アルゴリズムaes192-ctrでは 24 バイトの鍵、アルゴリズムaes256-ctrでは 32 バイトの鍵です。
--crypter.key-file : 鍵ファイル。 crypter.key .

次に例を示します。

br backup full\
    --pd ${PD_IP}:2379 \
    --storage "s3://${backup_collection_addr}/snapshot-${date}?access-key=${access-key}&secret-access-key=${secret-access-key}" \
    --crypter.method aes128-ctr \
    --crypter.key 0123456789abcdef0123456789abcdef

ノート：
キーを紛失すると、バックアップデータをクラスタに復元できなくなります。
暗号化機能は、 brおよび TiDB クラスター v5.3.0 以降のバージョンで使用する必要があります。暗号化されたバックアップデータは、v5.3.0 より前のクラスターでは復元できません。

クラスターのスナップショットを復元する

br restore fullコマンドを実行して、TiDB クラスターのスナップショットを復元できます。

br restore full \
    --pd "${PD_IP}:2379" \
    --storage "s3://${backup_collection_addr}/snapshot-${date}?access-key=${access-key}&secret-access-key=${secret-access-key}" \
    --ratelimit 128 \
    --log-file restorefull.log

前述のコマンドでは:

--ratelimit : バックアップタスクを実行するTiKV ごとの最大速度。単位は MiB/s です。
--log-file : brログが書き込まれるターゲットファイル。

復元中は、以下に示すように進行状況バーがターミナルに表示されます。プログレスバーが 100% まで進むと、復元タスクは完了です。 br 、復元されたデータを検証して、データのセキュリティを確保します。

Full Restore <---------/...............................................> 17.12%.

データベースまたはテーブルを復元する

brを使用して、指定したデータベースまたはテーブルの部分データをバックアップデータから復元できます。この機能により、復元中に不要なデータを除外できます。

データベースを復元する

データベースをクラスターに復元するには、 br restore dbコマンドを実行します。

次の例では、 testデータベースをバックアップデータからターゲットクラスターに復元します。

br restore db \
    --pd "${PD_IP}:2379" \
    --db "test" \
    --ratelimit 128 \
    --storage "s3://${backup_collection_addr}/snapshot-${date}?access-key=${access-key}&secret-access-key=${secret-access-key}" \
    --log-file restore_db.log

上記のコマンドで、 --db復元するデータベースの名前を指定し、その他のパラメーターはTiDB クラスターのスナップショットを復元すると同じです。

ノート：
バックアップデータを復元する場合、 --dbで指定したデータベース名は、バックアップコマンドの-- dbで指定したデータベース名と同じでなければなりません。そうしないと、復元は失敗します。これは、バックアップデータのメタファイル ( backupmetaファイル) にデータベース名が記録されており、同じ名前のデータベースにしかデータを復元できないためです。推奨される方法は、バックアップデータを別のクラスター内の同じ名前のデータベースに復元することです。

テーブルを復元する

1 つのテーブルをクラスターに復元するには、 br restore tableコマンドを実行します。

次の例では、 test.usertableテーブルを Amazon S3 からターゲットクラスターに復元します。

br restore table \
    --pd "${PD_IP}:2379" \
    --db "test" \
    --table "usertable" \
    --ratelimit 128 \
    --storage "s3://${backup_collection_addr}/snapshot-${date}?access-key=${access-key}&secret-access-key=${secret-access-key}" \
    --log-file restore_table.log

上記のコマンドで、 --table復元するテーブルの名前を指定し、その他のパラメーターはデータベースを復元すると同じです。

テーブルフィルターを使用して複数のテーブルを復元する

より複雑なフィルタルールを使用して複数のテーブルを復元するには、 br restore fullコマンドを実行し、 --filterまたは-fでテーブルフィルター指定します。

次の例では、 db*.tbl*フィルタールールに一致するテーブルを Amazon S3 からターゲットクラスターに復元します。

br restore full \
    --pd "${PD_IP}:2379" \
    --filter 'db*.tbl*' \
    --storage "s3://${backup_collection_addr}/snapshot-${date}?access-key=${access-key}&secret-access-key=${secret-access-key}" \
    --log-file restorefull.log

暗号化されたスナップショットを復元する

警告