重要

このページは英語版のページを機械翻訳しています。原文はこちらからご覧ください。

TiDB ログバックアップと PITR コマンドマニュアル

このドキュメントでは、TiDB ログバックアップおよびポイントインタイムリカバリ (PITR) で使用されるコマンドについて説明します。

ログバックアップと PITR の詳細については、以下を参照してください。

ログのバックアップを実行する

br logコマンドを使用してログバックアップを開始および管理できます。

./br log --help

backup stream log from TiDB/TiKV cluster

Usage:
  br log [command]

Available Commands:
  metadata   get the metadata of log dir
  pause      pause a log backup task
  resume     resume a log backup task
  start      start a log backup task
  status     get status for the log backup task
  stop       stop a log backup task
  truncate   truncate the log data until sometime

各サブコマンドは次のように説明されます。

br log start : ログバックアップタスクを開始します。
br log status : ログバックアップタスクのステータスをクエリします。
br log pause : ログバックアップタスクを一時停止します。
br log resume : 一時停止したログバックアップタスクを再開します。
br log stop : ログバックアップタスクを停止し、タスクのメタデータを削除します。
br log truncate : バックアップstorageからログバックアップデータをクリーンアップします。
br log metadata : ログバックアップデータのメタデータをクエリします。

バックアップタスクを開始する

br log startコマンドを実行してログバックアップタスクを開始できます。このタスクは TiDB クラスターのバックグラウンドで実行され、KVstorageの変更ログをバックアップstorageに自動的にバックアップします。

br log start --helpを実行してヘルプ情報を表示します。

./br log start --help
start a log backup task

Usage:
  br log start [flags]

Flags:
  -h, --help               help for start
  --start-ts string        usually equals last full backupTS, used for backup log. Default value is current ts. support TSO or datetime, e.g. '400036290571534337' or '2018-05-11 01:42:23+0800'.
  --task-name string       The task name for the backup log task.

Global Flags:
 --ca string                  CA certificate path for TLS connection
 --cert string                Certificate path for TLS connection
 --key string                 Private key path for TLS connection
 -u, --pd strings             PD address (default [127.0.0.1:2379])
 -s, --storage string         specify the url where backup storage, eg, "s3://bucket/path/prefix"

出力例には、共通パラメータのみが示されています。これらのパラメータは次のように説明されます。

--start-ts : ログバックアップの開始タイムスタンプを指定します。このパラメータが指定されていない場合、バックアッププログラムは現在時刻をstart-tsとして使用します。
task-name : ログバックアップのタスク名を指定します。この名前は、バックアップタスクのクエリ、一時停止、再開にも使用されます。
--ca 、 --cert 、 --key : TiKV および PD と通信するための mTLS 暗号化方式を指定します。
--pd : バックアップクラスターの PD アドレスを指定します。ログバックアップタスクを開始するには、 BR がPD にアクセスする必要があります。
--storage : バックアップstorageアドレスを指定します。現在、 BR はログバックアップ用のstorageとして Amazon S3、Google Cloud Storage (GCS)、または Azure Blob Storage をサポートしています。前述のコマンドでは、例として Amazon S3 を使用しています。詳細は外部ストレージサービスの URI 形式を参照してください。

使用例：

./br log start --task-name=pitr --pd="${PD_IP}:2379" \
--storage='s3://backup-101/logbackup?access-key=${access-key}&secret-access-key=${secret-access-key}"'

バックアップステータスを問い合わせる

br log statusコマンドを実行してバックアップステータスをクエリできます。

br log status --helpを実行してヘルプ情報を表示します。

./br log status --help
get status for the log backup task

Usage:
  br log status [flags]

Flags:
  -h, --help           help for status
  --json               Print JSON as the output.
  --task-name string   The task name for backup stream log. If default, get status of all of tasks (default "*")

Global Flags:
 --ca string                  CA certificate path for TLS connection
 --cert string                Certificate path for TLS connection
 --key string                 Private key path for TLS connection
 -u, --pd strings             PD address (default [127.0.0.1:2379])

出力例では、バックアップタスクの名前を指定するためにtask-nameが使用されています。デフォルト値は*で、すべてのタスクのステータスをクエリすることを意味します。

使用例：

./br log status --task-name=pitr --pd="${PD_IP}:2379"

期待される出力:

● Total 1 Tasks.
> #1 <
              name: pitr
            status: ● NORMAL
             start: 2022-07-14 20:08:03.268 +0800
               end: 2090-11-18 22:07:45.624 +0800
           storage: s3://backup-101/logbackup
       speed(est.): 0.82 ops/s
checkpoint[global]: 2022-07-25 22:52:15.518 +0800; gap=2m52s

出力フィールドは次のように説明されます。

status : バックアップタスクのステータス。 NORMAL 、 ERROR 、またはPAUSEのいずれかです。
start : バックアップタスクの開始時刻。これは、バックアップタスクの開始時に指定されたstart-ts値です。
storage : バックアップstorageアドレス。
speed : バックアップタスクの合計 QPS。 QPS は、1 秒あたりにバックアップされるログの数を意味します。
checkpoint [global] : このチェックポイントより前のすべてのデータがバックアップstorageにバックアップされます。これは、バックアップデータの復元に使用できる最新のタイムスタンプです。
error [store] : ログバックアッププログラムがstorageノードで発生したエラー。

バックアップタスクの一時停止と再開

br log pauseコマンドを実行すると、実行中のバックアップタスクを一時停止できます。

br log pause --helpを実行してヘルプ情報を表示します。

./br log pause --help
pause a log backup task

Usage:
  br log pause [flags]

Flags:
  --gc-ttl int         the TTL (in seconds) that PD holds for BR's GC safepoint (default 86400)
  -h, --help           help for status
  --task-name string   The task name for backup stream log.

Global Flags:
 --ca string                  CA certificate path for TLS connection
 --cert string                Certificate path for TLS connection
 --key string                 Private key path for TLS connection
 -u, --pd strings             PD address (default [127.0.0.1:2379])

注記：
ログバックアップタスクが一時停止された後、変更ログを生成する MVCC データが削除されないように、バックアッププログラムは現在のバックアップチェックポイントをサービスセーフポイントとして自動的に設定します。これには、最新 24 時間以内の MVCC データが保持されます。バックアップタスクが 24 時間以上一時停止された場合、対応するデータはガベージコレクションされ、バックアップされません。
MVCC データを保持しすぎると、TiDB クラスターのstorage容量とパフォーマンスに悪影響が生じます。したがって、時間内にバックアップタスクを再開することをお勧めします。

使用例：

./br log pause --task-name=pitr --pd="${PD_IP}:2379"

br log resumeコマンドを実行すると、一時停止したバックアップタスクを再開できます。

br log resume --helpを実行してヘルプ情報を表示します。

./br log resume --help
resume a log backup task

Usage:
  br log resume [flags]

Flags:
  -h, --help           help for status
  --task-name string   The task name for backup stream log.

Global Flags:
 --ca string                  CA certificate path for TLS connection
 --cert string                Certificate path for TLS connection
 --key string                 Private key path for TLS connection
 -u, --pd strings             PD address (default [127.0.0.1:2379])

バックアップタスクが 24 時間以上一時停止された後、 br log resume実行するとエラーが報告され、 BR はバックアップデータが失われたことを示すプロンプトを表示します。このエラーに対処するには、バックアップと復元に関するよくある質問を参照してください。

使用例：

./br log resume --task-name=pitr --pd="${PD_IP}:2379"

バックアップタスクを停止して再開する

br log stopコマンドを実行してログバックアップタスクを停止し、元の--storageディレクトリを使用して停止したバックアップタスクを再開できます。

バックアップタスクを停止する

br log stopコマンドを実行すると、ログバックアップタスクを停止できます。このコマンドは、バックアップクラスター内のタスクメタデータをクリーンアップします。

br log stop --helpを実行してヘルプ情報を表示します。

./br log stop --help
stop a log backup task

Usage:
  br log stop [flags]

Flags:
  -h, --help           help for status
  --task-name string   The task name for the backup log task.

Global Flags:
 --ca string                  CA certificate path for TLS connection
 --cert string                Certificate path for TLS connection
 --key string                 Private key path for TLS connection
 -u, --pd strings             PD address (default [127.0.0.1:2379])

注記：
このコマンドは注意して使用してください。ログバックアップタスクを一時停止する必要がある場合は、代わりにbr log pauseとbr log resumeを使用してください。

使用例：

./br log stop --task-name=pitr --pd="${PD_IP}:2379"

バックアップタスクを再開する

br log stopコマンドを実行してログバックアップタスクを停止した後、別の--storageディレクトリに新しいログバックアップタスクを作成するか、 br log startコマンドを実行して元の--storageディレクトリでログバックアップタスクを再開できます。元の--storageディレクトリでタスクを再開する場合は、次の点に注意してください。

タスクを再開するための--storageディレクトリのパラメータは、停止したタスクと同じである必要があります。
--start-ts指定する必要はありません。 BR は、最後のバックアップチェックポイントからバックアップを自動的に開始します。
タスクが長期間停止され、複数のバージョンのデータがガベージコレクションされた場合、タスクを再開しようとするとエラーBR:Backup:ErrBackupGCSafepointExceededが報告されます。この場合、別--storageディレクトリに新しいログバックアップタスクを作成する必要があります。

バックアップデータをクリーンアップする

br log truncateコマンドを実行して、古いログバックアップデータまたは不要になったログバックアップデータをクリーンアップできます。

br log truncate --helpを実行してヘルプ情報を表示します。

./br log truncate --help
truncate the incremental log until sometime.

Usage:
  br log truncate [flags]

Flags:
  --dry-run        Run the command but don't really delete the files.
  -h, --help       help for truncate
  --until string   Remove all backup data until this TS.(support TSO or datetime, e.g. '400036290571534337' or '2018-05-11 01:42:23+0800'.)
  -y, --yes        Skip all prompts and always execute the command.


Global Flags:
  -s, --storage string         specify the url where backup storage, eg, "s3://bucket/path/prefix"

このコマンドはバックアップstorageにのみアクセスし、TiDB クラスターにはアクセスしません。一部のパラメータは次のように説明されます。

--dry-run : コマンドを実行しますが、実際にはファイルを削除しません。
--until : 指定されたタイムスタンプより前のすべてのログバックアップデータを削除します。
--storage : バックアップstorageアドレス。現在、 BR はログバックアップ用のstorageとして Amazon S3、GCS、または Azure Blob Storage をサポートしています。詳細は外部ストレージサービスの URI 形式を参照してください。

使用例：

./br log truncate --until='2022-07-26 21:20:00+0800' \
–-storage='s3://backup-101/logbackup?access-key=${access-key}&secret-access-key=${secret-access-key}"'

期待される出力:

Reading Metadata... DONE; take = 277.911599ms
We are going to remove 9 files, until 2022-07-26 21:20:00.0000.
Sure? (y/N) y
Clearing data files... DONE; take = 43.504161ms, kv-count = 53, kv-size = 4573(4.573kB)
Removing metadata... DONE; take = 24.038962ms

バックアップのメタデータをビュー

br log metadataコマンドを実行すると、復元可能な最も古いタイムスタンプと最新のタイムスタンプなど、storageシステム内のバックアップメタデータを表示できます。

br log metadata --helpを実行してヘルプ情報を表示します。

./br log metadata --help
get the metadata of log backup storage

Usage:
  br log metadata [flags]

Flags:
  -h, --help       help for metadata

Global Flags:
  -s, --storage string         specify the url where backup storage, eg, "s3://bucket/path/prefix"

このコマンドはバックアップstorageにのみアクセスし、TiDB クラスターにはアクセスしません。

--storageパラメータは、バックアップstorageアドレスを指定するために使用されます。現在、 BR はログバックアップ用のstorageとして Amazon S3、GCS、または Azure Blob Storage をサポートしています。詳細は外部ストレージサービスの URI 形式を参照してください。

使用例：

./br log metadata –-storage='s3://backup-101/logbackup?access-key=${access-key}&secret-access-key=${secret-access-key}"'

期待される出力:

[2022/07/25 23:02:57.236 +08:00] [INFO] [collector.go:69] ["log metadata"] [log-min-ts=434582449885806593] [log-min-date="2022-07-14 20:08:03.268 +0800"] [log-max-ts=434834300106964993] [log-max-date="2022-07-25 23:00:15.618 +0800"]

指定した時点への復元 (PITR)

br restore pointコマンドを実行して、新しいクラスターで PITR を実行するか、ログバックアップデータを復元するだけです。

br restore point --helpを実行してヘルプ情報を表示します。

./br restore point --help
restore data from log until specify commit timestamp

Usage:
  br restore point [flags]

Flags:
  --full-backup-storage string specify the backup full storage. fill it if want restore full backup before restore log.
  -h, --help                   help for point
  --restored-ts string         the point of restore, used for log restore. support TSO or datetime, e.g. '400036290571534337' or '2018-05-11 01:42:23+0800'
  --start-ts string            the start timestamp which log restore from. support TSO or datetime, e.g. '400036290571534337' or '2018-05-11 01:42:23+0800'


Global Flags:
 --ca string                  CA certificate path for TLS connection
 --cert string                Certificate path for TLS connection
 --key string                 Private key path for TLS connection
 -u, --pd strings             PD address (default [127.0.0.1:2379])
 -s, --storage string         specify the url where backup storage, eg, "s3://bucket/path/prefix"

出力例には、共通パラメータのみが示されています。これらのパラメータは次のように説明されます。

--full-backup-storage : スナップショット (フル) バックアップのstorageアドレス。 PITR を使用するには、このパラメータを指定し、復元タイムスタンプより前の最新のスナップショットバックアップを選択します。ログバックアップデータのみをリストアする場合は、このパラメータを省略できます。回復クラスターを初めて初期化するときは、スナップショットバックアップを指定する必要があることに注意してください。現在、 BR はログバックアップ用のstorageとして Amazon S3、GCS、Azure Blob Storage をサポートしています。詳細は外部ストレージサービスの URI 形式を参照してください。
--restored-ts : データを復元するタイムスタンプ。このパラメータが指定されていない場合、 BR はログバックアップで使用可能な最新のタイムスタンプ、つまりバックアップデータのチェックポイントにデータを復元します。
--start-ts : ログバックアップデータを復元する開始タイムスタンプ。ログバックアップデータのみを復元する必要がある場合は、このパラメータを指定する必要があります。
--pd : 復元クラスターの PD アドレス。
--ca 、 --cert 、 --key : TiKV および PD と通信するための mTLS 暗号化方式を指定します。
--storage : ログバックアップのstorageアドレス。現在、 BR はログバックアップ用のstorageとして Amazon S3、GCS、または Azure Blob Storage をサポートしています。詳細は外部ストレージサービスの URI 形式を参照してください。

使用例：

./br restore point --pd="${PD_IP}:2379"
--storage='s3://backup-101/logbackup?access-key=${access-key}&secret-access-key=${secret-access-key}"'
--full-backup-storage='s3://backup-101/snapshot-202205120000?access-key=${access-key}&secret-access-key=${secret-access-key}"'

Full Restore <--------------------------------------------------------------------------------------------------------------------------------------------------------> 100.00%
*** ***["Full Restore success summary"] ****** [total-take=3.112928252s] [restore-data-size(after-compressed)=5.056kB] [Size=5056] [BackupTS=434693927394607136] [total-kv=4] [total-kv-size=290B] [average-speed=93.16B/s]
Restore Meta Files <--------------------------------------------------------------------------------------------------------------------------------------------------> 100.00%
Restore KV Files <----------------------------------------------------------------------------------------------------------------------------------------------------> 100.00%
"restore log success summary"] [total-take=192.955533ms] [restore-from=434693681289625602] [restore-to=434693753549881345] [total-kv-count=33] [total-size=21551]

注記：
初めてクラスターを復元するときは、完全なスナップショットデータを指定する必要があります。そうしないと、テーブル ID ルールの書き換えにより、新しく作成されたテーブルの一部のデータが正しくなくなる可能性があります。
一定期間のログバックアップデータを繰り返し復元することはできません。範囲[t1=10, t2=20)のログバックアップデータを繰り返しリストアすると、リストアされたデータに不整合が生じる可能性があります。
異なる期間のログデータを複数のバッチでリストアする場合は、ログデータが連続した順序でリストアされるようにしてください。 [t1, t2) 、 [t2, t3) 、 [t3, t4)のログバックアップデータを連続した順序でリストアすると、リストアされたデータの整合性が保たれます。ただし、 [t1, t2)復元し、その後[t2, t3)スキップして[t3, t4)を復元すると、復元されたデータに不整合が生じる可能性があります。

TiDB ログ バックアップと PITR コマンド マニュアル

ログのバックアップを実行する

バックアップタスクを開始する

バックアップステータスを問い合わせる

バックアップタスクの一時停止と再開

バックアップタスクを停止して再開する

バックアップタスクを停止する

バックアップタスクを再開する

バックアップデータをクリーンアップする

バックアップのメタデータをビュー

指定した時点への復元 (PITR)

このページは役に立ちましたか？

TiDB ログバックアップと PITR コマンドマニュアル