SqlSyncDescriptionBuilder Class

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

Inheritance Hierarchy

System.Object
  Microsoft.Synchronization.Data.SqlServer.SqlSyncDescriptionBuilder

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

Syntax

'Declaration
Public NotInheritable Class SqlSyncDescriptionBuilder
'Usage

public static class SqlSyncDescriptionBuilder

public ref class SqlSyncDescriptionBuilder abstract sealed

[<AbstractClassAttribute>]
[<SealedAttribute>]
type SqlSyncDescriptionBuilder =  class end

public final class SqlSyncDescriptionBuilder

Methods

	Name	Description
	GetDescriptionForScope(String, SqlConnection)	Returns a DbSyncScopeDescription object that contains information about the specified scope that is defined for a SQL Server database.
	GetDescriptionForScope(String, String, SqlConnection)	Returns a DbSyncScopeDescription object that contains information about the specified scope that is defined for a SQL Server database.
	GetDescriptionForScope(String, String, String, SqlConnection)	Returns a DbSyncScopeDescription object that contains information about the specified scope that is defined for a SQL Server database.
	GetDescriptionForTable(String, SqlConnection)	Returns a DbSyncTableDescription object that contains schema information about the specified table in a SQL Server database.
	GetDescriptionForTable(String, Collection<String>, SqlConnection)	Returns a DbSyncTableDescription object that contains schema information about the specified table in a SQL Server database.

Top

Examples

The following code example describes a scope named filtered_customer, and adds two tables to the scope: Customer and CustomerContact. The tables already exist in the server database, so the GetDescriptionForTable method is used to retrieve the schema from the server database. All columns from the Customer table are included, but only two columns from the CustomerContact table are included. To view this code in the context of a complete example, see How To: Execute Database Synchronization (SQL Server).

DbSyncScopeDescription scopeDesc = new DbSyncScopeDescription("filtered_customer");

// Definition for Customer.
DbSyncTableDescription customerDescription =
    SqlSyncDescriptionBuilder.GetDescriptionForTable("Sales.Customer", serverConn);

scopeDesc.Tables.Add(customerDescription);

// Definition for CustomerContact, including the list of columns to include.
Collection<string> columnsToInclude = new Collection<string>();
columnsToInclude.Add("CustomerId");
columnsToInclude.Add("PhoneType");
DbSyncTableDescription customerContactDescription =
    SqlSyncDescriptionBuilder.GetDescriptionForTable("Sales.CustomerContact", columnsToInclude, serverConn);

scopeDesc.Tables.Add(customerContactDescription);

Dim scopeDesc As New DbSyncScopeDescription("filtered_customer")

' Definition for Customer. 
Dim customerDescription As DbSyncTableDescription = _
    SqlSyncDescriptionBuilder.GetDescriptionForTable("Sales.Customer", serverConn)

scopeDesc.Tables.Add(customerDescription)


' Definition for CustomerContact, including the list of columns to include. 
Dim columnsToInclude As New Collection(Of String)()
columnsToInclude.Add("CustomerId")
columnsToInclude.Add("PhoneType")
Dim customerContactDescription As DbSyncTableDescription = _
    SqlSyncDescriptionBuilder.GetDescriptionForTable("Sales.CustomerContact", columnsToInclude, serverConn)

scopeDesc.Tables.Add(customerContactDescription)

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.Synchronization.Data.SqlServer Namespace