RemoveReplicatedColumns Method

SQL-DMO

SQL-DMO

RemoveReplicatedColumns Method

The RemoveReplicatedColumns method configures a previously created, vertical partition for a transactional or snapshot replication article.

Applies To
MergeArticle2 Object TransArticle Object
Syntax

object.RemoveReplicatedColumns( Columns )

Parts

object

Expression that evaluates to an object in the Applies To list

Columns

SQL-DMO multistring that identifies one or more columns in the vertical partition

Prototype (C/C++)

HRESULT RemoveReplicatedColumns(
SQLDMO_LPCSTR Columns);

Remarks

When using 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 article with an existing partition, the RemoveReplicatedColumns method restructures the partition. To restore default article behavior, use the RemoveReplicatedColumns method that lists all columns in the current partition. Use the ListReplicatedColumns method to determine names of all columns participating in an existing partition.

For more information about setting multistring parameters, see Using SQL-DMO Multistrings.

Note  If an application sets RemoveReplicatedColumns 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.

See Also

AddReplicatedColumns Method

ListReplicatedColumns Method