sp_changearticle (Transact-SQL)

適用対象: SQL Server Azure SQL Managed Instance

トランザクション パブリケーションまたはスナップショット パブリケーション内のアーティクルのプロパティを変更します。 このストアド プロシージャは、パブリッシャー側のパブリケーション データベースで実行されます。

Transact-SQL 構文表記規則

構文

sp_changearticle
    [ [ @publication = ] N'publication' ]
    [ , [ @article = ] N'article' ]
    [ , [ @property = ] N'property' ]
    [ , [ @value = ] N'value' ]
    [ , [ @force_invalidate_snapshot = ] force_invalidate_snapshot ]
    [ , [ @force_reinit_subscription = ] force_reinit_subscription ]
    [ , [ @publisher = ] N'publisher' ]
[ ; ]

引数

[ @publication = ] N'publication'

アーティクルを含むパブリケーションの名前。 @publication は sysname で、既定値は NULL です。

[ @article = ] N'article'

プロパティを変更するアーティクルの名前。 @article は sysname で、既定値は NULL です。

[ @property = ] N'property'

変更するアーティクル プロパティ。 @property は nvarchar(100) で、既定値は NULL です。

[ @value = ] N'value'

アーティクル プロパティの新しい値。 @value は nvarchar(255) で、既定値は NULL です。

次の表では、アーティクルのプロパティとそれらのプロパティの値について説明します。

[ @force_invalidate_snapshot = ] force_invalidate_snapshot

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

0 は、アーティクルに対する変更によってスナップショットが無効になることがないように指定します。 ストアド プロシージャが変更に新しいスナップショットが必要であることを検出した場合、エラーが発生し、変更は行われません。

1 は、アーティクルに対する変更によってスナップショットが無効になる可能性があることを指定します。また、新しいスナップショットを必要とする既存のサブスクリプションがある場合は、既存のスナップショットを古いスナップショットとしてマークし、新しいスナップショットを生成するためのアクセス許可を付与します。

変更時に新しいスナップショットの生成が必要なプロパティについては、「 Remarks 」セクションを参照してください。

[ @force_reinit_subscription = ] force_reinit_subscription

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

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

1 は、アーティクルに変更を加えて既存のサブスクリプションを再初期化し、サブスクリプションの再初期化を実行するためのアクセス許可を付与することを指定します。

変更時に既存のすべてのサブスクリプションを再初期化する必要があるプロパティについては、「 Remarks 」セクションを参照してください。

[ @publisher = ] N'publisher'

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

リターン コードの値

0 (成功) または 1 (失敗)。

解説

sp_changearticle は、スナップショット レプリケーションとトランザクション レプリケーションで使用されます。

アーティクルがピア ツー ピア トランザクション レプリケーションをサポートするパブリケーションに属している場合は、 description、 ins_cmd、 upd_cmd、および del_cmd のプロパティのみを変更できます。

次のいずれかのプロパティを変更するには、新しいスナップショットが生成される必要があります。また、@force_invalidate_snapshot パラメーターに 1 の値を指定する必要があります。

• del_cmd
• dest_table
• destination_owner
• ins_cmd
• pre_creation_cmd
• schema_options
• upd_cmd

次のいずれかのプロパティを変更するには、既存のサブスクリプションを再初期化する必要があり、@force_reinit_subscription パラメーターに 1 の値を指定する必要があります。

• del_cmd
• dest_table
• destination_owner
• filter
• ins_cmd
• status
• upd_cmd

既存のパブリケーション内では、 sp_changearticle を使用してアーティクルを変更できます。パブリケーション全体を削除して再作成する必要はありません。

有効なスキーマ オプション

次の表では、レプリケーションの種類 (上部に表示) とアーティクルの種類 (最初の列の下に表示) に基づいて、 schema_option の許容値について説明します。

例

DECLARE @publication AS sysname;
DECLARE @article AS sysname;
DECLARE @option AS int;
SET @publication = N'AdvWorksProductTran';
SET @article = N'Product';
SET @option = (SELECT CAST(0x0000000002030073 AS int));

-- Change the schema options to replicate schema with XML.
USE [AdventureWorks2022]
EXEC sp_changearticle 
  @publication = @publication,
  @article = @article, 
  @property = N'schema_option', 
  @value = @option,
  @force_invalidate_snapshot = 1;
GO

アクセス許可

sysadmin固定サーバー ロールまたは固定データベース ロールdb_ownerのメンバーのみがsp_changearticleを実行できます。

関連するコンテンツ

• アーティクルのプロパティの表示と変更
• パブリケーションおよびアーティクルのプロパティの変更
• sp_addarticle (Transact-SQL)
• sp_articlecolumn (Transact-SQL)
• sp_droparticle (Transact-SQL)
• sp_helparticle (Transact-SQL)
• sp_helparticlecolumns (Transact-SQL)