FilterClause Property

SQL-DMO

SQL-DMO

FilterClause Property

The FilterClause property specifies a Transact-SQL WHERE clause used to filter row data published in the article.

Applies To
TransArticle Object
Syntax

object.FilterClause [= value]

Part

object

Expression that evaluates to an object in the Applies To list

Value

String that specifies a Transact-SQL expression 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-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, may 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.

See Also

SELECT

sp_articlefilter