Configurar y habilitar Atlas Device Sync

Navegue a la pantalla de configuración de sincronización del dispositivo

Para habilitar la sincronización de dispositivos para su aplicación, navegue hasta Device Sync Pantalla de configuración a través del menú de navegación izquierdo.

Especifica tu configuración de sincronización

Sigue las instrucciones para configurar la sincronización de dispositivos. Para obtener más información sobre las opciones de configuración disponibles, consulta Ajustes de sincronización.

Activar la sincronización

Haga clic en Enable Sync, tome nota de las recomendaciones que aparecen y luego confirme su elección.

Autenticar un usuario de MongoDB Atlas

Utilice su clave API de administrador de MongoDB Atlas para iniciar sesión en la CLI:

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

Obtenga la última versión de su aplicación

Obtén una copia local de los archivos de configuración de tu aplicación. Para obtener la última versión, ejecuta el siguiente comando:

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

También puedes exportar una copia de los archivos de configuración de tu aplicación desde la interfaz de usuario o con la API de administración. Para saber cómo, consulta Exportar una aplicación.

Agregar una configuración de sincronización

Puede habilitar la sincronización para un solo clúster vinculado en su aplicación. Si aún no ha vinculado el clúster a su aplicación, siga primero la guía Vincular una fuente de datos.

La aplicación Servicios de aplicaciones tiene un sync directorio donde se encuentra el archivo de configuración de sincronización. Si aún no ha habilitado la sincronización, este directorio está vacío.

Añade un config.json similar 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>
}

Para obtener más detalles, consulte la Referencia del archivo de configuración de sincronización.

Implementar la configuración de sincronización

Implementa tus cambios para empezar a sincronizar datos. Importa la configuración de tu aplicación:

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

Seleccione un clúster para sincronizar

Puede habilitar la Sincronización de Dispositivos para un solo clúster vinculado en su aplicación. Si aún no has vinculado el clúster a tu aplicación, siga la guía Vincular una fuente de datos.

Necesitará el archivo de configuración del servicio del clúster para configurar la sincronización. Puede encontrarlo enumerando todos los servicios a través de la API de administración:

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 el clúster cuya configuración necesita actualizar para habilitar la sincronización. Si aceptó los nombres predeterminados al configurar su aplicación, este debería ser un clúster cuyo name sea mongodb-atlas y type sea mongodb-atlas. Necesita el _id de este clúster.

Ahora puede obtener el archivo de configuración de servicio para este clúster:

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 Sync, agregaremos un objeto flexible_sync a esta configuración en el siguiente paso.

Habilitar el modo de desarrollo (opcional)

Si desea habilitar el modo de desarrollo para optimizar la producción, utilice el siguiente 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}'

Agregar e implementar la configuración de sincronización

Para implementar sus cambios y comenzar a sincronizar datos, envíe una solicitud de API de administración que actualice la configuración del clúster con un flexible_sync objeto utilizando la siguiente configuración de plantilla:

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 obtener detalles sobre la configuración de sincronización, consulte la Referencia del archivo de configuración de sincronización.

Puede confirmar que se agregó la configuración de sincronización obteniendo nuevamente la configuración del servicio, como se describe en el Paso 1.