SqlSyncTableProvisioning Class

Represents the provisioning of a SQL Server database table that is represented by a DbSyncTableDescription object.

Inheritance Hierarchy

System.Object
  Microsoft.Synchronization.Data.SqlServer.SqlSyncTableProvisioning

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

Syntax

'Declaration
Public Class SqlSyncTableProvisioning
'Usage
Dim instance As SqlSyncTableProvisioning
public class SqlSyncTableProvisioning
public ref class SqlSyncTableProvisioning
type SqlSyncTableProvisioning =  class end
public class SqlSyncTableProvisioning

The SqlSyncTableProvisioning type exposes the following members.

Constructors

  Name Description
Public method SqlSyncTableProvisioning(DbSyncTableDescription) Obsolete. Initializes a new instance of the SqlSyncTableProvisioning class for the specified table.
Public method SqlSyncTableProvisioning(SqlConnection, DbSyncTableDescription) Initializes a new instance of the SqlSyncTableProvisioning class for the specified connection and table schema.
Public method SqlSyncTableProvisioning(DbSyncTableDescription, String) Obsolete. Initializes a new instance of the SqlSyncTableProvisioning class for the specified table and synchronization object prefix.

Top

Properties

  Name Description
Public property CreateProcedures Gets or sets whether to create a set of stored procedures that insert, update, and delete data and synchronization metadata.
Public property CreateProceduresForAdditionalScope Gets or sets whether to create, for any additional scopes, sets of stored procedures that insert, update, and delete data and synchronization metadata.
Public property CreateTable Gets or sets whether to create a base table.
Public property CreateTrackingTable Gets or sets whether to create a table that stores change-tracking metadata for the base table.
Public property CreateTriggers Gets or sets whether to create triggers on the base table that update to the tracking table.
Public property FilterClause Gets or sets the SQL WHERE clause (without the WHERE keyword) that is used to filter the result set from the base table.
Public property FilterColumns Gets the list of columns that were added by using AddFilterColumn.
Public property FilterParameters Gets the list of filter parameters that are used to control which items are enumerated.
Public property GlobalName Gets the name, including database-specific delimiters, that other nodes in a synchronization topology use to identify a table.
Public property LocalName Gets the name, including database-specific delimiters, that the local node in a synchronization topology uses to identify a table.
Public property ObjectPrefix Gets or sets the optional prefix that is used to identify objects that Sync Framework creates.
Public property ObjectSchema Gets or sets the database schema in which Sync Framework creates objects.
Public property PopulateTrackingTable Gets or sets whether to insert metadata into the change-tracking table for rows that already exist in the base table.
Public property UnquotedGlobalName Gets the name, not including database-specific delimiters, that other nodes in a synchronization topology use to identify a table.
Public property UnquotedLocalName Gets the name, not including database-specific delimiters, that the local node in a synchronization topology uses to identify a table.
Public property UseBulkProcedures Gets or sets a value that indicates whether the bulk procedures should be created during provisioning.

Top

Methods

  Name Description
Public method AddFilterColumn Adds a column that is used in the filter clause that is specified in FilterClause.
Public method Apply() Applies the provisioning script to a SQL Server database over the connection specified when this object was constructed.
Public method Apply(SqlConnection) Obsolete. Applies the provisioning script to a SQL Server database over the specified connection.
Public method Apply(SqlTransaction) Applies the provisioning script to a SQL Server database within the specified transaction.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Script Generates a string that contains the SQL code to provision a table for a particular scope.
Public method ToString Returns a string that represents the SqlSyncTableProvisioning object. (Overrides Object.ToString().)

Top

Remarks

Provisioning can occur at the level of the table, but it typically occurs at the level of the scope, which is a logical grouping of tables. For more information, see How To: Execute Database Synchronization (SQL Server).

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