Partition-Based Sync - Kotlin SDK

valor de la partición

Cuando se selecciona Partition-Based Sync para la configuración de la aplicación de backend, la implementación del cliente debe incluir un valor de la partición. Este es el valor del campo clave de partición que se selecciona al configurar la Partition-Based Sync.

El valor de la partición determina a qué datos puede acceder la aplicación cliente.

You must provide a partition value when you open a synced realm.

Open a Partition-Based Sync Realm

Para abrir un dominio de sincronización basada en particiones, pase un usuario, una partición y un conjunto de esquemas de objetos de dominio a SyncConfiguration.Builder(). Luego, pase la configuración a Realm.open() para abrir una instancia del dominio:

val app = App.create(YOUR_APP_ID)
runBlocking {
    val user = app.login(Credentials.anonymous())
    val config =
        SyncConfiguration.Builder(user, PARTITION, setOf(/*realm object models here*/))
            // specify name so realm doesn't just use the "default.realm" file for this user
            .name(PARTITION)
            .build()
    val realm = Realm.open(config)
    Log.v("Successfully opened realm: ${realm.configuration.name}")
    realm.close()
}

Configure a Partition-Based Sync Realm

To adjust specific configuration settings, use the options provided by SyncConfiguration.Builder:

val app = App.create(YOUR_APP_ID)
runBlocking {
    val user = app.login(Credentials.anonymous())
    val config =
        SyncConfiguration.Builder(user, PARTITION, setOf(/*realm object models here*/))
            .maxNumberOfActiveVersions(10)
            .waitForInitialRemoteData()
            .name("realm name")
            .build()
    val realm = Realm.open(config)
    Log.v("Successfully opened realm: ${realm.configuration}")
    realm.close()
}

Consulta el progreso de carga y descarga para una sesión de sincronización

You can monitor the upload and download progress of a sync session. The sync session starts when you open a synced realm. For more information, refer to Manage a Sync Session.

To monitor Sync upload and download progress, call SyncSession.progressAsFlow()

This method returns a Flow of Progress events. Progress provides the total number of transferrable bytes and the remaining bytes to be transferred.

syncSession.progressAsFlow() toma dos argumentos:

• A Direction enum that can be set to UPLOAD or DOWNLOAD. This specifies that the progress stream tracks uploads or downloads.

• Un enum ProgressMode que puede configurarse como:

  • INDEFINITELY: Sets notifications to continue until the callback is unregistered.

  • CURRENT_CHANGES: Establece que las notificaciones continúen hasta que solo se sincronicen los bytes actualmente transferibles.

val stream = realm.syncSession.progressAsFlow(
    Direction.UPLOAD, ProgressMode.CURRENT_CHANGES
)
stream.collect { progress ->
    if (progress.transferableBytes == progress.transferredBytes) {
        Log.i("Upload complete")
    }
}

Migrate from Partition-Based Sync to Flexible Sync

Puedes migrar tu App Services Device Sync Mode de Partition-Based Sync a Flexible Sync. La migración es un proceso automático que no requiere ningún cambio en el código de tu aplicación. La migración automática requiere la versión 1.9.0 o superior del SDK de Realm Kotlin.

Migrating enables you to keep your existing App Services users and authentication configuration. Flexible Sync provides more versatile permissions configuration options and more granular data synchronization.

For more information about how to migrate your App Services App from Partition-Based Sync to Flexible Sync, refer to Migrate Device Sync Modes.