如何更新黑白名单 | OceanBase 文档中心

如何更新黑白名单

更新时间：2026-04-14 15:40:47

如果您通过匹配规则方式选择迁移对象，可以对数据迁移任务的迁移对象规则（白名单）和排除对象规则（黑名单）进行更新。本文为您介绍黑白名单的工作机制，以及如何更新黑白名单。

注意事项

黑白名单中不支持重复的对象名称。如果黑白名单中包含相同对象，仅生效黑名单。

黑白名单实现原理

黑白名单通过配置化的形式提供了库表过滤、映射、ETL 等差异化配置能力，黑白名单结构如下：

[{
 "name": "db*",
 "map": "mdby",
 "func": "fn",
 "attr": {
  "ddl": "mmm",
  "hey": "hey"
 },
 "sub": [{
  "name": "mb*",
  "map": "tb2222",
  "func": "fn",
  "sub": [{
   "name": "c"
  }]
 }]
}, {
 "name": "db123",
 "map": "mdb5",
 "all": false,
 "attr": {
  "ddl": "zzz",
  "hey": "hey"
 },
 "sub": [{
  "name": "tb12345"
 }]
}]

黑白名单由两个结构语义相同的 JSON 来表示，每个 JSON 配置是一个 JSON 数组来表示。每个数组的元素都是一个 JSON 对象，每个 JSON 对象都包含了如下属性。

属性	描述
name	该层级的元素的名称，根据所处层级的不同含义不同。通常对于库/表/列三级的使用方式：最外层表示库名，第二层表示表名，第三层表示列名。
map	该层级 name 的映射名称，如果没有指定，则该值与 name 相同。
all	是否需要下一层级的所有的对象，默认为 true。如果在库层级，含义是需要该库下所有的表。如果在表层级，含义是需要该表下所有的列。
func	name 的匹配规则，func 目前支持三种模式。默认为精确匹配，所有字符相同才算相同。fn 为 Linux 的 fnmatch 模式，以 '.' 开头的对象是不能匹配的。reg 为 Java 的正则匹配模式。匹配的时候，优先匹配精准模式，然后遍历 fn, reg 模式匹配。
attr	该层级的属性，是一个 JSON 对象。例如，过滤 DML 类型的配置，ETL 的配置都会在该属性中提供。
sub	下一层的对象，和该层级定义相同，但是随着层数的增加，含义会变化。库的下一层是表，表的下一层是列。

注意

一个匹配生效的前提是它在白名单中并且不在黑名单中。

更新黑白名单的操作包括增加表和删除表。

增加表：在相应数据库的 sub 的属性下面，添加一个 JSON 对象，填写对应的 name、map 等属性，加入到 sub 数组中。
删除表：找到需要删除的表，从白名单中删除或者在黑名单中添加该表的配置。

更新 Store 组件的黑白名单

登录 OMS 社区版控制台。
在左侧导航栏，单击 运维监控 > 组件。
在组件页面，单击 Store 页签。
在 Store 页签，单击目标 Store 对应操作列的更新。

注意

OMS 社区版支持更新处于 运行中、已停止、异常和 非预期退出 状态的 Store 组件的配置。
在 更新配置 对话框，鼠标悬停至参数 liboblog.tb_black_list，单击参数配置后显示的编辑图标。

如果您需要更新白名单，鼠标悬停至参数 liboblog.tb_white_list，单击参数配置后显示的编辑图标。
在文本框中输入修改的参数值后，单击确认图标。
在 更新配置 对话框，单击确定。

更新 Incr-Sync/Full-Import 组件的黑白名单

登录 OMS 社区版控制台。
在左侧导航栏，单击 运维监控 > 组件。
在组件页面，单击 Incr-Sync 或 Full-Import 页签。
在 Incr-Sync 或 Full-Import 页签，单击目标组件对应操作列的更新。

注意

OMS 社区版支持更新处于 运行中、已停止 和异常状态的 Incr-Sync 或 Full-Import 组件的配置。
在 更新配置 对话框，鼠标悬停至 root > condition 下的参数 blackCondition，单击参数配置后显示的编辑图标。

如果您需要更新白名单，鼠标悬停至 root > condition 下的参数 whiteCondition，单击参数配置后显示的编辑图标。
在文本框中输入修改的参数值后，单击确认图标。
在 更新配置 对话框，单击确定。

更新 Full-Verification 组件的黑白名单

登录 OMS 社区版控制台。
在左侧导航栏，单击 运维监控 > 组件。
在组件页面，单击 Full-Verification 页签。
在 Full-Verification 页签，单击目标组件对应操作列的更新。

注意

OMS 社区版支持更新处于 运行中、已停止 和异常状态的 Full-Verification 组件的配置。
在 更新配置 对话框，鼠标悬停至 root 下的参数 condition.blackCondition，单击参数配置后显示的编辑图标。
在文本框中输入修改的参数值后，单击确认图标。

您也可以单击 [...] 后的确认图标，转换为 JSON 格式进行修改。
在 更新配置 对话框，单击确定。