重要

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

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 を例として使用しています。詳細については、バックアップストレージの URL 形式を参照してください。

使用例:

./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 データが削除されるのを防ぐために、バックアッププログラムは現在のバックアップチェックポイントをサービスセーフポイントとして自動的に設定し、MVCC データを最新の 24 時間以内に保持します。バックアップタスクが 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 をサポートしています。詳細については、バックアップストレージの URL 形式を参照してください。

使用例:

./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 をサポートしています。詳細については、バックアップストレージの URL 形式を参照してください。

使用例:

./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 をサポートしています。詳細については、バックアップストレージの URL 形式を参照してください。
--restored-ts : データを復元するタイムスタンプ。このパラメーターが指定されていない場合、 BR はログバックアップで使用可能な最新のタイムスタンプ、つまりバックアップデータのチェックポイントにデータを復元します。
--start-ts : ログバックアップデータを復元する開始タイムスタンプ。ログバックアップデータのみを復元する必要がある場合は、このパラメーターを指定する必要があります。
--pd : 復元クラスターの PD アドレス。
--ca 、 --cert 、 --key : TiKV および PD と通信するための mTLS 暗号化方式を指定します。
--storage : ログバックアップのstorageアドレス。現在、 BR はログバックアップ用のstorageとして Amazon S3、GCS、または Azure Blob Storage をサポートしています。詳細については、バックアップストレージの URL 形式を参照してください。

使用例:

./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]

ノート：
一定期間のログバックアップデータを繰り返し復元することはできません。範囲[t1=10, t2=20)のログバックアップデータを繰り返し復元すると、復元されたデータが不整合になる可能性があります。
複数のバッチで異なる期間のログデータを復元する場合は、ログデータが連続した順序で復元されるようにしてください。 [t1, t2) 、 [t2, t3) 、および[t3, t4)のログバックアップデータを連続して復元すると、復元されたデータは一貫しています。ただし、 [t1, t2)復元してから[t2, t3)スキップして[t3, t4)を復元すると、復元されたデータが不整合になる可能性があります。

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

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

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

バックアップ ステータスのクエリ

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

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

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

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

バックアップ データのクリーンアップ

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

指定した時点 (PITR) に復元する

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

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

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

バックアップステータスのクエリ

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

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

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

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

バックアップデータのクリーンアップ

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