sp_check_subset_filter (Transact-SQL)

  • Article

Applies to: SQL Server Azure SQL Managed Instance

Checks a filter clause against any table to determine if the filter clause is valid for the table. This stored procedure returns information about the supplied filter, including if the filter qualifies for use with precomputed partitions. This stored procedure is executed at the Publisher on the database containing the publication.

Transact-SQL syntax conventions

Syntax

sp_check_subset_filter
    [ @filtered_table = ] N'filtered_table'
    , [ @subset_filterclause = ] N'subset_filterclause'
    [ , [ @has_dynamic_filters = ] has_dynamic_filters OUTPUT ]
    [ , [ @dynamic_filters_function_list = ] N'dynamic_filters_function_list' OUTPUT ]
[ ; ]

Arguments

[ @filtered_table = ] N'filtered_table'

The name of a filtered table. @filtered_table is nvarchar(400), with no default.

[ @subset_filterclause = ] N'subset_filterclause'

The filter clause being tested. @subset_filterclause is nvarchar(1000), with no default.

[ @has_dynamic_filters = ] has_dynamic_filters OUTPUT

Specifies whether the filter clause is a parameterized row filter. @has_dynamic_filters is an OUTPUT parameter of type bit. Returns a value of 1 when the filter clause is a parameterized row filter.

Result set

Column name Data type Description
can_use_partition_groups bit Is if the publication qualifies for using precomputed partitions; where 1 means that precomputed partitions can be used, and 0 means that they can't be used.
has_dynamic_filters bit Is if the supplied filter clause includes at least one parameterized row filter; where 1 means that a parameterized row filter is used, and 0 means that such a function isn't used.
dynamic_filters_function_list nvarchar(500) List of the functions in the filter clause that dynamically filter an article, where each function is separated by a semi-colon.
uses_host_name bit If the HOST_NAME function is used in the filter clause, where 1 means that this function is present.
uses_suser_sname bit If the SUSER_SNAME function is used in the filter clause, where 1 means that this function is present.

[ @dynamic_filters_function_list = ] N'dynamic_filters_function_list' OUTPUT

Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.

Return code values

0 (success) or 1 (failure).

Remarks

sp_check_subset_filter is used in merge replication.

sp_check_subset_filter can be executed against any table even if the table isn't published. This stored procedure can be used to verify a filter clause before defining a filtered article.

Permissions

Only members of the sysadmin fixed server role or db_owner fixed database role can execute sp_check_subset_filter.

Related content