大規模データセットの MySQL シャードを TiDB に移行およびマージする

大規模なMySQLデータセット（例えば1TiB以上）を異なるパーティションからTiDBに移行し、移行期間中は業務上のTiDBクラスタへの書き込み操作をすべて停止できる場合は、 TiDB Lightningを使用することで迅速に移行できます。移行後は、TiDB DMを使用して、業務ニーズに応じて増分レプリケーションを実行することもできます。このドキュメントにおける「大規模データセット」とは、通常、1TiB程度のデータを指します。

このドキュメントでは、例を使用して、このような種類の移行の手順全体について説明します。

MySQL シャードのデータ サイズが 1 TiB 未満の場合は、完全移行と増分移行の両方がサポートされており、手順が簡単な小さなデータセットの MySQL シャードを TiDB に移行してマージするで説明した手順に従うことができます。

このドキュメントの例では、データベースmy_db1とmy_db2 2つがあることを前提としています。Dumplingを使用して、データベースmy_db1からテーブルtable1とtable2 2つ、およびデータベースmy_db2からテーブルtable3とtable4 2つをそれぞれエクスポートします。その後、 TiDB Lightningを使用して、エクスポートした4つのテーブルを、データベースmydbからエクスポートした同じtable5にインポートし、マージします。

このドキュメントでは、次の手順に従ってデータを移行できます。

1. Dumplingを使用して完全なデータをエクスポートします。この例では、2つの上流データベースからそれぞれ2つのテーブルをエクスポートします。

   • my_db1からtable1とtable2エクスポート
   • my_db2からtable3とtable4エクスポート

2. TiDB Lightningを起動して、TiDB のmydb.table5にデータを移行します。

3. (オプション) TiDB DM を使用して増分レプリケーションを実行します。

前提条件

開始する前に、次のドキュメントを参照して移行タスクの準備をしてください。

• TiUPを使用して DMクラスタをデプロイ
• TiUPを使用してDumplingとLightningをデプロイ
• Dumplingの下流権限要件
• TiDB Lightningのダウンストリーム権限要件
• TiDB Lightningのダウンストリームstorageスペース
• DMワーカーに必要な権限

シャードテーブルの競合をチェックする

移行に異なるシャーディングされたテーブルからのデータのマージが含まれる場合、マージ中に主キーまたは一意のインデックスの競合が発生する可能性があります。そのため、移行前に、現在のシャーディングスキームをビジネスの観点から詳細に検討し、競合を回避する方法を見つける必要があります。詳細については、 複数のシャードテーブル間の主キーまたは一意のインデックス間の競合を処理する参照してください。以下に簡単に説明します。

表1～4が以下のように同じ表構造を持っていると仮定します。

CREATE TABLE `table1` (
  `id` bigint NOT NULL AUTO_INCREMENT,
  `sid` bigint NOT NULL,
  `pid` bigint NOT NULL,
  `comment` varchar(255) DEFAULT NULL,
  PRIMARY KEY (`id`),
  UNIQUE KEY `sid` (`sid`)
) ENGINE=InnoDB DEFAULT CHARSET=latin1

これら4つのテーブルでは、 id列目が主キーです。これは自動増分であるため、異なるシャードテーブルで重複したid範囲が生成され、移行中にターゲットテーブルで主キーの競合が発生します。一方、 sid列目はシャーディングキーであり、インデックスがグローバルに一意であることを保証します。そのため、ターゲットテーブルtable5のid列目の一意制約を削除することで、データマージの競合を回避できます。

CREATE TABLE `table5` (
  `id` bigint NOT NULL,
  `sid` bigint NOT NULL,
  `pid` bigint NOT NULL,
  `comment` varchar(255) DEFAULT NULL,
  INDEX (`id`),
  UNIQUE KEY `sid` (`sid`)
) ENGINE=InnoDB DEFAULT CHARSET=latin1

ステップ1. Dumplingを使用して完全なデータをエクスポートする

エクスポートする複数のシャード テーブルが同じアップストリーム MySQL インスタンス内にある場合は、 Dumplingの-fパラメータを直接使用して、1 回の操作でエクスポートできます。

シャードされたテーブルが異なる MySQL インスタンスに保存されている場合は、 Dumplingを使用してそれらをそれぞれエクスポートし、エクスポートされた結果を同じ親ディレクトリに配置できます。

次の例では、両方の方法が使用され、エクスポートされたデータは同じ親ディレクトリに保存されます。

まず、次のコマンドを実行して、 Dumplingを使用してmy_db1からtable1とtable2エクスポートします。

tiup dumpling -h ${ip} -P 3306 -u root -t 16 -r 200000 -F 256MB -B my_db1 -f 'my_db1.table[12]' -o ${data-path}/my_db1

以下の表は、上記のコマンドのパラメータについて説明しています。DumplingDumplingの詳細については、 Dumplingの概要参照してください。

${data-path}に十分な空き容量があることを確認してください。テーブルのサイズが大きすぎるためにバックアッププロセスが中断されるのを避けるため、 -Fオプションを使用することを強くお勧めします。

次に、以下のコマンドを実行して、 Dumplingを使ってmy_db2からtable3とtable4エクスポートします。パスは${data-path}/my_db1ではなく${data-path}/my_db2であることに注意してください。

tiup dumpling -h ${ip} -P 3306 -u root -t 16 -r 200000 -F 256MB -B my_db2 -f 'my_db2.table[34]' -o ${data-path}/my_db2

上記の手順により、すべてのソースデータテーブルが${data-path}ディレクトリにエクスポートされました。エクスポートしたデータをすべて同じディレクトリに置くことで、 TiDB Lightningによる後続のインポートが便利になります。

増分レプリケーションに必要な開始位置情報は、 ${data-path}ディレクトリのmy_db1とmy_db2サブディレクトリにあるmetadataのファイルにあります。これらは、 Dumplingによって自動的に生成されるメタ情報ファイルです。増分レプリケーションを実行するには、これらのファイルにbinlogの位置情報を記録する必要があります。

ステップ2. TiDB Lightningを起動して、エクスポートしたデータ全体をインポートします。

移行のためにTiDB Lightningを開始する前に、チェックポイントの処理方法を理解し、ニーズに応じて適切な方法を選択することをお勧めします。

チェックポイント

大量のデータの移行には通常、数時間、場合によっては数日かかります。長時間実行されるプロセスは、予期せず中断される可能性があります。たとえ一部のデータが既にインポートされていたとしても、すべてを最初からやり直すのは非常に面倒です。

幸いなことに、 TiDB Lightning にはcheckpointsという機能があり、これによりTiDB Lightning はインポートの進行状況をcheckpointsとして随時保存し、中断されたインポート タスクを再起動時に最新のチェックポイントから再開できるようになります。

TiDB Lightningタスクが回復不能なエラー（データ破損など）によりクラッシュした場合、チェックポイントから再開されず、エラーが報告されてタスクが終了します。インポートされたデータの安全性を確保するため、他の手順に進む前に、 tidb-lightning-ctlコマンドを使用してこれらのエラーを解決する必要があります。解決できるオプションは以下のとおりです。

• --checkpoint-error-destroy: このオプションを使用すると、まずテーブル内の既存のデータをすべて破棄して、失敗したターゲット テーブルへのデータのインポートを最初から再開できます。
• --checkpoint-error-ignore: 移行が失敗した場合、このオプションはエラーが発生しなかったかのようにエラー状態をクリアします。
• --checkpoint-remove: このオプションは、エラーに関係なく、すべてのチェックポイントをクリアします。

詳細についてはTiDB Lightningチェックポイント参照してください。

ターゲットスキーマを作成する

下流にmydb.table5作成します。

CREATE TABLE `table5` (
  `id` bigint NOT NULL,
  `sid` bigint NOT NULL,
  `pid` bigint NOT NULL,
  `comment` varchar(255) DEFAULT NULL,
  INDEX (`id`),
  UNIQUE KEY `sid` (`sid`)
) ENGINE=InnoDB DEFAULT CHARSET=latin1

移行タスクを開始する

tidb-lightning開始するには、次の手順に従います。

1. toml ファイルを編集します。次の例ではtidb-lightning.toml使用されています。

   [lightning]
   # Logs
   level = "info"
   file = "tidb-lightning.log"
   
   [mydumper]
   data-source-dir = ${data-path}
   
   [tikv-importer]
   # Choose a local backend.
   # "local": The default mode. It is used for large data volumes greater than 1 TiB. During migration, downstream TiDB cannot provide services.
   # "tidb": Used for data volumes less than 1 TiB. During migration, downstream TiDB can provide services normally.
   # For more information, see [TiDB Lightning Backends](https://docs.pingcap.com/tidb/stable/tidb-lightning-backends)
   backend = "local"
   # Set the temporary directory for the sorted key value pairs. It must be empty.
   # The free space must be greater than the size of the dataset to be imported.
   # It is recommended that you use a directory different from `data-source-dir` to get better migration performance by consuming I/O resources exclusively.
   sorted-kv-dir = "${sorted-kv-dir}"
   
   # Set the renaming rules ('routes') from source to target tables, in order to support merging different table shards into a single target table. Here you migrate `table1` and `table2` in `my_db1`, and `table3` and `table4` in `my_db2`, to the target `table5` in downstream `my_db`.
   [[mydumper.files]]
   pattern = '(^|/)my_db1\.table[1-2]\..*\.sql$'
   schema = "my_db"
   table = "table5"
   type = "sql"
   
   [[mydumper.files]]
   pattern = '(^|/)my_db2\.table[3-4]\..*\.sql$'
   schema = "my_db"
   table = "table5"
   type = "sql"
   
   # Information of the target TiDB cluster. For example purposes only. Replace the IP address with your IP address.
   [tidb]
   # Information of the target TiDB cluster.
   # Values here are only for illustration purpose. Replace them with your own values.
   host = ${host}           # For example: "172.16.31.1"
   port = ${port}           # For example: 4000
   user = "${user_name}"    # For example: "root"
   password = "${password}" # For example: "rootroot"
   status-port = ${status-port} # The table information is read from the status port. For example: 10080
   # the IP address of the PD cluster. TiDB Lightning gets some information through the PD cluster.
   # For example: "172.16.31.3:2379".
   # When backend = "local", make sure that the values of status-port and pd-addr are correct. Otherwise an error will occur.
   pd-addr = "${ip}:${port}"
   

2. tidb-lightning実行します。シェルでプログラム名を直接呼び出してプログラムを実行すると、SIGHUP シグナルを受け取った後にプロセスが予期せず終了する可能性があります。3 やnohupやtiupなどのツールを使用してプログラムを実行し、プロセスをシェルのバックグラウンドに配置するscreenをお勧めします。S3 から移行する場合は、Amazon S3 バックエンドストアにアクセスできるアカウントの SecretKey と AccessKey を環境変数として Lightning ノードに渡す必要があります~/.aws/credentialsからの認証情報ファイルの読み取りもサポートされています。例:

   export AWS_ACCESS_KEY_ID=${access_key}
   export AWS_SECRET_ACCESS_KEY=${secret_key}
   nohup tiup tidb-lightning -config tidb-lightning.toml > nohup.out 2>&1 &
   

3. 移行タスクを開始した後、次のいずれかの方法で進行状況を確認できます。

   • grepツールを使用して、ログ内でキーワードprogress検索します。デフォルトでは、進行状況を報告するメッセージが5分ごとにログファイルに書き込まれます。
   • 監視ダッシュボードで進捗状況をビュー。詳細については、 TiDB Lightning監視参照してください。
   • 進捗状況はWebページでビューウェブインターフェース参照してください。

TiDB Lightningはインポートを完了すると自動的に終了します。最後の行のtidb-lightning.logにthe whole procedure completed含まれているかどうかを確認してください。含まれている場合はインポートが成功しています。含まれていない場合は、インポートでエラーが発生しました。エラーメッセージの指示に従ってエラーに対処してください。

注記：

移行が成功したかどうかにかかわらず、ログの最後の行は常にtidb lightning exitなります。これはTiDB Lightningが正常に終了したことを意味するだけで、インポートタスクが正常に完了したことを保証するものではありません。

移行中に問題が発生した場合は、 TiDB Lightningに関するよくある質問参照してください。

ステップ3. (オプション) DMを使用して増分レプリケーションを実行する

ソース データベース内の指定された位置からbinlogに基づいてデータの変更を TiDB に複製するには、TiDB DM を使用して増分レプリケーションを実行できます。

データソースを追加する

source1.yamlという新しいデータ ソース ファイルを作成し、DM にアップストリーム データ ソースを構成して、次のコンテンツを追加します。

# Configuration.
source-id: "mysql-01" # Must be unique.

# Specifies whether DM-worker pulls binlogs with GTID (Global Transaction Identifier).
# The prerequisite is that you have already enabled GTID in the upstream MySQL.
# If you have configured the upstream database service to switch master between different nodes automatically, you must enable GTID.
enable-gtid: true

from:
  host: "${host}"           # For example: 172.16.10.81
  user: "root"
  password: "${password}"   # Plaintext passwords are supported but not recommended. It is recommended that you use dmctl encrypt to encrypt plaintext passwords.
  port: ${port}             # For example: 3306

ターミナルで次のコマンドを実行します。1 tiup dmctl指定して、データソース構成を DM クラスターに読み込みます。

tiup dmctl --master-addr ${advertise-addr} operate-source create source1.yaml

パラメータの説明は以下のとおりです。

すべての MySQL アップストリーム インスタンスがデータ ソースとして DM に追加されるまで、上記の手順を繰り返します。

レプリケーションタスクを作成する

task.yamlというタスク構成ファイルを編集して、各データ ソースの増分レプリケーション モードとレプリケーション開始点を構成します。

name: task-test               # The name of the task. Should be globally unique.
task-mode: incremental        # The mode of the task. "incremental" means full data migration is skipped and only incremental replication is performed.
# Required for incremental replication from sharded tables. By default, the "pessimistic" mode is used.
# If you have a deep understanding of the principles and usage limitations of the optimistic mode, you can also use the "optimistic" mode.
# For more information, see [Merge and Migrate Data from Sharded Tables](https://docs.pingcap.com/tidb/dev/feature-shard-merge/).

shard-mode: "pessimistic"

# Configure the access information of the target TiDB database instance:
target-database:              # The target database instance
  host: "${host}"             # For example: 127.0.0.1
  port: 4000
  user: "root"
  password: "${password}"     # It is recommended to use a dmctl encrypted password.

# Use block-allow-list to configure tables that require sync:
block-allow-list:             # The set of filter rules on matching tables in the data sources, to decide which tables need to migrate and which not. Use the black-white-list if the DM version is earlier than or equal to v2.0.0-beta.2.
  bw-rule-1:                  # The ID of the block and allow list rule.
    do-dbs: ["my_db1"]        # The databases to be migrated. Here, my_db1 of instance 1 and my_db2 of instance 2 are configured as two separate rules to demonstrate how to prevent my_db2 of instance 1 from being replicated.
  bw-rule-2:
    do-dbs: ["my_db2"]
routes:                               # Table renaming rules ('routes') from upstream to downstream tables, in order to support merging different sharded table into a single target table.
  route-rule-1:                       # Rule name. Migrate and merge table1 and table2 from my_db1 to the downstream my_db.table5.
    schema-pattern: "my_db1"          # Rule for matching upstream schema names. It supports the wildcards "*" and "?".
    table-pattern: "table[1-2]"       # Rule for matching upstream table names. It supports the wildcards "*" and "?".
    target-schema: "my_db"            # Name of the target schema.
    target-table: "table5"            # Name of the target table.
  route-rule-2:                       # Rule name. Migrate and merge table3 and table4 from my_db2 to the downstream my_db.table5.
    schema-pattern: "my_db2"
    table-pattern: "table[3-4]"
    target-schema: "my_db"
    target-table: "table5"

# Configure data sources. The following uses two data sources as an example.
mysql-instances:
  - source-id: "mysql-01"             # Data source ID. It is the source-id in source1.yaml.
    block-allow-list: "bw-rule-1"     # Use the block and allow list configuration above. Replicate `my_db1` in instance 1.
    route-rules: ["route-rule-1"]     # Use the configured routing rule above to merge upstream tables.
#       syncer-config-name: "global"  # Use the syncers configuration below.
    meta:                             # The position where the binlog replication starts when `task-mode` is `incremental` and the downstream database checkpoint does not exist. If the checkpoint exists, the checkpoint is used. If neither the `meta` configuration item nor the downstream database checkpoint exists, the migration starts from the latest binlog position of the upstream.
      binlog-name: "${binlog-name}"   # The log location recorded in ${data-path}/my_db1/metadata in Step 1. You can either specify binlog-name + binlog-pos or binlog-gtid. When the upstream database service is configured to switch master between different nodes automatically, use binlog GTID here.
      binlog-pos: ${binlog-position}
      # binlog-gtid:                  " For example: 09bec856-ba95-11ea-850a-58f2b4af5188:1-9"
  - source-id: "mysql-02"             # Data source ID. It is the source-id in source1.yaml.
    block-allow-list: "bw-rule-2"     # Use the block and allow list configuration above. Replicate `my_db2` in instance2.
    route-rules: ["route-rule-2"]     # Use the routing rule configured above.

#       syncer-config-name: "global"  # Use the syncers configuration below.
    meta:                             # The migration starting point of binlog when task-mode is incremental and there is no checkpoint in the downstream database. If there is a checkpoint, the checkpoint will be used.
      # binlog-name: "${binlog-name}"   # The log location recorded in ${data-path}/my_db2/metadata in Step 1. You can either specify binlog-name + binlog-pos or binlog-gtid. When the upstream database service is configured to switch master between different nodes automatically, use binlog GTID here.
      # binlog-pos: ${binlog-position}
      binlog-gtid: "09bec856-ba95-11ea-850a-58f2b4af5188:1-9"
# (Optional) If you need to incrementally replicate some data changes that have been covered in the full migration, you need to enable the safe mode to avoid data migration errors during incremental replication.
# This scenario is common when the fully migrated data is not part of a consistent snapshot of the data source, and the incremental data is replicated from a location earlier than the fully migrated data.
# syncers:           # The running parameters of the sync processing unit.
#  global:           # Configuration name.
# If set to true, DM changes INSERT to REPLACE, and changes UPDATE to a pair of DELETE and REPLACE for data source replication operations.
# Thus, it can apply DML repeatedly during replication when primary keys or unique indexes exist in the table structure.
# TiDB DM automatically starts safe mode within 1 minute before starting or resuming an incremental replication task.
#    safe-mode: true

その他の構成については、 DM 高度なタスクコンフィグレーションファイル参照してください。

データ移行タスクを開始する前に、 tiup dmctlのcheck-taskサブコマンドを使用して、構成が DM 構成要件を満たしているかどうかを確認することをお勧めします。

tiup dmctl --master-addr ${advertise-addr} check-task task.yaml

tiup dmctl使用して次のコマンドを実行し、データ移行タスクを開始します。

tiup dmctl --master-addr ${advertise-addr} start-task task.yaml

このコマンドのパラメータは次のように記述されます。

タスクの起動に失敗した場合は、まず返された結果のプロンプトメッセージに従って設定を変更し、 tiup dmctlのstart-task task.yamlのサブコマンドを実行してタスクを再起動してください。問題が発生した場合は、 エラーの処理とTiDB データ移行に関するFAQ参照してください。

移行ステータスを確認する

tiup dmctlのquery-statusコマンドを実行すると、DM クラスターで実行中の移行タスクがあるかどうか、およびそのステータスを確認できます。

tiup dmctl --master-addr ${advertise-addr} query-status ${task-name}

詳細についてはクエリステータス参照してください。

タスクを監視し、ログを表示する

Grafana またはログを通じて、移行タスクの履歴と内部運用メトリックを表示できます。

• グラファナ経由

  TiUPを使用してDMクラスターをデプロイする際に、Prometheus、Alertmanager、Grafanaが正しくデプロイされていれば、GrafanaでDMの監視メトリクスを確認できます。具体的には、デプロイ時に指定したIPアドレスとポート番号をGrafanaに入力し、DMダッシュボードを選択してください。

• ログ経由

  DM の実行中、DM-master、DM-worker、dmctl は、移行タスクに関する情報を含むログを出力します。各コンポーネントのログディレクトリは以下のとおりです。

  • DMマスターログディレクトリ：DMマスターコマンドラインパラメータ--log-fileで指定します。DMがTiUPを使用してデプロイされている場合、ログディレクトリは/dm-deploy/dm-master-8261/log/です。
  • DM-worker ログディレクトリ: DM-worker コマンドラインパラメータ--log-fileで指定します。DM がTiUPを使用してデプロイされている場合、ログディレクトリは/dm-deploy/dm-worker-8262/log/です。

参照

• Dumpling
• TiDB Lightning
• 悲観モードと楽観的モード
• データ移行タスクを一時停止する
• データ移行タスクを再開する
• データ移行タスクを停止する
• データソースのエクスポートとインポート、およびクラスターのタスクコンフィグレーション
• 失敗したDDL文の処理
• エラーの処理