sp_articlecolumn (Transact-SQL)

適用対象: SQL サーバー

アーティクルに含まれる列を指定して、パブリッシュされたテーブル内のデータを垂直方向にフィルター処理するために使用します。 このストアド プロシージャは、パブリッシャー側のパブリケーション データベースで実行されます。

Transact-SQL 構文表記規則

構文

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

引数

[ @publication = ] N'publication'

この記事を含むパブリケーションの名前。 @publicationsysname で、既定値はありません。

[ @article = ] N'article'

アーティクルの名前。 @articlesysname で、既定値はありません。

[ @column = ] N'column'

追加または削除する列の名前。 @columnsysname で、既定値は NULL です。 NULL場合、すべての列がパブリッシュされます。

[ @operation = ] N'operation'

アーティクルの列を追加するか削除するかを指定します。 @operationnvarchar(5) で、既定値は add です。

  • add は、レプリケーションの列をマークします。
  • drop 列のマークを解除します。

[ @refresh_synctran_procs = ] refresh_synctran_procs

レプリケートされた列数と一致するように、即時更新サブスクリプションをサポートするストアド プロシージャを再生成するかどうかを指定します。 @refresh_synctran_procsbit で、既定値は 1 です。 1場合、ストアド プロシージャは再生成されます。

[ @ignore_distributor = ] ignore_distributor

このストアド プロシージャがディストリビューターに接続せずに実行されるかどうかを示します。 @ignore_distributorbit で、既定値は 0 です。

  • 0場合は、データベースの発行を有効にする必要があり、アーティクルによってレプリケートされた新しい列を反映するようにアーティクル キャッシュを更新する必要があります。
  • 1場合は、発行されていないデータベースに存在するアーティクルのアーティクル列を削除できます。回復状況でのみ使用する必要があります。

[ @change_active = ] change_active

サブスクリプションを持つパブリケーションの列の変更を許可します。 @change_activeint で、既定値は 0 です。

  • 0場合、列は変更されません。
  • 1場合は、サブスクリプションを持つアクティブなアーティクルから列を追加または削除できます。

[ @force_invalidate_snapshot = ] force_invalidate_snapshot

このストアド プロシージャによって実行されたアクションによって、既存のスナップショットが無効になる可能性があることを確認します。 @force_invalidate_snapshotビットで、既定値は 0 です。

  • 0 は、アーティクルに対する変更によってスナップショットが無効になることがないように指定します。 ストアド プロシージャが変更に新しいスナップショットが必要であることを検出した場合、エラーが発生し、変更は行われません。
  • 1 は、アーティクルに対する変更によってスナップショットが無効になる可能性があることを指定します。また、新しいスナップショットを必要とする既存のサブスクリプションがある場合は、既存のスナップショットを古いスナップショットとしてマークし、新しいスナップショットを生成するためのアクセス許可を付与します。

[ @force_reinit_subscription = ] force_reinit_subscription

このストアド プロシージャによって実行されるアクションで、既存のサブスクリプションの再初期化が必要になる可能性があることを確認します。 @force_reinit_subscriptionbit で、既定値は 0 です。

  • 0 は、アーティクルに対する変更によってサブスクリプションが再初期化されないように指定します。 変更によってサブスクリプションの再初期化が必要であることがストアド プロシージャによって検出された場合、エラーが発生し、変更は行われません。
  • 1 は、アーティクルに変更を加えて既存のサブスクリプションを再初期化し、サブスクリプションの再初期化を実行するためのアクセス許可を付与することを指定します。

[ @publisher = ] N'publisher'

SQL Server 以外のパブリッシャーを指定します。 @publishersysname で、既定値は NULL です。

@publisher SQL Server パブリッシャーでは使用しないでください。

[ @internal = ] internal

単に情報を示すためだけに特定されます。 サポートされていません。 将来の互換性は保証されません。

リターン コードの値

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を実行できます。