Partition-Based Sync - Java SDK

Open a Synced Realm While Online

Para abrir un dominio sincronizado, llame a getInstanceAsync() y pase un objeto SyncConfiguration. El siguiente código muestra cómo crear un dominio con configuraciones de sincronización específicas creadas con un SyncConfiguration objeto:

SyncConfiguration config = new SyncConfiguration.Builder(app.currentUser(), PARTITION)
        .allowQueriesOnUiThread(true)
        .allowWritesOnUiThread(true)
        .build();
Realm.getInstanceAsync(config, new Realm.Callback() {
    @Override
    public void onSuccess(Realm realm) {
        Log.v(
                "EXAMPLE",
                "Successfully opened a realm with reads and writes allowed on the UI thread."
        );
    }
});

val config = SyncConfiguration.Builder(app.currentUser(), PARTITION)
    .allowQueriesOnUiThread(true)
    .allowWritesOnUiThread(true)
    .build()
Realm.getInstanceAsync(config, object : Realm.Callback() {
    override fun onSuccess(realm: Realm) {
        Log.v("EXAMPLE", "Successfully opened a realm with reads and writes allowed on the UI thread.")
    }
})

El código anterior muestra cómo abrir el realm asincrónicamente usando getInstanceAsync(). También puedes abrir un realm de forma síncrona utilizando getInstance(), el cual retorna un realm abierto antes de sincronizar todos los datos desde el backend. Sin embargo, esto puede generar inconsistencias temporales en los datos mientras se descargan los datos remotos y, en general, no se recomienda. Puedes usar la opción de configuración waitForInitialRemoteData() para forzar al SDK a recuperar datos remotos antes de abrir el realm y evitar estas inconsistencias.

El valor de la partición especifica qué subconjunto de tus datos se debe sincronizar. Por lo general, se trata de un ID de usuario, ID del grupo, ID de tienda u otro identificador de categoría en tu aplicación que resulte especialmente relevante para el usuario actual.

Open a Synced Realm While Offline

Puedes abrir un Realm sincronizado sin conexión con la misma sintaxis exacta que utilizas para abrir un Realm sincronizado en linea. No todos los SDK siguen este patrón, así que los desarrolladores multiplataforma deben consultar la documentación de cada SDK para obtener más información.

Actualizar el código de cliente después de la migración

The automatic migration from Partition-Based Sync to Flexible Sync does not require any changes to your client code. However, to support this functionality, Realm automatically handles the differences between the two Sync Modes by:

• Automatically creating Flexible Sync subscriptions for each object type where partitionKey == partitionValue.

• Inyectar un campo partitionKey en cada objeto si aún no existe uno. Esto es necesario para la suscripción automática de Flexible Sync.

Si necesitas realizar actualizaciones en el código cliente después de la migración, considera actualizar tu base de código cliente para remover funcionalidades ocultas de migración. Tal vez quieras actualizar tu base de código de cliente cuando:

• Agregue un nuevo modelo o cambie un modelo en su base de código de cliente.

• You add or change functionality that involves reading or writing Realm objects

• Quieres implementar un control más específico sobre los datos que sincronizas

Make these changes to convert your Partition-Based Sync client code to use Flexible Sync:

• Actualiza tu SyncConfiguration.Builder para usar Flexible Sync. Esto implica remover el partitionValue y agregar un conjunto de suscripciones iniciales, si es necesario.

• Agrega propiedades relevantes a tus modelos de objetos para usarlas en tus suscripciones de Flexible Sync. Por ejemplo, podrías agregar una propiedad ownerId para permitir que un usuario sincronice solo sus propios datos.

• Remover suscripciones automáticas de Flexible Sync. Si no añadiste suscripciones iniciales en el SyncConfiguration.Builder, debes crear manualmente las suscripciones relevantes.

For examples of Flexible Sync permissions strategies, including examples of how to model data for these strategies, refer to Device Sync Permissions Guide.