AddReplicatedColumns Method
This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.
The AddReplicatedColumns method vertically partitions a transactional or snapshot replication article.
Syntax
object
.AddReplicatedColumns(
str
)
Parts
- object
Expression that evaluates to an object in the Applies To list.
- str
SQL-DMO multistring naming columns in the table referenced by the transactional replication article.
Prototype (C/C++)
HRESULT AddReplicatedColumns(SQLDMO_LPCSTR NewValue);
Remarks
When using SQL Distributed Management Objects (SQL-DMO) to create a transactional or snapshot replication article, all columns in a table referenced by the article are replicated by default.
An initial column list, set by using the AddReplicatedColumns method, establishes an initial vertical partition of the replicated table. The initial partition can be established prior to article creation (before the TransArticle object is added to its containing collection) or to an existing, nonpartitioned article.
When the TransArticle object references an existing partitioned article, the AddReplicatedColumns method is nondestructive. That is, columns specified in the str argument are added to the list of those establishing the vertical partition.
For more information about setting multistring parameters, see Using SQL-DMO Multistrings.
For more information about altering a partition definition by using SQL-DMO, see RemoveReplicatedColumns Method.
Note
If an application sets AddReplicatedColumns after the initial snapshot has been created, a new snapshot must be generated and reapplied to each subscription. Snapshots are applied when the next scheduled snapshot and distribution or merge agent run.