Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

SqlCeSyncDescriptionBuilder Class

Represents scope and table information for a SQL Server Compact database that is involved in synchronization.

System.Object
  Microsoft.Synchronization.Data.SqlServerCe.SqlCeSyncDescriptionBuilder

Namespace:  Microsoft.Synchronization.Data.SqlServerCe
Assembly:  Microsoft.Synchronization.Data.SqlServerCe (in Microsoft.Synchronization.Data.SqlServerCe.dll)
public static class SqlCeSyncDescriptionBuilder
  NameDescription
Public methodStatic memberGetDescriptionForScope(String, SqlCeConnection)Returns a DbSyncScopeDescription object that contains information about the specified scope that is defined for a SQL Server Compact database.
Public methodStatic memberGetDescriptionForScope(String, String, SqlCeConnection)Returns a DbSyncScopeDescription object that contains information about the specified scope that is defined for a SQL Server Compact database.
Public methodStatic memberGetDescriptionForTable(String, SqlCeConnection)Returns a DbSyncTableDescription object that contains schema information about the specified table in a SQL Server Compact database.
Public methodStatic memberGetDescriptionForTable(String, Collection<String>, SqlCeConnection)Returns a DbSyncTableDescription object that contains schema information about the specified table in a SQL Server Compact database.
Top

The following code example provisions a SQL Server database. Provisioning is based on scope information that is retrieved from a SQL Server Compact database by calling GetDescriptionForScope and specifying the scope name ("filtered_customer"), the optional object prefix name used in the SQL Server Compact database (in this case "Sync"), and the connection. SQL Server Compact databases do not support separate schemas, so we prefix the name of all synchronization-related objects with "Sync" so that they are easy to identify. For the SQL Server database, we specify the optional database schema in which Sync Framework stores synchronization objects (in this case "Sync", but the value is not required to match the object prefix). To view this code in the context of a complete example, see How To: Execute Database Synchronization (SQL Server).

DbSyncScopeDescription clientSqlDesc = SqlCeSyncDescriptionBuilder.GetDescriptionForScope("filtered_customer", "Sync", clientSqlCe1Conn);
SqlSyncScopeProvisioning clientSqlConfig = new SqlSyncScopeProvisioning(clientSqlConn, clientSqlDesc);
clientSqlConfig.ObjectSchema = "Sync";
clientSqlConfig.Apply();


Dim clientSqlDesc As DbSyncScopeDescription = _
    SqlCeSyncDescriptionBuilder.GetDescriptionForScope("filtered_customer", "Sync", clientSqlCe1Conn)
Dim clientSqlConfig As New SqlSyncScopeProvisioning(clientSqlConn, clientSqlDesc)
clientSqlConfig.ObjectSchema = "Sync"
clientSqlConfig.Apply()


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.