TiDB Data Migration 黑白名单过滤

使用 TiDB Data Migration (DM) 迁移数据时,你可以配置上游数据库实例表的黑白名单过滤 (Block & Allow List) 规则,用来过滤或者只迁移某些 database/table 的所有操作。

配置黑白名单

在迁移任务配置文件中,添加如下配置:

block-allow-list: # 如果 DM 版本早于 v2.0.0-beta.2 则使用 black-white-list。 rule-1: do-dbs: ["test*"] # 非 ~ 字符开头,表示规则是通配符;v1.0.5 及后续版本支持通配符规则。 do-tables: - db-name: "test[123]" # 匹配 test1、test2、test3。 tbl-name: "t[1-5]" # 匹配 t1、t2、t3、t4、t5。 - db-name: "test" tbl-name: "t" rule-2: do-dbs: ["~^test.*"] # 以 ~ 字符开头,表示规则是正则表达式。 ignore-dbs: ["mysql"] do-tables: - db-name: "~^test.*" tbl-name: "~^t.*" - db-name: "test" tbl-name: "t*" ignore-tables: - db-name: "test" tbl-name: "log"

黑白名单支持通配符和正则表达式来匹配,在简单任务场景下,推荐使用通配符匹配库表名:

  • 支持的通配符包括 *? 以及 []。注意通配符匹配中的 * 符号只能有一个,且必须在末尾,例如 tbl-name: "t*" 中的 "t*" 表示以 t 开头的表。详情请参考通配符匹配
  • 正则表达式必须以 ~ 字符开头。

参数解释

  • do-dbs:要迁移的库的白名单,类似于 MySQL 中的 replicate-do-db
  • ignore-dbs:要迁移的库的黑名单,类似于 MySQL 中的 replicate-ignore-db
  • do-tables:要迁移的表的白名单,类似于 MySQL 中的 replicate-do-table。必须同时指定 db-nametbl-name
  • ignore-tables:要迁移的表的黑名单,类似于 MySQL 中的 replicate-ignore-table。必须同时指定 db-nametbl-name

以上参数值以 ~ 开头时均支持使用正则表达式来匹配库名、表名。

过滤规则

判断 table test.t 是否应该被过滤的流程如下:

  1. 首先进行 schema 过滤判断

    • 如果 do-dbs 不为空,判断 do-dbs 中是否存在一个匹配的 schema。

      • 如果存在,则进入 table 过滤判断
      • 如果不存在,则过滤 test.t
    • 如果 do-dbs 为空并且 ignore-dbs 不为空,判断 ignore-dbs 中是否存在一个匹配的 schema。

      • 如果存在,则过滤 test.t
      • 如果不存在,则进入 table 过滤判断
    • 如果 do-dbsignore-dbs 都为空,则进入 table 过滤判断

  2. 进行 table 过滤判断

    1. 如果 do-tables 不为空,判断 do-tables 中是否存在一个匹配的 table。

      • 如果存在,则迁移 test.t
      • 如果不存在,则过滤 test.t
    2. 如果 ignore-tables 不为空,判断 ignore-tables 中是否存在一个匹配的 table。

      • 如果存在,则过滤 test.t.
      • 如果不存在,则迁移 test.t
    3. 如果 do-tablesignore-tables 都为空,则迁移 test.t

使用示例

假设上游 MySQL 实例包含以下表:

`logs`.`messages_2016` `logs`.`messages_2017` `logs`.`messages_2018` `forum`.`users` `forum`.`messages` `forum_backup_2016`.`messages` `forum_backup_2017`.`messages` `forum_backup_2018`.`messages`

配置如下:

block-allow-list: # 如果 DM 版本早于 v2.0.0-beta.2 则使用 black-white-list。 bw-rule: do-dbs: ["forum_backup_2018", "forum"] ignore-dbs: ["~^forum_backup_"] do-tables: - db-name: "logs" tbl-name: "~_2018$" - db-name: "~^forum.*" tbl-name: "messages" ignore-tables: - db-name: "~.*" tbl-name: "^messages.*"

应用 bw-rule 规则后:

table是否过滤过滤的原因
logs.messages_2016schema logs 没有匹配到 do-dbs 任意一项
logs.messages_2017schema logs 没有匹配到 do-dbs 任意一项
logs.messages_2018schema logs 没有匹配到 do-dbs 任意一项
forum_backup_2016.messagesschema forum_backup_2016 没有匹配到 do-dbs 任意一项
forum_backup_2017.messagesschema forum_backup_2017 没有匹配到 do-dbs 任意一项
forum.users1. schema forum 匹配到 do-dbs,进入 table 过滤判断
2. schema 和 table 没有匹配到 do-tablesignore-tables 中任意一项,并且 do-tables 不为空,因此过滤
forum.messages1. schema forum 匹配到 do-dbs,进入 table 过滤判断
2. schema 和 table 匹配到 do-tablesdb-name: "~^forum.*",tbl-name: "messages"
forum_backup_2018.messages1. schema forum_backup_2018 匹配到 do-dbs,进入 table 过滤判断
2. schema 和 table 匹配到 do-tablesdb-name: "~^forum.*",tbl-name: "messages"

文档内容是否有帮助?

下载 PDF文档反馈社区交流
产品
TiDB
TiDB Cloud
© 2023 PingCAP. All Rights Reserved.
Privacy Policy.