SqlSyncScopeProvisioning.ObjectSchema Property

Gets or sets the database schema in which Sync Framework creates objects.

Namespace:  Microsoft.Synchronization.Data.SqlServer
Assembly:  Microsoft.Synchronization.Data.SqlServer (in Microsoft.Synchronization.Data.SqlServer.dll)

Syntax

'Declaration
Public Property ObjectSchema As String
    Get
    Set
'Usage
Dim instance As SqlSyncScopeProvisioning
Dim value As String

value = instance.ObjectSchema

instance.ObjectSchema = value

public string ObjectSchema { get; set; }

public:
property String^ ObjectSchema {
    String^ get ();
    void set (String^ value);
}

member ObjectSchema : string with get, set

function get ObjectSchema () : String
function set ObjectSchema (value : String)

Property Value

Type: System.String
The database schema in which Sync Framework creates objects.

Examples

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()

See Also

Reference

SqlSyncScopeProvisioning Class

Microsoft.Synchronization.Data.SqlServer Namespace