Home

Awesome

react-native-sync

Two way, incremental sync between React Native realmjs databases and MySQL, Oracle, MS SQL Server and PostgreSQL databases.

Features

Setup

For end-to-end testing, you need to first setup a Pervasync server and publish your central database tables for sync. See Pervasync documentation for instructions.

This library is available on npm, install it with: npm install --save react-native-sync or yarn add react-native-sync.

Usage

  1. Import react-native-sync as RNSync:

    import RNSync from "react-native-sync";
    
  2. Configure RNSync:

    var settings = {
        syncServerUrl: "http://localhost:8080/pervasync/server", // required
        syncUserName: "user_1", // required
        syncUserPassword: "welcome1", // required
    };
    await RNSync.config(settings);
    
  3. Start a sync session:

    let syncSummary = await RNSync.sync();
    
  4. Get a handle to the synced realm database and synced folder path:

    let realm = await RNSync.getRealm(syncSchemaName);
    let path = await RNSync.getPath(syncFolderName);
    

Complete Example

Check out react-native-sync-demo and expecially sync.js