分片集群架构MongoDB的单向同步 - 云数据库 MongoDB

数据传输服务DTS（Data Transmission Service）支持将MongoDB（分片集群架构）的数据同步至MongoDB（副本集架构或分片集群架构）。本文以云数据库MongoDB版实例间的数据同步为例，为您介绍操作步骤。

前提条件

已创建目标云数据库MongoDB版（副本集架构或分片集群架构）实例，创建方式，请参见创建副本集实例或创建分片集群实例。
重要
- 建议目标云数据库MongoDB版实例的存储空间比源云数据库MongoDB版实例占用的存储空间大10%。
- 支持的版本，请参见同步方案概览。
源云数据库MongoDB版分片集群实例的Shard节点需要申请连接地址，且各Shard的账号和密码需保持一致。申请方法，请参见申请Shard或ConfigServer节点连接地址。
若目标MongoDB为分片集群架构实例，请根据业务需求，在目标云数据库MongoDB版（分片集群架构）实例中创建需要分片的数据库和集合、配置数据分片、开启Balancer并进行预分片。更多信息，请参见设置数据分片以充分利用Shard性能和如何处理分片集群架构的MongoDB数据分布不均衡。
说明
- 配置数据分片可以避免数据被同步至同一Shard（存储数据库数据的组件），导致无法发挥集群性能；开启Balancer并进行预分片可以避免数据倾斜问题。
- 本文以先配置后购买DTS任务为例，无需填写源云数据库MongoDB版（分片集群架构）下的Shard数量。
  如您先购买后配置DTS任务，则需要在购买DTS任务时填写其正确的Shard数量。

注意事项

类型

说明

源和目标库的限制

带宽要求：源库所属的服务器需具备足够出口带宽，否则将影响数据同步速率。
待同步的集合需具备主键或唯一约束，且字段具有唯一性，否则可能会导致目标数据库中出现重复数据。
如同步对象为集合级别，且需进行编辑（如集合的名称映射），则单次同步任务仅支持同步至多1000张集合。当超出数量限制，任务提交后会显示请求报错，此时建议您拆分待同步的集合，分批配置多个任务，或者配置整库的同步任务。
需开启Oplog日志。
说明
DTS要求源数据库的Oplog日志至少保留7天以上，否则DTS可能因无法获取Oplog日志而导致任务失败，极端情况下甚至可能会导致数据不一致或丢失。由于您所设置的Oplog日志保存时间低于DTS要求的时间进而导致的问题，不在DTS的SLA保障范围内。
在DTS同步期间，不支持MongoDB分片集群进行分片的扩缩容，否则会导致DTS任务失败。
若源实例为分片集群架构的自建MongoDB，则接入方式仅支持专线/VPN网关/智能网关和云企业网CEN。
源MongoDB分片集群实例的Mongos节点的数量不能超过10个。
暂不支持同步包含TTL（Time To Live）索引的集合。若待同步的数据库中包含TTL索引，则可能会由于源库和目标库时区、时钟等的不一致，导致数据不一致。
请确保源和目标实例中没有孤立文档，否则可能会导致数据不一致甚至任务失败。更多信息，请参见孤立文档和如何清理MongoDB（分片集群架构）的孤立文档？。

其他限制

在任务开始前，需要为源端待同步的数据添加与目标端对应的分片键；在任务开始后，待同步的数据在使用INSERT命令时必须包含分片键，使用UPDATE命令时不支持更改分片键。

建议源和目标库的MongoDB的数据库版本保持一致，或者从低版本同步到高版本以保障兼容性。如为高版本同步至低版本，可能存在数据库兼容性问题。
不支持同步admin和local库中的数据。
不保留事务信息，即源库中的事务同步到目标库时会转变为单条的记录。
执行数据同步前需评估源库和目标库的性能，同时建议业务低峰期执行数据同步。否则全量数据初始化时将占用源库和目标库一定的读写资源，可能会导致数据库的负载上升。
全量初始化会并发执行INSERT操作，导致目标数据库的集合产生碎片，因此全量初始化完成后目标实例的集合空间比源实例的集合空间大。
若目标集合存在唯一索引或目标集合的capped属性为true时，则在增量同步阶段该集合不支持并发回放（只支持单线程写入），从而可能会导致任务延迟增高。
由于DTS写入数据的逻辑为并发写入，所以会导致目标端占用的存储空间比源端大5%~10%。
目标端MongoDB的count数量需要使用db.$table_name.aggregate([{ $count:"myCount"}])语法查询。
请确保目标端MongoDB没有与源端相同的主键（默认为_id），否则会导致数据丢失。若目标端有与源端相同的主键，请在不影响业务的前提条件下清空目标端的相关数据（删掉目标端中与源端相同_id的文档）。
全量同步期间必须关闭源MongoDB数据库的均衡器（Balancer），直至每个子任务都运行到增量阶段，否则可能会造成数据不一致。关于均衡器的操作，请参见管理MongoDB均衡器Balancer。
若您无需使用DTS提供的库表结构同步功能（例如目标端已配置好数据分片），在配置任务对象及高级配置阶段中，同步类型请勿勾选库表结构同步，否则可能会因为分片冲突而导致数据不一致或任务失败。

费用说明

同步类型	链路配置费用
库表结构同步和全量数据同步	不收费。
增量数据同步	收费，详情请参见计费概述。

支持的单向同步架构

目前DTS仅支持两个云数据库MongoDB版实例（分片集群架构）之间的单向同步，暂不支持多个云数据库MongoDB版实例之间的单向同步。

任务步骤说明

同步类型	说明
库表结构同步	将源云数据库MongoDB版中同步对象的结构同步到目标云数据库MongoDB版中。
全量同步	将源云数据库MongoDB版同步对象的存量数据全部同步到目标云数据库MongoDB版中。说明支持全量同步DATABASE和COLLECTION。
增量同步	在全量同步的基础上，将源云数据库MongoDB版的增量更新同步到目标云数据库MongoDB版中。说明支持同步的增量更新如下： CREATE COLLECTION、INDEX DROP COLLECTION、INDEX RENAME COLLECTION 在集合中插入、更新、删除文档的操作。

清理孤立文档

迁移数据前您需要清除源MongoDB数据库中的孤立文档。

重要

如果未清除孤立文档，将影响迁移性能，而且可能在迁移过程中会遇到_id冲突的文档，导致迁移错误的数据。

云数据库 MongoDB 版

说明

MongoDB 4.2以下大版本或4.0.6以下小版本的实例在执行清理脚本时会报错。如何查看实例当前版本，请参见MongoDB小版本说明。如何升级小版本和大版本，请参见升级数据库大版本和升级数据库小版本。

清理孤立文档需要使用cleanupOrphaned命令。在MongoDB 4.4及以上版本和MongoDB 4.2及以下版本中的使用方法略有区别，具体操作方式如下。

MongoDB 4.4及以上版本

在可以连接分片集群实例的服务器上，创建一个用于清理孤立文档的JS脚本，脚本名称为cleanupOrphaned.js。

说明

该脚本用于清理多个Shard节点的多个数据库中所有集合的孤立文档。如需清理特定集合中的孤立文档，可自行修改JS脚本来完成。

// shard实例名称列表
var shardNames = ["shardName1", "shardName2"];
// 数据库列表
var databasesToProcess = ["database1", "database2", "database3"];

shardNames.forEach(function(shardName) {
    // 遍历指定的数据库列表
    databasesToProcess.forEach(function(dbName) {
        var dbInstance = db.getSiblingDB(dbName);
        // 获取该数据库实例的所有集合名称
        var collectionNames = dbInstance.getCollectionNames();
        
        // 遍历每个集合
        collectionNames.forEach(function(collectionName) {
            // 完整的集合名称
            var fullCollectionName = dbName + "." + collectionName;
            // 构建 cleanupOrphaned 命令
            var command = {
                runCommandOnShard: shardName,
                command: { cleanupOrphaned: fullCollectionName }
            };

            // 执行命令
            var result = db.adminCommand(command); 
            if (result.ok) {
                print("Cleaned up orphaned documents for collection " + fullCollectionName + " on shard " + shardName);
                printjson(result);
            } else {
                print("Failed to clean up orphaned documents for collection " + fullCollectionName + " on shard " + shardName);
            }
        });
    });
});

您需要对脚本中的shardNames和databasesToProcess参数的值进行修改，具体说明如下：

shardNames：分片集群实例中待清理孤立文档的Shard节点的ID数组，您可以在实例基本信息页面的Shard列表区域获取，例如d-bp15a3796d3a****。
databasesToProcess：待清理孤立文档的数据库名称数组。

在cleanupOrphaned.js脚本所在的目录下，执行以下命令清理孤立文档。

mongo --host <Mongoshost> --port <Primaryport>  --authenticationDatabase <database> -u <username> -p <password> cleanupOrphaned.js > output.txt

参数说明如下。

参数	说明
`<Mongoshost>`	分片集群实例Mongos节点的连接地址，格式为`s-bp14423a2a51****.mongodb.rds.aliyuncs.com`。
`<Primaryport>`	分片集群实例Mongos节点的端口号，默认为3717。
`<database>`	鉴权数据库名，即数据库账号所属的数据库。
`<username>`	数据库账号。
`<password>`	数据库账号的密码。
`output.txt`	执行结果保存到output文件中。

MongoDB 4.2及以下版本

在可以连接分片集群实例的服务器上，创建一个用于清理孤立文档的JS脚本，脚本名称为cleanupOrphaned.js。

说明

该脚本用于清理多个Shard节点中指定数据库下指定集合的孤立文档。如需清理数据库中多个集合的孤立文档，您可以修改fullCollectionName参数并多次执行，也可以自行修改脚本通过遍历的方式执行。

function cleanupOrphanedOnShard(shardName, fullCollectionName) {
    var nextKey = { };
    var result;

    while ( nextKey != null ) {
        var command = {
            runCommandOnShard: shardName,
            command: { cleanupOrphaned: fullCollectionName, startingFromKey: nextKey }
        };

        result = db.adminCommand(command);
        printjson(result);

        if (result.ok != 1 || !(result.results.hasOwnProperty(shardName)) || result.results[shardName].ok != 1 ) {
            print("Unable to complete at this time: failure or timeout.")
            break
        }

        nextKey = result.results[shardName].stoppedAtKey;
    }

    print("cleanupOrphaned done for coll: " + fullCollectionName + " on shard: " + shardName)
}

var shardNames = ["shardName1", "shardName2", "shardName3"]
var fullCollectionName = "database.collection"

shardNames.forEach(function(shardName) {
    cleanupOrphanedOnShard(shardName, fullCollectionName);
});

您需要对脚本中的shardNames和fullCollectionName参数的值进行修改，具体说明如下：

shardNames：分片集群实例中待清理孤立文档的Shard节点的ID数组，您可以在实例基本信息页面的Shard列表区域获取，例如d-bp15a3796d3a****。
fullCollectionName：需要替换为待清理孤立文档的集合名称，格式为数据库名称.集合名称。

在cleanupOrphaned.js脚本所在的目录下，执行以下命令清理孤立文档。

mongo --host <Mongoshost> --port <Primaryport>  --authenticationDatabase <database> -u <username> -p <password> cleanupOrphaned.js > output.txt

参数说明如下。

参数	说明
`<Mongoshost>`	分片集群实例Mongos节点的连接地址，格式为`s-bp14423a2a51****.mongodb.rds.aliyuncs.com`。
`<Primaryport>`	分片集群实例Mongos节点的端口号，默认为3717。
`<database>`	鉴权数据库名，即数据库账号所属的数据库。
`<username>`	数据库账号。
`<password>`	数据库账号的密码。
`output.txt`	执行结果保存到output文件中。

自建MongoDB

在可以连接自建MongoDB数据库的服务器上下载cleanupOrphaned.js脚本文件。

wget "https://docs-aliyun.cn-hangzhou.oss.aliyun-inc.com/assets/attach/120562/cn_zh/1564451237979/cleanupOrphaned.js"

修改cleanupOrphaned.js脚本文件，将test替换为待清理孤立文档的数据库名。
重要
如果您有多个数据库，您需要重复执行步骤2~步骤3。
执行如下命令，清理Shard节点中指定数据库下所有集合的孤立文档。
说明
您需要重复执行本步骤，为每个Shard节点清理孤立文档。
```
mongo --host <Shardhost> --port <Primaryport>  --authenticationDatabase <database> -u <username> -p <password> cleanupOrphaned.js
```
说明
- <Shardhost>：Shard节点的IP地址。
- <Primaryport>：Shard节点中的Primary节点的服务端口。
- <database>：鉴权数据库名，即数据库账号所属的数据库。
- <username>：登录数据库的账号。
- <password>：登录数据库的密码。
示例：
本案例的自建MongoDB数据库有三个Shard节点，所以需要分别为这三个节点清除孤立文档。
```
mongo --host 172.16.1.10 --port 27018  --authenticationDatabase admin -u dtstest -p 'Test123456' cleanupOrphaned.js
```
```
mongo --host 172.16.1.11 --port 27021 --authenticationDatabase admin -u dtstest -p 'Test123456' cleanupOrphaned.js
```
```
mongo --host 172.16.1.12 --port 27024  --authenticationDatabase admin -u dtstest -p 'Test123456' cleanupOrphaned.js
```

操作步骤

重要

本文以先配置后购买DTS任务为例，无需填写源云数据库MongoDB版（分片集群架构）下的Shard数量。

如您先购买后配置DTS任务，则需要在购买DTS任务时填写其正确的Shard数量。

进入同步任务的列表页面。
1. 登录DMS数据管理服务。
2. 在顶部菜单栏中，单击集成与开发（DTS）。
3. 在左侧导航栏，选择数据传输（DTS） > 数据同步。
说明
- 实际操作可能会因DMS的模式和布局不同，而有所差异。更多信息，请参见极简模式和自定义DMS界面布局与样式。
- 您也可以登录新版DTS同步任务列表页面。
在同步任务右侧，选择同步实例所属地域。
说明
新版DTS同步任务列表页面，需要在页面左上角选择同步实例所属地域。

单击创建任务，配置源库及目标库信息。

类别	配置	说明
无	任务名称	DTS会自动生成一个任务名称，建议配置具有业务意义的名称（无唯一性要求），便于后续识别。
源库信息	选择已有的DMS数据库实例（可选，如未创建可忽略此处选择，直接在下方配置数据库信息即可）	您可以按实际需求，选择是否使用已有实例。如使用已有实例，下方数据库信息将自动填入，您无需重复输入。如不使用已有实例，您需要输入下方的数据库信息。
	数据库类型	选择MongoDB。
	接入方式	选择云实例。
	实例地区	选择源云数据库MongoDB版所属地域。
	是否跨阿里云账号	本示例为同一阿里云账号间的同步，选择不跨账号。
	架构类型	选择分片集群架构。
	实例ID	选择源云数据库MongoDB版实例ID。
	鉴权数据库名称	填入源云数据库MongoDB版实例数据库账号所属的数据库名称，若未修改过则默认为admin。
	数据库账号	填入源云数据库MongoDB版的数据库账号，需具备待同步库、admin库和local库的read权限。
	数据库密码	填入该数据库账号对应的密码。
	shard账号	填入源云数据库MongoDB版的数据库Shard账号。说明若您的源库为自建MongoDB数据库，还需要在上方填入Shard节点的shard接入信息。
	shard密码	填入源云数据库MongoDB版的数据库Shard密码。
目标库信息	选择已有的DMS数据库实例（可选，如未创建可忽略此处选择，直接在下方配置数据库信息即可）	您可以按实际需求，选择是否使用已有实例。如使用已有实例，下方数据库信息将自动填入，您无需重复输入。如不使用已有实例，您需要输入下方的数据库信息。
	数据库类型	选择MongoDB。
	接入方式	选择云实例。
	实例地区	选择目标云数据库MongoDB版所属地域。
	架构类型	选择目标云数据库MongoDB版所属的架构类型。
	实例ID	选择目标云数据库MongoDB版实例ID。
	鉴权数据库名称	填入目标云数据库MongoDB版实例数据库账号所属的数据库名称，若未修改过则默认为admin。
	数据库账号	填入目标云数据库MongoDB版的数据库账号，需具备dbAdminAnyDatabase权限、目标库的readWrite权限和local库的read权限。
	数据库密码	填入该数据库账号对应的密码。

配置完成后，单击页面下方的测试连接以进行下一步。
如果源或目标数据库是阿里云数据库实例（例如RDS MySQL、云数据库MongoDB版等），DTS会自动将对应地区DTS服务的IP地址添加到阿里云数据库实例的白名单中；如果源或目标数据库是ECS上的自建数据库，DTS会自动将对应地区DTS服务的IP地址添到ECS的安全规则中，您还需确保自建数据库没有限制ECS的访问（若数据库是集群部署在多个ECS实例，您需要手动将DTS服务对应地区的IP地址添到其余每个ECS的安全规则中）；如果源或目标数据库是IDC自建数据库或其他云数据库，则需要您手动添加对应地区DTS服务的IP地址，以允许来自DTS服务器的访问。DTS服务的IP地址，请参见DTS服务器的IP地址段。
警告
DTS自动添加或您手动添加DTS服务的公网IP地址段可能会存在安全风险，一旦使用本产品代表您已理解和确认其中可能存在的安全风险，并且需要您做好基本的安全防护，包括但不限于加强账号密码强度防范、限制各网段开放的端口号、内部各API使用鉴权方式通信、定期检查并限制不需要的网段，或者使用通过内网（专线/VPN网关/智能网关）的方式接入。

配置任务对象及高级配置。

配置	说明
同步类型	固定选中增量同步。默认情况下，您还需要同时选中库表结构同步和全量同步。预检查完成后，DTS会将源实例中待同步对象的全量数据在目标集群中初始化，作为后续增量同步数据的基线数据。
同步拓扑	请选择单向同步。
目标已存在表的处理模式	预检查并报错拦截：检查目标数据库中是否有同名的集合。如果目标数据库中没有同名的集合，则通过该检查项目；如果目标数据库中有同名的集合，则在预检查阶段提示错误，数据同步任务不会被启动。说明如果目标库中同名的集合不方便删除或重命名，您可以更改该集合在目标库中的名称，详情请参见设置同步对象在目标实例中的名称。忽略报错并继续执行：跳过目标数据库中是否有同名集合的检查项。警告选择为忽略报错并继续执行，可能导致数据不一致，给业务带来风险，例如：在目标库遇到与源库主键或唯一键的值相同的记录，则会保留目标库中的该条记录，即源库中的该条记录不会同步至目标库中。可能会导致无法初始化数据、只能同步部分的数据或同步失败。
目标库对象名称大小写策略	您可以配置目标实例中同步对象的库名、表名和列名的英文大小写策略。默认情况下选择DTS默认策略，您也可以选择与源库、目标库默认策略保持一致。更多信息，请参见目标库对象名称大小写策略。
源库对象	在源库对象框中单击待同步对象，然后单击将其移动至已选择对象框。说明同步对象的选择粒度为DATABASE、COLLECTION。
已选择对象	如需更改单个同步对象在目标实例中的名称，请右击已选择对象中的同步对象，设置方式，请参见库表列名单个映射。如需批量更改同步对象在目标实例中的名称，请单击已选择对象方框右上方的批量编辑，设置方式，请参见库表列名批量映射。

单击下一步高级配置，进行高级配置。

数据校验配置
若您需要配置数据校验，请参见配置数据校验。

高级配置

配置	说明
选择调度该任务的专属集群	DTS默认将任务调度到共享集群上，您无需选择。若您希望任务更加稳定，可以购买专属集群来运行DTS同步任务。更多信息，请参见什么是DTS专属集群。
源库、目标库无法连接后的重试时间	在同步任务启动后，若源库或目标库连接失败则DTS会报错，并会立即进行持续的重试连接，默认持续重试时间为720分钟，您也可以在取值范围（10~1440分钟）内自定义重试时间，建议设置30分钟以上。如果DTS在设置的重试时间内重新连接上源库、目标库，同步任务将自动恢复。否则，同步任务将会失败。说明针对同源或者同目标的多个DTS实例，如DTS实例A和DTS实例B，设置网络重试时间时A设置30分钟，B设置60分钟，则重试时间以低的30分钟为准。由于连接重试期间，DTS将收取任务运行费用，建议您根据业务需要自定义重试时间，或者在源和目标库实例释放后尽快释放DTS实例。
源库、目标库出现其他问题后的重试时间	在同步任务启动后，若源库或目标库出现非连接性的其他问题（如DDL或DML执行异常），则DTS会报错并会立即进行持续的重试操作，默认持续重试时间为10分钟，您也可以在取值范围（1~1440分钟）内自定义重试时间，建议设置10分钟以上。如果DTS在设置的重试时间内相关操作执行成功，同步任务将自动恢复。否则，同步任务将会失败。重要源库、目标库出现其他问题后的重试时间的值需要小于源库、目标库无法连接后的重试时间的值。
是否限制全量迁移速率	在全量同步阶段，DTS将占用源库和目标库一定的读写资源，可能会导致数据库的负载上升。您可以根据实际情况，选择是否对全量同步任务进行限速设置（设置每秒查询源库的速率QPS、每秒全量迁移的行数RPS和每秒全量迁移的数据量(MB)BPS），以缓解目标库的压力。说明仅当同步类型选择了全量同步时才可以配置。
是否限制增量同步速率	您也可以根据实际情况，选择是否对增量同步任务进行限速设置（设置每秒增量同步的行数RPS和每秒增量同步的数据量(MB)BPS），以缓解目标库的压力。
环境标签	您可以根据实际情况，选择用于标识实例的环境标签。本示例无需选择。
配置ETL功能	选择是否配置ETL功能。关于ETL的更多信息，请参见什么是ETL。是：配置ETL功能，并在文本框中填写数据处理语句，详情请参见在DTS迁移或同步任务中配置ETL。否：不配置ETL功能。
监控告警	是否设置告警，当同步失败或延迟超过阈值后，将通知告警联系人。不设置：不设置告警。设置：设置告警，您还需要设置告警阈值和告警通知。更多信息，请参见在配置任务过程中配置监控报警。

保存任务并进行预检查。
- 若您需要查看调用API接口配置该实例时的参数信息，请将鼠标光标移动至下一步保存任务并预检查按钮上，然后单击气泡中的预览OpenAPI参数。
- 若您无需查看或已完成查看API参数，请单击页面下方的下一步保存任务并预检查。
说明
- 在同步作业正式启动之前，会先进行预检查。只有预检查通过后，才能成功启动同步作业。
- 如果预检查失败，请单击失败检查项后的查看详情，并根据提示修复后重新进行预检查。
- 如果预检查产生警告：
  对于不可以忽略的检查项，请单击失败检查项后的查看详情，并根据提示修复后重新进行预检查。
  对于可以忽略无需修复的检查项，您可以依次单击点击确认告警详情、确认屏蔽、确定、重新进行预检查，跳过告警检查项重新进行预检查。如果选择屏蔽告警检查项，可能会导致数据不一致等问题，给业务带来风险。
预检查通过率显示为100%时，单击下一步购买。

在购买页面，选择数据同步实例的计费方式、链路规格，详细说明请参见下表。

类别	参数	说明
信息配置	计费方式	预付费（包年包月）：在新建实例时支付费用。适合长期需求，价格比按量付费更实惠，且购买时长越长，折扣越多。后付费（按量付费）：按小时扣费。适合短期需求，用完可立即释放实例，节省费用。
	资源组配置	实例所属的资源组，默认为default resource group。更多信息，请参见什么是资源管理。
	链路规格	DTS为您提供了不同性能的同步规格，同步链路规格的不同会影响同步速率，您可以根据业务场景进行选择。更多信息，请参见数据同步链路规格说明。
	订购时长	在预付费模式下，选择包年包月实例的时长和数量，包月可选择1~9个月，包年可选择1年、2年、3年和5年。说明该选项仅在付费类型为预付费时出现。

配置完成后，阅读并勾选《数据传输（按量付费）服务条款》。
单击购买并启动，同步任务正式开始，您可在数据同步界面查看具体任务进度。