start

Estado

Para utilizar el punto final start, mongosync debe estar en el estado IDLE.

Permisos

El usuario especificado en la cadena de conexión mongosync debe tener los permisos necesarios en los clústeres de origen y destino. Consulte Permisos de usuario para garantizar que el usuario tenga los permisos correctos para iniciar la sincronización.

Varias mongosync instancias

Asegura que uses el usuario mongosync configurado en las cadenas de conexión para la configuración de cluster0 o cluster1 cuando inicies mongosync.

Parámetros del cuerpo de la solicitud

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

Parámetros de partición

Para sincronizar desde un conjunto de réplicas a un clúster fragmentado, configure la opción sharding para fragmentar colecciones en el clúster de destino.

mongosync genera un error si la opción sharding no está configurada al sincronizar desde un conjunto de réplicas a un clúster fragmentado. mongosync también genera un error si la opción sharding está configurada con cualquier otra configuración.

La opción sharding tiene los siguientes parámetros:

Iniciar un trabajo de sincronización

El siguiente ejemplo inicia un trabajo de sincronización entre cluster0 y cluster1. El clúster de origen es cluster0 y el de destino es cluster1.

Pedido:

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

Respuesta:

{"success":true}

Iniciar un trabajo de sincronización reversible

El siguiente ejemplo inicia un trabajo de sincronización entre cluster0 y cluster1. El clúster de origen es cluster0 y el de destino es cluster1.

Los reversible enableUserWriteBlocking campos y permiten invertir la sincronización. Para invertir la dirección de la sincronización, consulte: invertir.

Pedido:

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

Respuesta:

{"success":true}

Iniciar un trabajo de sincronización filtrado

El siguiente ejemplo inicia un trabajo de sincronización entre cluster0 y cluster1. El clúster de origen es cluster0 y el de destino es cluster1.

cluster0 contiene las bases de datos sales, marketing y engineering.

La base de datos sales contiene las colecciones EMEA, APAC y AMER.

La matriz includeNamespaces en este ejemplo define un filtro en dos de las bases de datos, sales y marketing.

La base de datos sales también filtra las colecciones EMEA y APAC.

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

Después de llamar a la API /start con este filtro implementado, mongosync:

• Sincroniza todas las colecciones en la base de datos marketing

• Filtra la base de datos engineering

• Sincroniza las colecciones EMEA y APAC de la base de datos sales

• Filtra la colección AMER

La includeNamespaces opción crea un filtro. Para filtrar la sincronización, consulte: Sincronización filtrada

Pedido:

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

Respuesta:

{"success":true}

Iniciar sincronización desde el conjunto de réplicas al clúster fragmentado

Pedido:

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 }
                   ]
                }
            }
         ]
      }
   } '

Respuesta:

{"success":true}

Comience con el verificador deshabilitado

A partir de 1.9, el verificador integrado se ejecuta de forma predeterminada al iniciar una migración. Si necesita desactivarlo, configure verification.enabled en false.

Pedido:

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

Respuesta:

{"success":true}

Debe verificar que la migración se haya realizado correctamente antes de transferir la carga de su aplicación al clúster de destino. Si necesita deshabilitar el verificador por cualquier motivo, utilice un método alternativo para verificar la sincronización.

Verificador integrado

A partir de 1.9, mongosync proporciona un verificador integrado para determinar si la transferencia de datos desde el clúster de origen al destino fue exitosa.

Cuando está habilitado, el verificador realiza una serie de comprobaciones en el clúster de destino. Si alguna de estas comprobaciones devuelve un error, el verificador falla la migración. Si todas las comprobaciones son correctas, mongosync pasa al estado COMMITTED.

Para deshabilitar el verificador, consulte Comenzar con el verificador deshabilitado.

El punto final /start devuelve un error si habilita comprobaciones de verificación que no son compatibles con el clúster de origen o destino o si no hay suficiente memoria.

Estado

Si la solicitud start es exitosa, mongosync ingresa al estado RUNNING.

Conjuntos de réplicas de fragmentos

La sincronización desde un conjunto de réplicas a un clúster fragmentado requiere la opción sharding. Esta opción configura cómo mongosync fragmenta las colecciones.

La matriz sharding.shardingEntries especifica las colecciones que se fragmentarán. Las colecciones que no aparecen en esta matriz se replican como no fragmentadas.

Para obtener más información, consulta Comportamiento de clúster particionado.

Índices de apoyo

mongosync Sincroniza los índices del clúster de origen con el de destino. Al sincronizar desde un conjunto de réplicas a un clúster fragmentado, mongosync podría requerir un índice adicional para admitir la clave de fragmentación, que podría no existir en el clúster de origen.

mongosync Se pueden crear índices de soporte para colecciones fragmentadas durante la sincronización. Esto se realiza configurando la opción sharding.createSupportingIndexes.

Cuando sharding.createSupportingIndexes es false (el valor predeterminado):

• Cada clave de fragmento que proporcione para la opción sharding.shardingEntries debe tener un índice existente en el clúster de origen.

• Uno de los índices utilizados para la clave del fragmento debe tener una intercalación simple si la colección utiliza cualquier otra intercalación.

• Para utilizar un índice único en la clave de fragmento, debe especificar su singularidad cuando crea el índice en el clúster de origen.

• Los índices únicos en el clúster de origen que son incompatibles con la clave de fragmento solicitada en el clúster de destino, como un índice único en el origen que no contiene la clave de fragmento solicitada como prefijo en el destino, pueden provocar que mongosync falle.

Cuando sharding.createSupportingIndexes es true:

• Si los índices de soporte existen en el clúster de origen, mongosync sincroniza los índices con el clúster de destino y los utiliza como claves de fragmento.

• Si los índices de soporte no existen, mongosync los crea en el clúster de destino.

La opción sharding.createSupportingIndexes afecta a todas las colecciones fragmentadas.

Cambiar el nombre durante la sincronización

Las colecciones listadas en el arreglo sharding.shardingEntries al sincronizarse de un set de réplicas a un clúster, se convierten en colecciones particionadas en el clúster de destino.

Cambiar el nombre de una colección (por ejemplo, con el comando) en el clúster de origen después de renameCollection llamar start a pero antes de que mongosync comience a copiar la colección puede impedir que la colección se fragmente en el destino.

Para comprobar si es seguro progress cambiar el nombre de las colecciones, llame al punto final y verifique el valor del collectionCopy.estimatedCopiedBytes campo en el documento de retorno.

• Un valor de 0 indica que mongosync no ha comenzado a copiar la colección.

  Cambiar el nombre de una colección en este punto puede generar una colección sin fragmentar en el clúster de destino, ya que la transición a la copia puede ocurrir antes de que el cambio de nombre tenga efecto en el origen.

• Un valor mayor que 0 indica que mongosync ha iniciado la copia. Cambiar el nombre de la colección a partir de este momento no bloquea su fragmentación en el clúster de destino, incluso en caso de fallo.

Índices requeridos

Cuando llama a /start con la opción buildIndexes establecida en never, mongosync omite la creación de índices innecesarios.

Los índices que siempre se construyen incluyen:

• mongosync construye un índice en el campo _id de cada colección que copia.

• mongosync Crea índices ficticios para cada colección fragmentada que no tenga un índice compatible con la clave de fragmento en el clúster de destino. Cuando buildIndexes se establece en never, mongosync conserva este índice después de la confirmación.

Protección de endpoints

mongosync No protege el punto final start. Sin embargo, por defecto, la API se vincula únicamente al host local y no acepta llamadas de otras fuentes. Además, la llamada start no expone las credenciales de conexión ni los datos del usuario.