A newer version of this documentation is available.

View Latest

Data Sync Locally on Device

      +

      Description — Couchbase Lite Database Sync - Synchronize changes between databases on the same device
      Related Content — Remote Sync Gateway | Peer-to-Peer Sync

      Overview

      Couchbase Lite supports replication between two local databases. This allows a Couchbase Lite replicator to store data on secondary storage. It is especially useful in scenarios where a user’s device may be damaged and its data moved to a different device.

      Example 1. Replication between Local Databases
      • Kotlin

      • Java

      val repl = Replicator(
          ReplicatorConfigurationFactory.create(
              database = database1,
              target = DatabaseEndpoint(database2),
              type = ReplicatorType.PULL
          )
      )
      
      // Create replicator (be sure to hold a reference somewhere that will prevent the Replicator from being GCed)
      repl.start()
      replicator = repl
      DatabaseEndpoint targetDatabase = new DatabaseEndpoint(database2);
      ReplicatorConfiguration replicatorConfig = new ReplicatorConfiguration(database1, targetDatabase);
      replicatorConfig.setReplicatorType(ReplicatorConfiguration.ReplicatorType.PUSH);
      
      // Create replicator (be sure to hold a reference somewhere that will prevent the Replicator from being GCed)
      replicator = new Replicator(replicatorConfig);
      replicator.start();