Поделиться через


sp_articlefilter (Transact-SQL)

Фильтрует данные, опубликованные на основе табличной статьи. Эта хранимая процедура выполняется в базе данных публикации на издателе.

Значок ссылки на разделСинтаксические обозначения в Transact-SQL

Синтаксис

sp_articlefilter [ @publication = ] 'publication'
        , [ @article = ] 'article'
    [ , [ @filter_name = ] 'filter_name' ]
    [ , [ @filter_clause = ] 'filter_clause' ]
    [ , [ @force_invalidate_snapshot = ] force_invalidate_snapshot ]
    [ , [ @force_reinit_subscription = ] force_reinit_subscription ]
    [ , [ @publisher = ] 'publisher' ]

Аргументы

  • [ @publication=] 'publication'
    Имя публикации, содержащей статью. Аргумент publication имеет тип sysname и не имеет значения по умолчанию.

  • [ @article=] 'article'
    Имя статьи. Аргумент article имеет тип sysname и не имеет значения по умолчанию.

  • [ @filter_name=] 'filter_name'
    Имя хранимой процедуры фильтра, которая должна быть создана посредством filter_name. Аргумент filter_name имеет тип nvarchar(386) и значение по умолчанию NULL. Необходимо указать уникальное имя для фильтра статьи.

  • [ @filter_clause=] 'filter_clause'
    Предложение ограничения (WHERE), которым определяется горизонтальный фильтр. Вводя предложение ограничения, опустите ключевое слово WHERE. Аргумент filter_clause имеет тип ntext и значение по умолчанию NULL.

  • [ @force_invalidate_snapshot = ] force_invalidate_snapshot
    Подтверждает, что действие, выполняемое этой хранимой процедурой, может сделать недействительным существующий моментальный снимок. Аргумент force_invalidate_snapshot имеет тип bit и значение по умолчанию 0.

    0 указывает, что изменения, внесенные в статью, не делают моментальный снимок недействительным. Если хранимая процедура определяет, что изменение требует создания нового моментального снимка, возникает ошибка и изменение не выполняется.

    1 указывает, что изменения, внесенные в статью, могут привести к недействительности моментального снимка. Если имеются подписки, которые могут потребовать нового моментального снимка, выдает разрешение на пометку существующего моментального снимка как устаревшего, после чего создается новый снимок.

  • [ @force_reinit_subscription = ] force_reinit_subscription
    Подтверждает, что действие, выполняемое данной хранимой процедурой, может сделать необходимой повторную инициализацию текущих подписок. Аргумент force_reinit_subscription имеет тип bit и значение по умолчанию 0.

    0 указывает, что изменения, внесенные в статью, не делают необходимой повторную инициализацию подписок. Если хранимая процедура определяет, что изменение потребует повторной инициализации подписок, возникает ошибка и изменение не выполняется.

    1 указывает, что изменения, внесенные в статью, вызывают повторную инициализацию подписок, и дает разрешение произвести повторную инициализацию.

  • [ @publisher= ] 'publisher'
    Указывает издатель, отличный от MicrosoftSQL Server. Аргумент publisher имеет тип sysname и значение по умолчанию NULL.

    ПримечаниеПримечание

    publisher нельзя использовать с издателем SQL Server.

Значения кодов возврата

0 (успешное завершение) или 1 (неуспешное завершение)

Замечания

Процедура sp_articlefilter используется в репликации моментальных снимков и репликации транзакций.

Выполнение подписки sp_articlefilter для статьи с существующими подписками требует повторной инициализации этих подписок.

Процедура sp_articlefilter создает фильтр, вставляет идентификатор хранимой процедуры фильтра в столбец filter таблицы sysarticles (Transact-SQL), затем вставляет текст предложения ограничения в столбец filter_clause.

Для создания статьи с горизонтальным фильтром выполните процедуру sp_addarticle (Transact-SQL) без аргумента filter. Выполните подписку sp_articlefilter, указав все аргументы, включая filter_clause, затем выполните подписку sp_articleview (Transact-SQL), указав все аргументы, включая точно такой же filter_clause. Если фильтр уже существует и значением type в sysarticles является 1 (статья на основе журнала), предыдущий фильтр удаляется, и создается новый фильтр.

Если аргументы filter_name и filter_clause не указаны, предыдущий фильтр удаляется, а в качестве идентификатора фильтра указывается 0.

Пример

DECLARE @publication    AS sysname;
DECLARE @table AS sysname;
DECLARE @filterclause AS nvarchar(500);
DECLARE @filtername AS nvarchar(386);
DECLARE @schemaowner AS sysname;
SET @publication = N'AdvWorksProductTran'; 
SET @table = N'Product';
SET @filterclause = N'[DiscontinuedDate] IS NULL'; 
SET @filtername = N'filter_out_discontinued';
SET @schemaowner = N'Production';

-- Add a horizontally and vertically filtered article for the Product table.
-- Manually set @schema_option to ensure that the Production schema 
-- is generated at the Subscriber (0x8000000).
EXEC sp_addarticle 
    @publication = @publication, 
    @article = @table, 
    @source_object = @table,
    @source_owner = @schemaowner, 
    @schema_option = 0x80030F3,
    @vertical_partition = N'true', 
    @type = N'logbased',
    @filter_clause = @filterclause;

-- (Optional) Manually call the stored procedure to create the 
-- horizontal filtering stored procedure. Since the type is 
-- 'logbased', this stored procedures is executed automatically.
EXEC sp_articlefilter 
    @publication = @publication, 
    @article = @table, 
    @filter_clause = @filterclause, 
    @filter_name = @filtername;

-- Add all columns to the article.
EXEC sp_articlecolumn 
    @publication = @publication, 
    @article = @table;

-- Remove the DaysToManufacture column from the article
EXEC sp_articlecolumn 
    @publication = @publication, 
    @article = @table, 
    @column = N'DaysToManufacture', 
    @operation = N'drop';

-- (Optional) Manually call the stored procedure to create the 
-- vertical filtering view. Since the type is 'logbased', 
-- this stored procedures is executed automatically.
EXEC sp_articleview 
    @publication = @publication, 
    @article = @table,
    @filter_clause = @filterclause;
GO

Разрешения

Только члены предопределенной роли сервера sysadmin или предопределенной роли базы данных db_owner могут выполнять процедуру sp_articlefilter.