start

Estado

Para usar o endpoint start , mongosync deve estar no estado IDLE .

Permissões

O usuário especificado na string de conexão mongosync deve ter as permissões necessárias nos clusters de origem e destino. Consulte Permissões do usuário para garantir que o usuário tenha as permissões corretas para iniciar a sincronização.

mongosync Várias instâncias de

Certifique-se de usar o usuário mongosync configurado nas connection strings para as configurações cluster0 ou cluster1 ao iniciar mongosync.

Parâmetros do corpo da solicitação

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

Parâmetros de fragmentação

Para sincronizar de um conjunto de réplicas para um cluster fragmentado, defina a opção sharding para fragmentar coleções no cluster de destino.

mongosync exibe um erro se a opção sharding não estiver definida ao sincronizar de um conjunto de réplicas para um cluster fragmentado. mongosync também apresenta um erro se a opção sharding estiver definida com qualquer outra configuração.

A opção sharding tem os seguintes parâmetros:

Solicitar

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

Resposta

{"success":true}

Solicitar

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

Resposta

{"success":true}

Solicitar

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

Resposta

{"success":true}

Solicitar

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

Resposta

{"success":true}

Estado

Se a solicitação start for bem-sucedida, mongosync entrará no estado RUNNING .

Fragmentar conjuntos de réplicas

A sincronização de um conjunto de réplicas para um cluster fragmentado requer a opção sharding . Esta opção configura como mongosync fragmenta a collection.

A matriz sharding.shardingEntries especifica as coleções a serem fragmentadas. As collection que não estão listadas nesta matriz replicam como não fragmentadas.

Para obter mais informações, consulte Comportamento de cluster fragmentado.

Índices de apoio

mongosync sincroniza índices do cluster de origem para o cluster de destino. Mas, ao sincronizar de um conjunto de réplicas para um cluster fragmentado, o mongosync pode exigir um índice adicional para suportar a chave do fragmento, que pode não existir no cluster de origem.

mongosync pode criar índices de suporte para collection fragmentadas durante a sincronização. Isso é feito definindo a opção sharding.createSupportingIndexes .

Quando sharding.createSupportingIndexes é false (o padrão):

• Cada chave de shard fornecida para a opção sharding.shardingEntries deve ter um índice existente no cluster de origem.

• Um dos índices usados para a chave de shard deve ter agrupamento simples se a collection usar qualquer outro agrupamento.

• Para usar um índice único na chave de fragmento, você deve especificar sua exclusividade ao criar o índice no cluster de origem.

• Índice único no cluster de origem que são incompatíveis com a chave de shard solicitada no cluster de destino, como um índice único na origem que não contém a chave de shard solicitada como prefixo no destino, podem fazer com que mongosync falhe.

Quando sharding.createSupportingIndexes é true:

• Se os índices de suporte existirem no cluster de origem, o mongosync sincronizará os índices com o cluster de destino e os utilizará como chaves de shard.

• Se os índices de suporte não existirem, o mongosync os criará no cluster de destino.

A opção sharding.createSupportingIndexes afeta todas as collection fragmentadas.

Renomear durante a sincronização

As collection listadas na matriz sharding.shardingEntries , quando sincronizadas de um conjunto de réplicas para um cluster fragmentado, tornam-se collection no cluster de destino.

Renomear uma coleção (como com o comando renameCollection ) no cluster de origem depois de chamar start , mas antes mongosync começar a copiar a coleção pode bloquear a fragmentação da coleção no destino.

Para verificar se é seguro renomear as coleções, chame o endpoint progress e verifique o valor do campo collectionCopy.estimatedCopiedBytes no documento de retorno.

• Um valor de 0 indica que mongosync não começou a copiar a collection.

  Renomear uma coleção nesse ponto pode resultar em uma coleção não fragmentada no cluster de destino, pois a transição para a cópia pode acontecer antes que a renomeação entre em vigor na origem.

• Um valor maior que 0 indica que mongosync iniciou a cópia. Renomear a collection a partir desse ponto não bloqueia sua fragmentação no cluster de destino, mesmo em caso de falha.

Índices exigidos

Quando você chama /start com a opção buildIndexes definida como never, mongosync ignora a criação de índices desnecessários.

Os índices que são sempre construídos incluem:

• mongosync constrói um índice no campo _id de cada collection que copia.

• mongosync cria índices fictícios para cada coleção fragmentada que não tem um índice para dar suporte à chave de shard no cluster de destino. Quando buildIndexes está definido como never, mongosync retém esse índice após o commit.

Proteção de endpoint

mongosync não protege o endpoint start . No entanto, por padrão, a API é vinculada apenas ao host local e não aceita chamadas de outras fontes. Além disso, a chamada start não expõe credenciais de conexão ou dados de usuário.