DbSyncTableDescription Class

Article
10/22/2010

Represents the schema of a table that is included in the Tables list of a DbSyncScopeDescription object. This is used during database provisioning.

Inheritance Hierarchy

System.Object
Microsoft.Synchronization.Data.DbSyncTableDescription

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

Syntax

'Declaration
<SerializableAttribute> _
Public Class DbSyncTableDescription
'Usage
Dim instance As DbSyncTableDescription

[SerializableAttribute]
public class DbSyncTableDescription

[SerializableAttribute]
public ref class DbSyncTableDescription

[<SerializableAttribute>]
type DbSyncTableDescription =  class end

public class DbSyncTableDescription

The DbSyncTableDescription type exposes the following members.

Constructors

	Name	Description
	DbSyncTableDescription()	Initializes a new instance of the DbSyncTableDescription class by using default values.
	DbSyncTableDescription(String)	Initializes a new instance of the DbSyncTableDescription class for the specified table name.

Top

Properties

	Name	Description
	Columns	Gets a list of DbSyncColumnDescription objects that represent the columns in a table.
	Constraints	Gets a list of DbSyncForeignKeyConstraint objects that represent the foreign key constraints that apply to a table.
	GlobalName	Gets or sets the name, including database-specific delimiters, that other nodes in a synchronization topology use to identify a table.
	IsTableMapped	Gets whether GlobalName and LocalName are the same.
	LocalName	Gets or sets the name, including database-specific delimiters, that the local node in a synchronization topology uses to identify a table.
	NonPkColumns	Gets a list of DbSyncColumnDescription objects that represent all columns in a table other than the primary key columns.
	PkColumns	Gets a list of DbSyncColumnDescription objects that represent all primary key columns in a table.
	UnquotedGlobalName	Gets or sets the name, not including database-specific delimiters, that other nodes in a synchronization topology use to identify a table.
	UnquotedLocalName	Gets or sets the name, not including database-specific delimiters, that the local node in a synchronization topology uses to identify a table.

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	ToString	Returns a string that represents the DbSyncTableDescription object. (Overrides Object.ToString().)

Top

Examples

The following code example describes a scope named filtered_customer, and adds three tables to the scope: Customer, CustomerContact, and NewTable. The first two 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. The NewTable table is defined by using DbSyncTableDescription and DbSyncColumnDescription objects, and then the table is created in the server database (and in the other databases that synchronize with it). 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);

DbSyncTableDescription newTableDescription = new DbSyncTableDescription("Sales.NewTable");

DbSyncColumnDescription newTableIdCol = new DbSyncColumnDescription();
DbSyncColumnDescription newTableContentCol = new DbSyncColumnDescription();

newTableIdCol.UnquotedName = "NewTableId";
newTableIdCol.Type = "int";
newTableIdCol.IsPrimaryKey = true;

newTableContentCol.UnquotedName = "NewTableContent";
newTableContentCol.Type = "nvarchar";
newTableContentCol.Size = "100";
newTableContentCol.IsPrimaryKey = false;

newTableDescription.Columns.Add(newTableIdCol);
newTableDescription.Columns.Add(newTableContentCol);
scopeDesc.Tables.Add(newTableDescription);

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) 

Dim newTableDescription As New DbSyncTableDescription("Sales.NewTable")

Dim newTableIdCol As New DbSyncColumnDescription()
Dim newTableContentCol As New DbSyncColumnDescription()

newTableIdCol.UnquotedName = "NewTableId" 
newTableIdCol.Type = "int" 
newTableIdCol.IsPrimaryKey = True 

newTableContentCol.UnquotedName = "NewTableContent" 
newTableContentCol.Type = "nvarchar" 
newTableContentCol.Size = "100" 
newTableContentCol.IsPrimaryKey = False 

newTableDescription.Columns.Add(newTableIdCol) 
newTableDescription.Columns.Add(newTableContentCol) 
scopeDesc.Tables.Add(newTableDescription)

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.

Share via