---
title: "创建 MySQL 数据库至 DataHub 的数据同步项目 | OceanBase 文档中心"
description: 创建 MySQL 数据库至 DataHub 的数据同步项目 本文为您介绍如何同步 MySQL 数据库的数据至 DataHub。 前提条件 已为自建 MySQL 数据库开启了 Binlog，详情请参见 为 MySQL 数据库开启 Binlog 。 已为源端自建 MySQL 数据库创建专用于数据迁移任务的数据库用户，并为…
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*L03BS6f-o40AAAAAAAAAAAAADiGDAQ/original) 迁移服务 OMSV 3.3.1 企业版

# 创建 MySQL 数据库至 DataHub 的数据同步项目

更新时间：2024-06-07 16:55:25

本文为您介绍如何同步 MySQL 数据库的数据至 DataHub。

## 前提条件

- 已为自建 MySQL 数据库开启了 Binlog，详情请参见 [为 MySQL 数据库开启 Binlog](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-10000000000496861)。
 - 已为源端自建 MySQL 数据库创建专用于数据迁移任务的数据库用户，并为其赋予了相关权限。详情请参见 [创建数据库用户](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-10000000000496858)。

## 使用限制

- 待同步的表名和其中的列名不能包含中文字符。
 - OMS 支持字符集配置为 UTF8 和 GBK 时的数据同步。
 - 数据源标识和用户账号等，在 OMS 系统内全局唯一。

DataHub 相关的使用限制如下：

- DataHub 官方限制一条消息具体的大小根据云环境而定，通常为 1 MB。
 - 由于是攒批发送，DataHub 限制一次只能发送 4 MB 的消息。如果单条消息满足可发送的前提，您可以通过更改配置项 `batch.size` 来设置攒批大小，默认为 20 条消息攒批发送（时间窗口一秒内）。
 - OMS 仅支持同步库名、表名为 ASCII 码且不包含特殊字符（.|"'`()=;/&\n）的对象。

## 注意事项

- 节点之间的时钟不同步，或者电脑终端和服务器之间的时钟不同步，均可能导致增量同步的延迟时间不准确。

  例如，如果时钟早于标准时间，可能导致延迟时间为负数。如果时钟晚于标准时间，可能导致延迟。
 - 如果 MySQL 数据库需要进行增量解析，则源端 MySQL Server 必须设置 server_id。
 - 当项目意外中断进行断点续传时，DataHub 中可能会存在部分重复数据（最近一分钟内），需要下游具备排重能力。
 - 同步 MySQL 的增量数据至 DataHub 时，其中包含表结构至 DataHub Schema 的初始化 Schema。下表为 MySQL 数据类型的支持情况。

  | 数据类型 | 映射 DataHub 类型 |
  | --- | --- |
  | BIT | BIGINT |
  | CHAR | STRING |
  | BINARY | STRING |
  | VARBINARY | STRING |
  | INT | BIGINT |
  | TINYINT | BIGINT |
  | SMALLINT | BIGINT |
  | MEDIUMINT | BIGINT |
  | BIGINT | BIGINT |
  | FLOAT | FLOAT |
  | DOUBLE | DOUBLE |
  | DECIMAL | DECIMAL |
  | DATE | STRING |
  | TIME | STRING |
  | YEAR | STRING |
  | DATETIME | STRING |
  | TIMESTAMP | STRING |
  | VARCHAR | STRING |
  | TINYBLOB | STRING |
  | TINYTEXT | STRING |
  | BLOB | STRING |
  | TEXT | STRING |
  | MEDIUMBLOB | STRING |
  | MEDIUMTEXT | STRING |
  | LONGBLOB | STRING |
  | LONGTEXT | STRING |

## 补充 Properties

如果自行创建 Topic，启动同步项目前，请在 DataHub 的 Schema 中补充下述 Properties。如果由 OMS 自动创建 Topic 和结构同步，OMS 会自动补充下述 Properties。

> **注意：**
>
>  
>
> 该部分内容仅适用于 Tuple 类型的 Topic。

| 名称 | 类型 | 描述 |
| --- | --- | --- |
| oms_timestamp | STRING | 发生变更的时间。 |
| oms_table_name | STRING | 源端为表时，变更表名。 |
| oms_database_name | STRING | 源端为数据库时，变更库名。 |
| oms_sequence | STRING | 变更序列号。承诺相同机器上，同一个主键不断递增。 |
| oms_record_type | STRING | 变更类型，包括 `UPDATE`、`INSERT` 和 `DELETE`。 |
| oms_is_before | STRING | 如果是 `UPDATE` 类型，Y 表示该条数据为变更前的数据。 |
| oms_is_after | STRING | 如果是 `UPDATE` 类型，Y 表示该条数据为变更后的数据。 |

## 操作步骤

1. 新建数据同步项目。

      1. 登录 OMS 控制台。
      2. 在左侧导航栏，单击 **数据同步**。
      3. 在 **数据同步** 页面，单击右上角的 **新建同步项目**。
 2. 在 **选择源和目标** 页面，配置各项参数。

   | 参数 | 描述 |
   | --- | --- |
   | 同步项目名称 | 建议使用中文、数字和字母的组合。名称中不能包含空格，长度不能超过 64 个字符。 |
   | 标签 | 单击文本框，在下拉列表中选择目标标签。您也可以单击 **管理标签**，进行新建、修改和删除。详情请参见 [通过标签管理数据同步项目](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-10000000000496893)。 |
   | 源端 | 如果您已创建 MySQL 数据源，请从下拉列表中进行选择。如果未创建，请单击下拉列表中的 **添加数据源**，在右侧对话框进行添加。参数详情请参见 [添加 MySQL 数据源](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-10000000000496901)。 |
   | 目标端 | 如果您已创建 DataHub 数据源，请从下拉列表中进行选择。如果未创建，请单击下拉列表中的 **添加数据源**，在右侧对话框进行添加。参数详情请参见 [添加 DataHub 数据源](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-10000000000496906)。 |
 3. 单击 **下一步**，在 **选择同步类型** 页面，选择当前数据同步项目的 **同步类型和配置**。

   **同步类型和配置** 包括 **结构同步** 和 **增量同步** 。 **结构同步** 实际为创建 Topic， **增量同步** 仅支持 **数据变更 DML** （包括 `Insert`、`Delete` 和 `Update`）。
 4. 单击 **下一步**，在 **选择同步对象** 页面，选择需要同步的 Topic 类型和范围。

   Topic 类型包括 Tuple 和 Blob。Tuple 类型的 Topic 支持类似于数据库记录的数据，每条记录包含多个列。Blob 类型的 Topic 仅支持写入一块二进制数据作为一个 Record，数据将会以 BASE64 编码传输。详情请参见 DataHub 官方文档。

   选择需要同步的 Topic 类型后，请进行以下操作：

      1. 在选择区域左侧选中需要同步的对象。
      2. 单击 **>**。
      3. 根据业务需求，选择映射方式。

        > **注意：**
        >
        >  
        >
        > 当选择 Topic 类型为 Tuple 时， 如果未勾选 **结构同步** ，则仅支持同步单张表至单 Topic。

             - 如果选择同步单张表，请在 **将对象映射至 Topic** 对话框中，选择需要的映射方式进行配置，单击 **确定**。

              如果设置同步类型和配置时未勾选 **结构同步**，则仅支持选择 **已有 Topic**。如果设置同步类型和配置时已选择 **结构同步**，则仅支持选择一种映射方式进行 Topic 的创建或选择。

              例如，已选择结构同步的情况下，您使用了新建 Topic 和选择已有 Topic 两种映射方式，或通过重命名的方式更改了 Topic 的名称，会因为选项冲突导致预检查报错。

              | 参数 | 描述 |
              | --- | --- |
              | 新建 Topic | 在文本框中输入新建 Topic 的名称。支持 128 位以内的字母、数字或下划线（_），且必须以字母开头。 |
              | 选择 Topic | OMS 提供查询 DataHub Topic 的能力，您可以单击 **选择 Topic**，在 **已有 Topic** 下拉列表中，搜索并选中需要同步的 Topic。 您也可以输入已有 Topic 后选中显示的 Topic 名称。 |
              | 批量生成 Topic | 批量生成 Topic 的规则为 `Topic_${Database Name}_${Table Name}`。 |

              如果您选择 **新建 Topic** 或 **批量生成 Topic**，结构同步成功后，在 DataHub 侧能够查询到新建的 Topic。其分片数量默认为 2 个，数据过期时间默认为 7 天，且不支持修改。
             - 如果选择同步多张表，请在弹出的对话框中，单击 **确定**。

              如果您选择 Tuple 类型的 Topic 但未勾选 **结构同步**，选择多张表时，在 **将对象映射至 Topic** 对话框中选择一个 topic 并单击确定后，右侧一个 topic 下会显示多张表，但实际仅支持同步一张表。此时单击 **下一步**，界面会弹出提示：Tuple 类型的 Topic 与表仅支持 One to One 映射关系。
      4. 单击 **确定**。

   同步 MySQL 数据库的数据至 DataHub 时，OMS 支持通过文本导入对象，并支持设置目标表的分片列、移除单个对象或全部对象等操作。目标端对象的结构为 Topic>DataBase>Table。

   | 操作 | 步骤 |
   | --- | --- |
   | 导入对象 | 1. 在选择区域的右侧列表中，单击右上角的 **导入对象**。   2. 在对话框中，单击 **确定**。         **注意：**         导入会覆盖之前的操作选择，请谨慎操作。   3. 在 **导入同步对象** 对话框中，导入需要同步的对象。         您可以通过导入 CSV 文件的方式进行库表重命名、设置行过滤条件等操作。详情请参见 [下载和导入同步对象配置](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-10000000000496894)。   4. 单击 **检验合法性**。   5. 通过合法性的检验后，单击 **确定**。 |
   | 更改 Topic | 选择 Topic 类型为 BLOB 时，支持对目标对象进行更改 Topic 操作。    1. 在选择区域的右侧列表中，鼠标悬停至目标对象。   2. 单击显示的 **更改 Topic**。   3. 在 **将对象映射至 Topic** 的对话框中，更改需要同步的 Topic。   4. 单击 **确定**。         **注意：**         确定后会将所选 Topic 及表合并至选中 Topic，请谨慎操作。 |
   | 设置 | 1. 在选择区域的右侧列表中，鼠标悬停至目标对象。   2. 单击显示的 **设置**。   3. 在 **设置** 对话框的 **分片列** 下拉列表中，选择目标分片列。您可以选择多个字段作为分片列，该参数为选填。         选择分片列时，如果没有特殊情况，默认选择主键即可。如果存在主键负载不均衡的情况，请选择唯一性标识且负载相对均衡的字段作为分片列。         请确保分片列的正确性。分片列填写错误，会导致数据同步项目失败。分片列的主要作用如下：           - 负载均衡：在目标端可以进行并发写入的情况下，通过分片列区分发送消息需要使用的特定线程。          - 有序性：由于存在并发写入可能导致的无序问题，OMS 确保在分片列的值相同的情况下，用户接收到的消息是有序的。此处的有序是指变更顺序（DML 对于一列的执行顺序）。   4. 单击 **确定**。 |
   | 移除/全部移除 | OMS 支持在数据映射时，对暂时选中到目标端的单个或多个对象进行移除操作。    - 移除单个同步对象        在选择区域的右侧列表中，鼠标悬停至目标对象，单击显示的 **移除**，即可移除该同步对象。   - 移除全部同步对象        在选择区域的右侧列表中，单击右上角的 **全部移除**。在对话框中，单击 **确定**，即可移除全部同步对象。 |
 5. 单击 **下一步**，在 **同步选项** 页面，配置各项参数。

   | 参数 | 描述 |
   | --- | --- |
   | 增量同步起始位点 | 指定同步某个时间节点之后的数据，默认为当前系统时间。您可以选择时间节点，也可以直接输入时间戳。   **注意：**    仅支持选择当前时间，或当前时间之前的时间点。    该位点与当前归档日志的保留时间密切相关。如果无特殊要求，可以从当前位点开始启动。 |
   | 序列化方式 | 控制数据同步至 DataHub 的消息格式，目前支持 **Default**、**Canal**、**Dataworks**（支持 2.0 版本）、**SharePlex** 和 **DefaultExtendColumnType**。详情请参见 [数据格式说明](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-10000000000496846)。    **注意：**    仅在 **选择同步类型** 页面，选择 Topic 类型为 Blob 时，会显示该参数。 |
   | 开启事务内序号编排 | 根据需求，设置是否开启事务内保持排序。如果开启，OMS 可以为一个事务发送至下游进行顺序标识。   **注意：**    该参数仅对 **SharePlex** 格式生效，目的是为了确保您能够获取构成交易的 DML 语句的序号。    例如，在同一交易内包含 10 条 DML 语句（顺序为 1，2，3...10），则 OMS 会按照 1，2，3 ...10 的顺序投递至目标端。    该选项会有性能损耗，请根据业务性质选择性开启。 |
   | 分区规则 | 同步源端数据至 DataHub Topic 的规则，目前支持 **Hash** 和 **Table**。    - **Hash** 表示 OMS 使用一定的 Hash 算法，根据主键值或分片列值 Hash 选择 DataHub 的 Shard。   - **Table** 表示 OMS 将一张表中的全部数据投递至同一个分区中，以表名作为 Hash 键。 |
   | 业务系统标识（可选） | 用于标识数据的业务系统来源，以便您后续进行自定义处理。该业务系统标识的长度限制为 1~20 个字符。 |
 6. 单击 **预检查**。

   在 **预检查** 环节，OMS 会检测逻辑表 Schema 和物理表 Schema 是否一致。目前仅检查列名、列类型，以及是否为空，不检查长度和默认值。如果预检查报错，请排查并处理问题后，重新执行预检查，直至预检查成功。
 7. 单击 **启动项目**。

   如果您暂时无需启动项目，请单击 **保存**，跳转至数据同步项目的详情页面，您可以根据需要手动启动数据同步项目。如果您需要查看详情，请参见 [查看数据同步项目的详情](https://www.oceanbase.com/docs/enterprise-oms-doc-cn-10000000000496890)。

   如果中途接入数据的过程出错（通常由于网络不通或进程启动过慢导致），您可以在同步项目的列表或详情页面，单击 **恢复**。

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线