MergeSubsetFilter Object

MergeSubsetFilter Object

The MergeSubsetFilter object represents a filter (or partition) of the data in one article based on filtered data in another article. Both articles must be part of the same merge publication.

Methods

BeginAlter Method	DoAlter Method
CancelAlter Method	Remove Method (Objects)

Properties

Remarks

A MergeSubsetFilter object is commonly used when two tables have a primary key to foreign key relationship. If the MergeArticle object representing the primary key table has a SubsetFilterClause object defined, add a MergeSubsetFilter object (that references the primary key article) to the MergeArticle object representing the foreign key table.

With the MergeSubsetFilter object, you can:

• Add a merge filter.
  
  
• Change the properties of an existing merge filter.

To add a merge filter to a merge article

1. Create a new MergeSubsetFilter object.
   
   
2. Set the Name property.
   
   
3. Set the JoinArticleName property.
   
   
4. Set the JoinFilterClause property.
   
   
5. Add the MergeSubsetFilter object to the MergeSubsetFilters collection of a connected MergeArticle object.

To alter an existing merge filter of a merge article

1. Get a MergeSubsetFilter object from the MergeSubsetFilters collection of a connected MergeArticle object.
   
   
2. Use the BeginAlter method to mark the beginning of the changes.
   
   
3. Set the MergeSubsetFilter properties to reflect the changes to the merge filter.
   
   
4. Use the DoAlter method to submit the changes to Microsoft® SQL Server™.