Microsoft Sync Framework

UPDATED RELEASE: File Sync with Simple Custom Provider Sample (Nov 23, 2009)

Mon, 23 Nov 2009 20:06:53 GMT

This sample demonstrates how to write a simple custom synchronization provider and use it to synchronize data with the file synchronization provider. The sample performs a non-hierarchical local file synchronization. The sample shows the basic requirements such as synchronization ID formats and transfer interface support to synchronize between a simple custom provider and the file synchronization provider. For simplicity, this sample does not demonstrate the file synchronization provider's support for hierarchical synchronization.

*Required Software*
* Visual Studio 2005 or Visual Studio 2008
* .NET Framework 2.0 SP1 or .NET Framework 3.x
* Microsoft Sync Framework 2.0

See the readme.txt file that installs with the sample for complete installation and usage instructions.

For more information on synchronizing files, see [url:Synchronizing Files|http://msdn.microsoft.com/en-us/library/bb902860(SQL.105).aspx]. For more information on simple custom providers, see [url:Implementing a Simple Custom Provider|http://msdn.microsoft.com/en-us/library/dd937537(SQL.105).aspx].

UPDATED WIKI: Home

LarenC — Mon, 23 Nov 2009 20:06:26 GMT

Microsoft Sync Framework Samples

Microsoft Sync Framework is a comprehensive synchronization platform that enables collaboration and offline access for applications, services, and devices with support for any data type, any data store, any transfer protocol, and any network topology.
For more information about Sync Framework, see the Sync Framework Developer Center

This resource page includes a number of samples that demonstrate the features and capabilities of Microsoft Sync Framework 2.0.

Sync101 Samples

This set of samples illustrates various concepts and features needed to synchronize a custom data store. The samples cover many concepts, from how to write a basic synchronization application that uses simple custom providers, to more complex scenarios, such as how to write a standard custom provider that uses Windows Communication Foundation (WCF) to synchronize data between replicas on different computers.

Sync101 with Simple Providers	Shows how to synchronize replicas by using the Sync Framework simple provider API. This API gives developers a lot of the power and flexibility of the core Sync Framework APIs, but with less of a learning curve and less code, especially for replicas that have little or no change-tracking support.
Sync101 with Metadata Storage Service	Shows how to use a standard custom provider to synchronize data between replicas. Uses the metadata storage service to store synchronization metadata, which greatly simplifies the synchronization process.
Sync101 with Change Units	Shows how to use a standard custom provider to partition items into change units so that when only part of an item changes, only the changed part is sent during synchronization.
Sync101 with Constraint Conflicts	Shows how to use a standard custom provider to report and resolve constraint conflicts that occur because of name collisions when changes are applied.
Sync101 with Custom Metadata Store	Shows how to use a standard custom provider to synchronize data between replicas. Uses a custom metadata store to show all of the details of the synchronization process.
Sync101 with Change Unit Filtering	Shows how to use a change unit filter with a standard custom provider to send only a subset of the change units defined for the synchronization scope.
Sync101 with Custom Filtering	Shows how to track custom filters and how to use a standard custom provider to send changes from a filter-tracking replica to two different filtered replicas.
Sync101 with Remote Change Application over WCF	Shows how to implement a proxy provider that uses the remote change application (RCA) pattern to synchronize over WCF with a provider on a remote computer.

Database Synchronization Provider Samples

This set of samples illustrates how to use database synchronization providers to synchronize between SQL Server databases and SQL Server Compact databases.

Database Sync: SQL Server and SQL Server Compact	Shows how to use database synchronization providers to configure and execute peer-to-peer synchronization between a SQL Server database and one or more SQL Server Compact databases.
Database Sync: Peer-to-Peer over WCF	Shows how to use database synchronization providers to configure and execute peer-to-peer synchronization between a SQL Server database and one or more SQL Server Compact databases by using a remote WCF service.

File Synchronization Provider Sample

File Synchronization Provider Sample	This sample illustrates how to use the file synchronization provider, a fully functioning provider that helps an application to synchronize files and folders in NTFS, FAT, and SMB file systems.
File Sync with Simple Custom Provider Sample	This sample demonstrates how to write a simple custom synchronization provider and use it to synchronize data with the file synchronization provider.

Samples for Other Versions of Sync Framework

Please send all comments to the Sync Framework Forum as this page is not regularly monitored: http://social.microsoft.com/Forums/en-US/category/sync

UPDATED RELEASE: File Sync with Simple Custom Provider Sample (Nov 23, 2009)

Mon, 23 Nov 2009 20:04:50 GMT

*Description*
This sample demonstrates how to write a simple custom synchronization provider and use it to synchronize data with the file synchronization provider. The sample performs a non-hierarchical local file synchronization. The sample shows the basic requirements such as synchronization ID formats and transfer interface support to synchronize between a simple custom provider and the file synchronization provider. For simplicity, this sample does not demonstrate the file synchronization provider's support for hierarchical synchronization.

*Required Software*
* Visual Studio 2005 or Visual Studio 2008
* .NET Framework 2.0 SP1 or .NET Framework 3.x
* Microsoft Sync Framework 2.0

See the readme.txt file that installs with the sample for complete installation and usage instructions.

For more information on synchronizing files, see [url:Synchronizing Files|http://msdn.microsoft.com/en-us/library/bb902860(SQL.105).aspx]. For more information on simple custom providers, see [url:Implementing a Simple Custom Provider|http://msdn.microsoft.com/en-us/library/dd937537(SQL.105).aspx].

CREATED RELEASE: File Sync with Simple Custom Provider Sample (Nov 23, 2009)

Mon, 23 Nov 2009 20:03:11 GMT

NEW POST: SyncProvider to Sync 2 SQL servers

ant_yio — Fri, 13 Nov 2009 03:49:00 GMT

I have tried sample at http://msdn.microsoft.com/en-us/library/dd918848(SQL.105).aspx with sync framework 2.0.
It works on SQL server 2005 <-> SQL server 2005 express with the change of connection string only. I reckon it would work on SQL 2008 vice versa.
I think sync framework 1.0 required special provider for SQL express but not for sync framework 2.0 anymore.

NEW POST: Provisioning server (remote) / client (local) with synchronization related object

ant_yio — Fri, 13 Nov 2009 03:43:37 GMT

Hi,

Referring the sample at http://msdn.microsoft.com/en-us/library/dd918848(SQL.105).aspx

I have tried out using Sync Framework 2.0 with the following code snippet.

SqlSyncScopeProvisioning serverConfig = new SqlSyncScopeProvisioning(scopeDesc);
serverConfig.SetCreateTableDefault(DbSyncCreationOption.Skip);
serverConfig.ObjectSchema = "Sync";

// Specify which column(s) in the Customer table to use for filtering data,
// and the filtering clause to use against the tracking table.
// "side" is an alias for the tracking table.
serverConfig.Tables"Sales.Customer".AddFilterColumn("CustomerType");
serverConfig.Tables"Sales.Customer".FilterClause = "side.CustomerType = 'Retail'";

// Configure the scope and change-tracking infrastructure.
serverConfig.Apply(serverConn);

// Write the configuration script to a file. You can modify
// this script if necessary and run it against the server
// to customize behavior.
File.WriteAllText("SampleConfigScript.txt",
serverConfig.Script("SyncSamplesDb_SqlPeer1"));

I manage to provision the server and also client in SQL server and SQL server express. However, as i check the synchronization related object in sync object schema

I found that the TRIGGERS used in it are as such. It is using GETDATE() to get the lastchangedatetime.

USE SyncSamplesDb_SqlPeer1
GO
/****** Object: Trigger Sales.Customer_update_trigger Script Date: 11/13/2009 11:40:59 ******/
SET ANSI_NULLS ON
GO
SET QUOTED_IDENTIFIER ON
GO
ALTER TRIGGER Sales.Customer_update_trigger ON Sales.Customer FOR UPDATE AS
UPDATE side SET local_update_peer_key = 0, restore_timestamp = NULL, update_scope_local_id = NULL, last_change_datetime = GETDATE(), CustomerType = i.CustomerType FROM Sync.Customer_tracking side JOIN INSERTED i ON side.CustomerId = i.CustomerId

Just like to find out, is there a way to provision server/client with TRIGGERS using GETUTCDATE() instead because that way I think, the synchronization would work even the replicas are in different timezone.

NEW POST: Exchange Sync Provider

jrummell — Fri, 30 Oct 2009 21:04:48 GMT

Is there a Sync Provider sample for Exchange Web Services (EWS)? I'm tasked with syncing our CRM contacts with Exchange and I'm not sure where to start!

UPDATED WIKI: Home

LarenC — Fri, 30 Oct 2009 17:09:09 GMT

Microsoft Sync Framework Samples

Sync101 Samples

Sync101 with Simple Providers	Shows how to synchronize replicas by using the Sync Framework simple provider API. This API gives developers a lot of the power and flexibility of the core Sync Framework APIs, but with less of a learning curve and less code, especially for replicas that have little or no change-tracking support.
Sync101 with Metadata Storage Service	Shows how to use a standard custom provider to synchronize data between replicas. Uses the metadata storage service to store synchronization metadata, which greatly simplifies the synchronization process.
Sync101 with Change Units	Shows how to use a standard custom provider to partition items into change units so that when only part of an item changes, only the changed part is sent during synchronization.
Sync101 with Constraint Conflicts	Shows how to use a standard custom provider to report and resolve constraint conflicts that occur because of name collisions when changes are applied.
Sync101 with Custom Metadata Store	Shows how to use a standard custom provider to synchronize data between replicas. Uses a custom metadata store to show all of the details of the synchronization process.
Sync101 with Change Unit Filtering	Shows how to use a change unit filter with a standard custom provider to send only a subset of the change units defined for the synchronization scope.
Sync101 with Custom Filtering	Shows how to track custom filters and how to use a standard custom provider to send changes from a filter-tracking replica to two different filtered replicas.
Sync101 with Remote Change Application over WCF	Shows how to implement a proxy provider that uses the remote change application (RCA) pattern to synchronize over WCF with a provider on a remote computer.

Database Synchronization Provider Samples

This set of samples illustrates how to use database synchronization providers to synchronize between SQL Server databases and SQL Server Compact databases.

Database Sync: SQL Server and SQL Server Compact	Shows how to use database synchronization providers to configure and execute peer-to-peer synchronization between a SQL Server database and one or more SQL Server Compact databases.
Database Sync: Peer-to-Peer over WCF	Shows how to use database synchronization providers to configure and execute peer-to-peer synchronization between a SQL Server database and one or more SQL Server Compact databases by using a remote WCF service.

File Synchronization Provider Sample

This sample illustrates how to use the file synchronization provider, a fully functioning provider that helps an application to synchronize files and folders in NTFS, FAT, and SMB file systems.

Samples for Other Versions of Sync Framework

Please send all comments to the Sync Framework Forum as this page is not regularly monitored: http://social.microsoft.com/Forums/en-US/category/sync

UPDATED RELEASE: File Synchronization Provider Sample (Oct 23, 2009)

Mon, 26 Oct 2009 19:50:37 GMT

This sample shows how to use the file synchronization provider component of Microsoft Sync Framework.
The file synchronization provider is a fully functioning provider that helps an application to synchronize
files and folders in NTFS, FAT, and SMB file systems. This sample synchronizes the contents of two folders
in a file system.

*Required Software*
* Visual Studio 2005 or Visual Studio 2008
* .NET Framework 2.0 SP1 or .NET Framework 3.x
* Microsoft Sync Framework 2.0

See the readme.txt file that installs with the sample for complete installation and usage instructions.

For more information on synchronizing files, see [url:Synchronizing Files|http://msdn.microsoft.com/en-us/library/bb902860(SQL.105).aspx].

UPDATED RELEASE: Database Sync - Peer-to-Peer over WCF (Oct 23, 2009)

Mon, 26 Oct 2009 19:49:33 GMT

This application demonstrates how to use Sync Framework 2.0 database synchronization providers to configure and execute peer-to-peer synchronization between a SQL Server database and one or more SQL Server Compact databases via a remote WCF service.

*What is Demonstrated in This Sample?*
* Synchronizing a server database scope (hosted in a SQL Server or SQL Server Express instance) with multiple instances of a Compact client database.
* Enabling synchronization over an n-tier model by using WCF as an endpoint.
* The new multi-scope change-tracking model on the server.
* Two ways to configure and synchronize a Compact database: full initialization and snapshot initialization.
* Configuration of SqlSyncProvider and SqlCeSyncAdapter objects.
* Enabling batched synchronization.

*Required Software*
* Visual Studio 2005 or Visual Studio 2008
* .NET Framework 2.0 SP1 or .NET Framework 3.x
* Microsoft Sync Framework 2.0

See the readme.txt file that installs with the sample for complete installation and usage instructions.

For more information on synchronizing databases, see [url:Synchronizing SQL Server and SQL Server Compact|http://msdn.microsoft.com/en-us/library/ee617382(SQL.105).aspx].

UPDATED RELEASE: Database Sync - SQL Server and SQL Server Compact (Oct 23, 2009)

Mon, 26 Oct 2009 19:48:42 GMT

This application demonstrates how to use Sync Framework 2.0 database synchronization providers to configure and execute peer-to-peer synchronization between a SQL Server database and one or more SQL Server Compact databases.

*What is Demonstrated in This Sample?*
* Synchronizing a server database scope (hosted in a SQL Server or SQL Server Express instance) with multiple instances of a Compact client database.
* The new multi-scope change-tracking model on the server.
* Two ways to configure and synchronize a Compact database: full initialization and snapshot initialization.
* Provisioning of both SQL Server and SQL Compact through the use of the Sync Framework API.
* Configuration of SqlSyncProvider and SqlCeSyncProvider objects.
* The use of batching to throttle resource usage during synchronization.
* The use of the config file to enable tracing.

*Required Software*
* Visual Studio 2005 or Visual Studio 2008
* .NET Framework 2.0 SP1 or .NET Framework 3.x
* Microsoft Sync Framework 2.0

See the readme.txt file that installs with the sample for complete installation and usage instructions.

For more information on synchronizing databases, see [url:Synchronizing SQL Server and SQL Server Compact|http://msdn.microsoft.com/en-us/library/ee617382(SQL.105).aspx].

UPDATED RELEASE: Sync101 with Remote Change Application over WCF (Oct 23, 2009)

Mon, 26 Oct 2009 19:46:58 GMT

This sample illustrates how to implement a proxy provider that uses the remote change application (RCA) pattern to synchronize over Windows Communication Foundation (WCF) with a provider on a remote computer. This sample uses the metadata storage service as the store for the metadata information for each replica database. This greatly simplifies the logic required to implement data synchronization between data stores.

*Required Software*
* Visual Studio 2008
* .NET Framework 2.0 SP1 or .NET Framework 3.x
* Microsoft Sync Framework 2.0

See the readme.txt file that installs with the sample for complete installation and usage instructions.

For more information about standard custom providers, see [url:Implementing a Standard Custom Provider|http://msdn.microsoft.com/en-us/library/bb902826(SQL.105).aspx].

UPDATED RELEASE: Sync101 with Custom Filtering (Oct 23, 2009)

Mon, 26 Oct 2009 19:45:29 GMT

This sample illustrates how to synchronize data between replicas that use custom filters. Synchronization from a filter-tracking replica to two different filtered replicas is shown. This sample uses a custom store to store the metadata information for each replica database.

*Required Software*
* Visual Studio 2005 or Visual Studio 2008
* .NET Framework 2.0 SP1 or .NET Framework 3.x
* Microsoft Sync Framework 2.0

See the readme.txt file that installs with the sample for complete installation and usage instructions.

For more information on custom filters, see [url:Filtering Synchronization Data|http://msdn.microsoft.com/en-us/library/bb902843(SQL.105).aspx].

UPDATED RELEASE: Sync101 with Change Unit Filtering (Oct 23, 2009)

Mon, 26 Oct 2009 19:44:58 GMT

This sample illustrates how a provider can use a change unit filter to synchronize only part of the data for each item. This sample uses a custom metadata store to store the metadata information for each replica database.

*Required Software*
* Visual Studio 2005 or Visual Studio 2008
* .NET Framework 2.0 SP1 or .NET Framework 3.x
* Microsoft Sync Framework 2.0

See the readme.txt file that installs with the sample for complete installation and usage instructions.

For more information on change unit filters, see [url:Filtering Synchronization Data|http://msdn.microsoft.com/en-us/library/bb902843(SQL.105).aspx].

UPDATED RELEASE: Sync101 with Custom Metadata Store (Oct 23, 2009)

Mon, 26 Oct 2009 19:43:49 GMT

This sample uses a custom metadata store to store the metadata information for each replica database. In this sample three in-memory data stores are used to show how data collaboration can be accomplished and how Sync Framework helps to minimize peer-to-peer complexities such as data conflicts, conflict resolution, and data deletions. This sample also illustrates how a data store can use change units to partition data and send only data that has changed.

*Required Software*
* Visual Studio 2005 or Visual Studio 2008
* .NET Framework 2.0 SP1 or .NET Framework 3.x
* Microsoft Sync Framework 2.0

See the readme.txt file that installs with the sample for complete installation and usage instructions.

For more information on synchronization metadata, see [url:Managing Metadata for Standard Providers|http://msdn.microsoft.com/en-us/library/bb902856(SQL.105).aspx].

UPDATED RELEASE: Sync101 with Constraint Conflicts (Oct 23, 2009)

Mon, 26 Oct 2009 19:42:38 GMT

This sample demonstrates how to resolve a constraint conflict that occurs because of a name collision. This sample uses change units to partition data and send only data that has changed. This sample also uses a custom store to store the metadata information for each replica database.

*Required Software*
* Visual Studio 2005 or Visual Studio 2008
* .NET Framework 2.0 SP1 or .NET Framework 3.x
* Microsoft Sync Framework 2.0

See the readme.txt file that installs with the sample for complete installation and usage instructions.

For more information on constraint conflicts, see [url:Detecting and Resolving Constraint Conflicts|http://msdn.microsoft.com/en-us/library/dd937738(SQL.105).aspx].

UPDATED RELEASE: Sync101 with Change Units (Oct 23, 2009)

Mon, 26 Oct 2009 19:41:39 GMT

This sample illustrates how a data store can use change units to partition data and send only data that has changed. This sample uses the metadata storage service as the store for the metadata information for each replica database. This greatly simplifies the logic required to implement data synchronization between data stores. In this sample three in-memory data stores are used to show how data collaboration can be accomplished and how Sync Framework helps to minimize peer-to-peer complexities such as data conflicts, conflict resolution, and data deletions. This sample also illustrates explicit transactioning by applying all of the contents of a batch in a single transaction instead of each change individually.

*Required Software*
* Visual Studio 2005 or Visual Studio 2008
* .NET Framework 2.0 SP1 or .NET Framework 3.x
* Microsoft Sync Framework 2.0

See the readme.txt file that installs with the sample for complete installation and usage instructions.

For more information on change units, see [url:Synchronizing Change Units|http://msdn.microsoft.com/en-us/library/bb902848(SQL.105).aspx].

UPDATED RELEASE: Sync101 with Metadata Storage Service (Oct 23, 2009)

Mon, 26 Oct 2009 19:40:34 GMT

This sample uses the metadata storage service as the store for the metadata information for each replica database. This greatly simplifies the logic required to implement data synchronization between data stores. In this sample three in-memory data stores are used to show how data collaboration can be accomplished and how Sync Framework helps to minimize peer-to-peer complexities such as data conflicts, conflict resolution, and data deletions. This sample also illustrates explicit transactioning by applying all of the contents of a batch in a single transaction instead of each change individually.

*Required Software*
* Visual Studio 2005 or Visual Studio 2008
* .NET Framework 2.0 SP1 or .NET Framework 3.x
* Microsoft Sync Framework 2.0

See the readme.txt file that installs with the sample for complete installation and usage instructions.

For more information on the metadata storage service, see [url:Sync Framework Metadata Storage Service|http://msdn.microsoft.com/en-us/library/bb902857(SQL.105).aspx].

UPDATED RELEASE: Sync101 with Simple Providers (Oct 23, 2009)

Mon, 26 Oct 2009 19:39:27 GMT

This sample demonstrates how to synchronize replicas by using the Sync Framework simple provider API. This API
gives developers a lot of the power and flexibility of the core Sync Framework APIs, but with less of a learning curve and
less code, especially for replicas that have little or no change-tracking support.

This sample has examples of both full enumeration and anchor enumeration providers. The sample covers basic
synchronization scenarios in addition to demonstrating how to handle concurrency and constraint conflicts.

*Required Software*
* Visual Studio 2005 or Visual Studio 2008
* .NET Framework 2.0 SP1 or .NET Framework 3.x
* Microsoft Sync Framework 2.0

See the readme.txt file that installs with the sample for complete installation and usage instructions.

For more information on Simple Providers, see [url:Implementing a Simple Custom Provider|http://msdn.microsoft.com/en-us/library/dd937537(SQL.105).aspx].

UPDATED WIKI: Home

LarenC — Mon, 26 Oct 2009 19:11:28 GMT

Microsoft Sync Framework Samples

Sync101 Samples

Sync101 with Simple Providers	Shows how to synchronize replicas by using the Sync Framework simple provider API. This API gives developers a lot of the power and flexibility of the core Sync Framework APIs, but with less of a learning curve and less code, especially for replicas that have little or no change-tracking support.
Sync101 with Metadata Storage Service	Shows how to use a standard custom provider to synchronize data between replicas. Uses the metadata storage service to store synchronization metadata, which greatly simplifies the synchronization process.
Sync101 with Change Units	Shows how to use a standard custom provider to partition items into change units so that when only part of an item changes, only the changed part is sent during synchronization.
Sync101 with Constraint Conflicts	Shows how to use a standard custom provider to report and resolve constraint conflicts that occur because of name collisions when changes are applied.
Sync101 with Custom Metadata Store	Shows how to use a standard custom provider to synchronize data between replicas. Uses a custom metadata store to show all of the details of the synchronization process.
Sync101 with Change Unit Filtering	Shows how to use a change unit filter with a standard custom provider to send only a subset of the change units defined for the synchronization scope.
Sync101 with Custom Filtering	Shows how to track custom filters and how to use a standard custom provider to send changes from a filter-tracking replica to two different filtered replicas.
Sync101 with Remote Change Application over WCF	Shows how to implement a proxy provider that uses the remote change application (RCA) pattern to synchronize over WCF with a provider on a remote computer.

Database Synchronization Provider Samples

This set of samples illustrates how to use database synchronization providers to synchronize between SQL Server databases and SQL Server Compact databases.

Database Sync: SQL Server and SQL Server Compact	Shows how to use database synchronization providers to configure and execute peer-to-peer synchronization between a SQL Server database and one or more SQL Server Compact databases.
Database Sync: Peer-to-Peer over WCF	Shows how to use database synchronization providers to configure and execute peer-to-peer synchronization between a SQL Server database and one or more SQL Server Compact databases by using a remote WCF service.

File Synchronization Provider Sample

This sample illustrates how to use the file synchronization provider, a fully functioning provider that helps an application to synchronize files and folders in NTFS, FAT, and SMB file systems.

Samples for Other Versions of Sync Framework

Please send all comments to the Sync Framework Forum as this page is not regularly monitored: http://social.microsoft.com/Forums/en-US/category/sync