Configurar e Ativar Atlas Device Sync

Navegue até a tela de configuração do Device Sync

Para habilitar o Device Sync para seu aplicação, navegue até a tela de configuração do Device Sync através do menu de navegação esquerdo.

Especifique suas configurações de Sync

Siga as instruções para configurar o Device Sync Para obter detalhes sobre as configurações disponíveis, consulte Configurações de Sync.

Ativar sincronização

Clique em Enable Sync, anote todas as recomendações que aparecerem e confirme sua escolha.

Autenticar um usuário do MongoDB Atlas

Use sua chave de API Admin do MongoDB Atlas para fazer login na CLI:

appservices login --api-key="<my api key>" --private-api-key="<my private api key>"

Obtenha a versão mais recente da sua aplicação

Obtenha uma cópia local dos arquivos de configuração do seu aplicativo. Para obter a versão mais recente do seu aplicativo, execute o seguinte comando:

appservices pull --remote="<Your App ID>"

Você também pode exportar uma cópia dos arquivos de configuração do aplicativo da interface do usuário ou com a API Admin. Para saber como, consulte Exporte um aplicativo.

Adicionar uma configuração de sincronização

Você pode habilitar a sincronização para um único cluster vinculado em seu aplicativo. Se ainda não tiver vinculado o cluster ao seu aplicativo, siga primeiro o guia Vincule uma fonte de dados.

O aplicativo App Services tem um diretório sync onde você pode encontrar o arquivo de configuração de sincronização. Se você ainda não tiver ativado o Sync, esse diretório estará vazio.

Adicione um config.json semelhante a:

{
  "type": "flexible",
  "development_mode_enabled": <Boolean>,
  "service_name": "<Data Source Name>",
  "database_name": "<Development Mode Database Name>",
  "state": <"enabled" | "disabled">,
  "client_max_offline_days": <Number>,
  "is_recovery_mode_disabled": <Boolean>,
  "indexed_queryable_fields_names": <Array of String Field Names>,
  "queryable_fields_names": <Array of String Field Names>,
  "collection_queryable_fields_names": <Map[String][]String>
}

Consulte a Referência do arquivo de configuração de sincronização para mais informações.

Implemente a configuração de sincronização

Implante suas alterações para começar a sincronizar dados. Importe a configuração do seu aplicativo:

appservices push --remote="<Your App ID>"

Selecione um cluster para sincronizar

Você pode ativar o Realm Mobile Sync para um único cluster vinculado em sua aplicação. Se você ainda não vinculou o cluster à sua aplicação, siga o guia Vincular um conjunto de dados .

Você precisará do arquivo de configuração de serviço do cluster para configurar a sincronização. Você pode encontrar o arquivo de configuração listando todos os serviços por meio da API de administrador:

curl https://services.cloud.mongodb.com/api/admin/v3.0/groups/{GROUP_ID}/apps/{APP_ID}/services \
  -X GET \
  -h 'Authorization: Bearer <Valid Access Token>'

Identifique o cluster cuja configuração você precisa atualizar para habilitar a sincronização. Se você aceitou os nomes padrão ao configurar seu aplicativo, ele deverá ser um cluster cujo name seja mongodb-atlas e type seja mongodb-atlas. Você precisa do _id deste cluster.

Agora você pode obter o arquivo de configuração do serviço para este cluster:

curl https://services.cloud.mongodb.com/api/admin/v3.0/groups/{GROUP_ID}/apps/{APP_ID}/services/{MongoDB_Service_ID}/config \
  -X GET \
  -h 'Authorization: Bearer <Valid Access Token>'

Para configurar a sincronização, adicionaremos um objeto flexible_sync a essa configuração em uma etapa a seguir.

Habilitar modo de desenvolvimento (opcional)

Se você quiser ativar o Modo de desenvolvimento para simplificar a produção, use o seguinte comando:

curl https://services.cloud.mongodb.com/api/admin/v3.0/groups/{GROUP_ID}/apps/{APP_ID}/sync/config \
  -X PUT \
  -h 'Authorization: Bearer <Valid Access Token>' \
  -h "Content-Type: application/json" \
  -d '{"development_mode_enabled": true}'

Adicione e implemente a configuração de sincronização

Para implantar suas alterações e começar a sincronizar dados, envie uma solicitação de API Admin que atualize a configuração do cluster com um objeto flexible_sync usando a seguinte configuração de modelo:

curl https://services.cloud.mongodb.com/api/admin/v3.0/groups/{GROUP_ID}/apps/{APP_ID}/services/{MongoDB_Service_ID}/config \
  -X PATCH \
  -h 'Authorization: Bearer <Valid Access Token>' \
  -h "Content-Type: application/json" \
  -d '<Flexible Sync Configuration>'

{
  "flexible_sync": {
    "state": "enabled",
    "database_name": "<Name of Database>",
    "client_max_offline_days": <Number>,
    "is_recovery_mode_disabled": <Boolean>,
    "indexed_queryable_fields_names": <Array of String Field Names>,
    "queryable_fields_names": <Array of String Field Names>,
    "collection_queryable_fields_names": <Map[String][]String>
  }
}

Para obter detalhes sobre a configuração de sincronização, consulte a Referência do arquivo de configuração de sincronização.

Você pode confirmar que a configuração de sincronização foi adicionada obtendo a configuração do serviço novamente, conforme descrito na etapa 1.