This documentation is archived and is not being maintained.

How to: Initiate Synchronization Between Local and Remote Databases

After you add a Local Database Cache and provide configuration information in the Configure Data Synchronization dialog box, you must still add code to your application to actually synchronize the local and remote databases. Initiate synchronization by calling the Synchronize method of a SyncAgent.

It is important to understand that synchronization only synchronizes the data between the remote data and the local database (.sdf). The data in your application still has to be reloaded from the database. Remember to reload your application data source with the updated data from the local database. For example, call the TableAdapter.Fill method to load your dataset's data table with the updated data from the local database.

The Configure Data Synchronization dialog box includes a Show Code Example link that provides a code example with the correct syntax for calling the Synchronize method. Include this code example anywhere in the application where synchronization has to be performed.


Your computer might show different names or locations for some of the Visual Studio user interface elements in the following instructions. The Visual Studio edition that you have and the settings that you use determine these elements. For more information, see Visual Studio Settings.

To initiate synchronization between the local and remote databases

  1. Double-click the .sync file in Solution Explorer to open the Configure Data Synchronization dialog box.

  2. Click the Show Code Example link in the Configure Data Synchronization dialog box.

  3. Click Copy code to the clipboard and then click Close.

  4. Paste the code example that you copied in the previous step into your application. Paste it where you want to initiate the synchronization call. The following code shows how to initiate synchronization for an application configured to synchronize the Northwind customers table:

    // Call SyncAgent.Synchronize() to initiate the synchronization process. 
    // Synchronization updates only the local database, not your project's data source.
    NorthwindCacheSyncAgent syncAgent = new NorthwindCacheSyncAgent();
    Microsoft.Synchronization.Data.SyncStatistics syncStats = syncAgent.Synchronize();
    // TODO: Reload your project data source from the local database. (For example, call the TableAdapter.Fill method.)
  5. After synchronizing, add code to repopulate the data source in your application with the data in the synchronized local database.