HBaseSource | OceanBase 文档中心

HBaseSource

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

OceanBase 迁移服务（OceanBase Migration Service，OMS）社区版 4.2.0-CE 及之后版本支持迁移 HBase 数据库的数据至 OBKV，本文为您介绍 HBaseSource 相关参数。

参数	取值	描述
queryType	`scan` 或 `hfile`	查询方式，该参数仅全量迁移时生效。取值为 `scan`，表示使用 region scan 方式。取值为 `hfile`，表示使用读取 file 方式。
flushTable	`true` 或 `false`，默认值为 `true`	该参数可选，仅全量迁移时生效。表示使用 hfile 查询时，开始全量迁移前是否需要 Flush 操作。
negativeTs	`true` 或 `false`，默认值为 `true`	该参数全量迁移和增量同步时生效。表示读取 HBase 时，时间戳 timestamp 是否转换为负数。说明 OBKV 中的时间戳为负数。
maxVersions	数字，默认值为 -1，表示读取所有版本	`queryType` 为 `scan` 时需要配置该参数，仅全量迁移生效。表示最大读取版本数。
initPeerOnly	`true` 或 `false`	该参数仅增量同步时生效，表示是否仅初始化 peer。取值为 true 时，初始化 peer 完成后，初始化开始位点，日志处理器不处理数据。目的是开始全量迁移前能够创建 peer，并在全量迁移完成后，在 OMS 社区版控制台设置 `initPeerOnly` 为 `false`，重新启动增量同步任务，正式处理增量数据。
peer	peer 名称	该参数仅增量同步时生效。表示源端 HBase 数据库中创建 peer 的名称，格式为 oms_{projectname}。
createPeer	`true` 或 `false`，默认值为 `true`	该参数仅增量同步时生效。取值为 `true`，表示需要创建 peer。取值为 `false`，表示无需创建 peer，用于已存在 peer 的场景。
autoPort	`true` 或 `false`，默认值为 `true`	该参数仅增量同步时生效，表示是否自动使用可用端口。设置 `autoPort` 为 `true` 后，所有涉及到端口的部分均有程序自动获取，端口范围为 9000 ~ 60000。
zkHost	IP 地址，多个地址之间使用英文逗号（,）分隔	该参数仅增量同步时生效。表示 `hbase.zookeeper.quorum` 程序模拟 HBase 使用到的 ZooKeeper 地址，格式为 `ip1:port1,ip2:port2,ip3:port3`。
zkPath	ZooKeeper 路径	该参数仅增量同步时生效。表示 `zookeeper.znode.parent` 程序模拟 HBase 使用到的 ZooKeeper 路径。
hbaseRootDir	HBase 集群根目录	该参数仅增量同步时生效，为可选参数。表示程序模拟 HBase 使用 `hbase.rootdir`，默认程序会自动以本地目录作为 `hbase.rootdir`。
regions	数字	`autoPort` 为 `true`，并且进行增量同步时生效，表示启动 regionServer 的数量。当 `autoPort` 为 `false` 时，启动 region server 的数量为 regionServerPorts 参数配置的端口数量。
masterPort	数字	该参数仅增量同步时生效。模拟 HMaster 服务端口，需要管控分配可用端口。
masterInfoPort	数字	该参数仅增量同步时生效。模拟 HMaster 信息端口。
regionServerPorts	JSON 数组：[123,3434]	该参数仅增量同步时生效。模拟 regionServer 端口号，端口的数量表示启动 regionServer 的数量。格式为 JSON 数组 [123,3434]。
regionServerInfoPorts	JSON 数组：[123,3434]	该参数仅增量同步时生效。模拟 regionServer 信息端口号，此处设置的数量需要大于等于 regionServerPorts 的数量。格式为 SON 数组 [123,3434]。