sp_articlecolumn (Transact-SQL)

Статья
05/08/2013

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

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

Синтаксис

sp_articlecolumn [ @publication = ] 'publication' 
        , [ @article = ] 'article'
    [ , [ @column = ] 'column' ]
    [ , [ @operation = ] 'operation' ]
    [ , [ @refresh_synctran_procs = ] refresh_synctran_procs ]
    [ , [ @ignore_distributor = ] ignore_distributor ]
    [ , [ @change_active = ] change_actve ]
    [ , [ @force_invalidate_snapshot = ] force_invalidate_snapshot ]
    [ , [ @force_reinit_subscription = ] force_reinit_subscription ]
    [ , [ @publisher = ] 'publisher' ]
    [ , [ @internal = ] 'internal' ]

Аргументы

[ @publication=] 'publication'
Имя публикации, которая содержит эту статью. Аргумент publication имеет тип sysname и не имеет значения по умолчанию.
[ @article=] 'article'
Имя статьи. Аргумент article имеет тип sysname и не имеет значения по умолчанию.
[ @column=] 'column'
Имя столбца, который требуется добавить или удалить. Аргумент column имеет тип sysname и значение по умолчанию NULL. Если значение равно NULL, публикуются все столбцы.
[ @operation=] 'operation'
Указывает, следует ли добавлять или удалять столбцы из статьи. Аргумент operation имеет тип nvarchar(5) и значение по умолчанию add. Столбец для репликации помечается при помощи значения add. Значение drop снимает отметку для заданного столбца.
[ @refresh_synctran_procs=] refresh_synctran_procs
Указывает, формируются ли повторно хранимые процедуры, поддерживающие немедленно обновляемую подписку, для согласования с числом реплицируемых столбцов. Аргумент refresh_synctran_procs имеет тип bit и значение по умолчанию 1. Если значение равно 1, хранимые процедуры формируются повторно.
[ @ignore_distributor =] ignore_distributor
Указывает, выполняется ли данная хранимая процедура без подключения к распространителю. Аргумент ignore_distributor имеет тип bit и значение по умолчанию 0. Если значение равно 0, база данных должна быть включена для публикации, а кэш статей следует обновить для отображения новых столбцов, реплицируемых данной статьей. Значение, равное 1, позволяет удалять столбцы для статей, размещенных в неопубликованной базе данных; следует использовать только в ситуациях, связанных с восстановлением.
[ @change_active = ] change_active
Разрешает изменение столбцов в публикациях, на которые имеются подписки. Аргумент change_active имеет тип int и значение по умолчанию 0. Если значение равно 0, столбцы не изменяются. Если значение равно 1, можно добавлять или удалять столбцы из активных статей, на которые имеются подписки.
[ @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'
Задает издателя, отличного от Microsoft SQL Server. Аргумент publisher имеет тип sysname и значение по умолчанию NULL.

Примечание

Аргумент publisher не следует использовать на издателе SQL Server.
[ @internal= ] 'internal'
Только для внутреннего использования.

Примечание
Аргумент publisher не следует использовать на издателе SQL Server.

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

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

Замечания

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

С помощью процедуры sp_articlecolumn можно осуществить фильтрацию только статей без подписки.

Пример

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_articlecolumn.