sp_articlefilter (Transact-SQL)

Применимо к: SQL Server (все поддерживаемые версии) Управляемый экземпляр SQL Azure

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

Topic link iconСинтаксические обозначения в 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' Имя публикации, содержащей статью. публикацияsysname без значения по умолчанию.

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

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

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

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

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

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

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

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

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

[ @publisher = ] 'publisher'Указывает издатель, отличный от корпорации Майкрософт SQL Server. Publishersysname с значением NULL по умолчанию.

Примечание

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

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

0 (успешно) или 1 (сбой)

Примечания

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

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

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

Чтобы создать статью с горизонтальным фильтром, выполните sp_addarticle (Transact-SQL) без параметра фильтра . Выполните sp_articlefilter, предоставляя все параметры, включая filter_clause, а затем выполните sp_articleview (Transact-SQL), предоставляя все параметры, включая идентичные filter_clause. Если фильтр уже существует и если тип в 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.

См. также:

Определение статьи
Определение и изменение статического строкового фильтра
sp_addarticle (Transact-SQL)
sp_articleview (Transact-SQL)
sp_changearticle (Transact-SQL)
sp_droparticle (Transact-SQL)
sp_helparticle (Transact-SQL)
Хранимые процедуры репликации (Transact-SQL)