sp_helpmergefilter (Transact-SQL)
Returns information about merge filters. This stored procedure is executed at the Publisher on any database.
.gif "Topic link icon")
Transact-SQL Syntax Conventions
Syntax
sp_helpmergefilter [ @publication= ] 'publication'
[ , [ @article= ] 'article']
[ , [ @filtername= ] 'filtername']
Arguments
[ @publication=] 'publication'
Is the name of the publication. publication is sysname, with no default.[ @article=] 'article'
Is the name of the article. article is sysname, with a default of %, which returns the names of all articles.[ @filtername=] 'filtername'
Is the name of the filter about which to return information. filtername is sysname, with a default of %, which returns information about all the filters defined on the article or publication.
Result Sets
Column name |
Data type |
Description |
|---|---|---|
join_filterid |
int |
ID of the join filter. |
filtername |
sysname |
Name of the filter. |
join article name |
sysname |
Name of the join article. |
join_filterclause |
nvarchar(2000) |
Filter clause qualifying the join. |
join_unique_key |
int |
Whether the join is on a unique key. |
base table owner |
sysname |
Name of the owner of the base table. |
base table name |
sysname |
Name of the base table. |
join table owner |
sysname |
Name of the owner of the table being joined to the base table. |
join table name |
sysname |
Name of the table being joined to the base table. |
article name |
sysname |
Name of the table article being joined to the base table. |
filter_type |
tinyint |
Type of merge filter, which can be one of the following: 1 = join filter only 2 = logical record relationship 3 = both |
Return Code Values
0 (success) or 1 (failure)
Remarks
sp_helpmergefilter is used in merge replication.
Permissions
Only members of the sysadmin fixed server role and the db_owner fixed database role can execute sp_helpmergefilter.
See Also
Reference
sp_addmergefilter (Transact-SQL)
sp_changemergefilter (Transact-SQL)