FilterClause Property

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 FilterClause property specifies a Transact-SQL WHERE clause used to filter row data published in the article.

Syntax

object.FilterClause [=value]

Parts

  • object
    An expression that evaluates to an object in the Applies To list

  • value
    A string that specifies a Transact-SQL expression that is valid as the WHERE clause of a SELECT statement

Data Type

String

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetFilterClause(SQLDMO_LPBSTR pRetVal);
HRESULT SetFilterClause(SQLDMO_LPCSTR NewValue);

Note

SQL Distributed Management Objects (SQL-DMO) strings are always returned as OLE BSTR objects. A C/C++ application obtains a reference to the string. The application must release the reference using SysFreeString.

Remarks

Filtering and horizontal partitioning are two methods that reduce the row data scope of an article. Either method, or both, can be used. The FilterClause property specifies that a row filter is applied to determine available data for an article.

Note

If an application sets FilterClause 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 agent run.

Applies To: