start

州

要使用start端点， mongosync必须处于IDLE状态。

权限

mongosync 连接string中指定的用户必须对源集群和目标集群具有所需的权限。 请参阅用户权限，确保用户具有启动同步的正确权限。

多个mongosync 实例

确保在启动mongosync时，使用在cluster0或cluster1设置的连接字符串中配置的mongosync用户。

请求正文参数

db.adminCommand( { setUserWriteBlockMode: 1, global: false } )

分片参数

要将副本集同步到分片集群，请将sharding选项设置为目标集群上的collection。

sharding选项具有以下参数：

mongosync 从副本集同步到分片集群时，如果未设置sharding选项，则会引发错误。 如果将sharding选项与任何其他配置一起设置， mongosync也会引发错误。

启动同步作业

以下示例在cluster0和cluster1之间启动同步作业。 源集群为cluster0 ，目标集群为cluster1 。

请求：

curl localhost:27182/api/v1/start -XPOST \
--data '
   {
      "source": "cluster0",
      "destination": "cluster1"
   } '

响应：

{"success":true}

启动可逆同步作业

以下示例在cluster0和cluster1之间启动同步作业。 源集群为cluster0 ，目标集群为cluster1 。

reversible和enableUserWriteBlocking字段允许反向同步。 要反转同步方向，请参阅：反向。

请求：

curl localhost:27182/api/v1/start -XPOST \
--data '
   {
      "source": "cluster0",
      "destination": "cluster1",
      "reversible": true,
      "enableUserWriteBlocking": true
   } '

响应：

{"success":true}

启动筛选的同步作业

以下示例在cluster0和cluster1之间启动同步作业。 源集群为cluster0 ，目标集群为cluster1 。

cluster0 包含sales 、 marketing和engineering数据库。

sales 数据库包含 EMEA、APAC 和 AMER 集合。

此示例中的 includeNamespaces 数组定义了两个数据库 sales 和 marketing 上的筛选器。

sales 数据库还会对 EMEA 和 APAC 集合进行过滤。

"includeNamespaces" : [
      {
          "database" : "sales",
          "collections": [ "EMEA", "APAC" ]
      },
      {
          "database" : "marketing"
      }
   ]

使用此过滤器调用 /start API 后，mongosync：

• 同步 marketing 数据库中的所有集合

• 滤除 engineering 数据库

• 同步 sales 数据库中的 EMEA 和 APAC 集合

• 滤除 AMER 集合

includeNamespaces选项会创建一个筛选器。 要筛选同步，请参阅：筛选的同步

请求：

curl -X POST "http://localhost:27182/api/v1/start" --data '
   {
      "source": "cluster0",
      "destination": "cluster1",
      "includeNamespaces": [
         {
             "database": "sales",
             "collectionsRegex": {
                "pattern": "^accounts_.+$",
                "options": "i"
             }
         }, {
            "database": "marketing"
         }
      ]
   } '

响应：

{"success":true}

开始从副本集同步到分片集群

请求：

curl localhost:27182/api/v1/start -XPOST \
--data '
   {
      "source": "cluster0",
      "destination": "cluster1",
      "sharding": {
         "createSupportingIndexes": true,
         "shardingEntries": [
            {
                "database": "accounts",
                "collection": "us_east",
                "shardCollection": {
                   "key": [
                      { "location": 1 },
                      { "region": 1 },
                   ]
                }
            }
         ]
      }
   } '

响应：

{"success":true}

从禁用验证器的情况下启动

从 1.9 开始，开始迁移时默认运行嵌入式验证程序。如需禁用，请将 verification.enabled设立为 false。

请求：

curl localhost:27182/api/v1/start -XPOST \
--data '
   {
      "source": "cluster0",
      "destination": "cluster1",
      "verification": {
         "enabled": false
      }
   } '

响应：

{"success":true}

在将应用程序负载转移到目标集群之前，应验证迁移是否成功。如果出于任何原因需要禁用验证程序，请使用替代方法来验证同步。

嵌入式验证程序

从 1.9 开始，mongosync 提供嵌入式验证器，以确定从源集群到目标的数据传输是否成功。

启用后，验证程序将对目标集群执行一系列验证检查。如果其中任何检查返回错误，则验证程序迁移失败。如果所有检查均成功，mongosync 将转换为 COMMITTED 状态。

要禁用验证程序，请参阅在禁用验证程序的情况下启动。

如果您启用源集群或目标集群不支持的验证检查，或者内存不足，则 /start 端点会返回错误。

州

如果start请求成功， mongosync将进入RUNNING状态。

分片副本集

从副本集同步到分片集群需要sharding选项。 此选项配置mongosync如何对collection进行分片。

sharding.shardingEntries数组指定要分片的collection。未在此数组中列出的collection将复制为未分片。

有关更多信息，请参阅分片集群行为。

支持索引

mongosync 将索引从源集群同步到目标集群。从副本集同步到分分片集群时，mongosync 可能需要额外的索引来支持分分片键，而源集群上可能不存在该索引。

mongosync 可以在同步期间为分片collection创建支持索引。这是通过设置sharding.createSupportingIndexes选项来完成的。

当sharding.createSupportingIndexes为false （默认值）时：

• 您为sharding.shardingEntries选项提供的每个分片键都必须在源集群上具有现有索引。

• 如果集合使用任何其他排序规则，则用于分片键的索引之一必须具有简单排序规则。

• 要在分片键中使用唯一索引，您必须在源集群上创建索引时指定其唯一性。

• 源集群上的唯一索引与目标集群上请求的分片键不兼容，例如源集群上的唯一索引不包含目标集群上请求的分片键作为前缀，可能会导致mongosync失败。

当sharding.createSupportingIndexes为true时：

• 如果源集群上存在支持索引， mongosync会将索引同步到目标集群并将其用作分片键。

• 如果支持索引不存在， mongosync则会在目标集群上创建这些索引。

sharding.createSupportingIndexes选项会影响所有分片collection。

在同步期间重命名

sharding.shardingEntries数组中列出的集合在从副本集同步到分片集群时将成为目标集群上的分片集合。

在调用start之后但mongosync开始复制集合之前，在源集群上重命名集合（例如使用renameCollection命令）可能会阻止该集合在目标上分片。

要检查重命名collection是否安全，请调用progress端点并检查返回文档中collectionCopy.estimatedCopiedBytes字段的值。

• 值为 0 表示mongosync尚未开始复制collection。

  在此点重命名collection可能会导致目标集群上出现未分片的collection，因为可能会在重命名对源生效之前过渡到复制。

• 值大于 0 表示mongosync已开始复制。 从此时开始重命名collection不会阻止其在目标集群上的分片，即使发生事件也是如此。

所需索引

当您在buildIndexes选项设置为never的情况下调用/start时， mongosync会跳过构建不必要的索引。

始终构建的索引包括：

• mongosync 为其复制的每个collection的_id字段构建索引。

• mongosync 为每个没有索引的分分片的集合构建虚拟索引，以支持目标集群上的分分片键。 当buildIndexes设立为never时， mongosync在提交后保留此索引。

端点保护

mongosync 不保护start端点。 但是，默认情况下，该 API 仅绑定到本地主机，不接受来自其他来源的调用。 此外， start调用不会公开连接档案或用户数据。