sp_dropsubscription (Transact-SQL)

パブリッシャ上の特定のアーティクル、パブリケーション、またはサブスクリプションの集合へのサブスクリプションを削除します。このストアド プロシージャは、パブリッシャ側でパブリケーション データベースについて実行されます。

トピック リンク アイコンTransact-SQL 構文表記規則

構文

sp_dropsubscription [ [ @publication= ] 'publication' ]
    [ , [ @article= ] 'article' ]
        , [ @subscriber= ] 'subscriber'
    [ , [ @destination_db= ] 'destination_db' ]
    [ , [ @ignore_distributor = ] ignore_distributor ]
    [ , [ @reserved= ] 'reserved' ]

引数

  • [ @publication= ] 'publication'
    関連付けられているパブリケーションの名前を指定します。publication のデータ型は sysname で、既定値は NULL です。all の場合は、指定したサブスクライバに対応するすべてのパブリケーションのすべてのサブスクリプションがキャンセルされます。publication は必須パラメータです。

  • [ @article= ] 'article'
    アーティクルの名前を指定します。article のデータ型は sysname で、既定値は NULL です。all を指定する場合、指定した各パブリケーションと各サブスクライバのすべてのアーティクルのサブスクリプションが削除されます。all は、即時更新を許可するパブリケーションに対して使用してください。

  • [ @subscriber= ] 'subscriber'
    削除するサブスクリプションがあるサブスクライバの名前です。subscriber のデータ型は sysname で、既定値はありません。all を指定する場合、すべてのサブスクライバのすべてのサブスクリプションが削除されます。

  • [ @destination_db= ] 'destination_db'
    対象となるデータベースの名前を指定します。destination_db のデータ型は sysname で、既定値は NULL です。NULL を指定する場合、そのサブスクライバからすべてのサブスクリプションが削除されます。

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

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

リターン コード値

成功した場合は 0 を、失敗した場合は 1 をそれぞれ返します。

説明

sp_dropsubscription は、スナップショット レプリケーションおよびトランザクション レプリケーションで使用します。

即時同期パブリケーションでアーティクルのサブスクリプションを削除した場合は、パブリケーション内のすべてのアーティクルのサブスクリプションを削除するのと同時に、これらすべてのサブスクリプションを追加し直さない限り、元に戻すことはできません。

使用例

-- This script uses sqlcmd scripting variables. They are in the form
-- $(MyVariable). For information about how to use scripting variables  
-- on the command line and in SQL Server Management Studio, see the 
-- "Executing Replication Scripts" section in the topic
-- "Programming Replication Using System Stored Procedures".

-- This batch is executed at the Publisher to remove 
-- a pull or push subscription to a transactional publication.
DECLARE @publication AS sysname;
DECLARE @subscriber AS sysname;
SET @publication = N'AdvWorksProductTran';
SET @subscriber = $(SubServer);

USE [AdventureWorks]
EXEC sp_dropsubscription 
  @publication = @publication, 
  @article = N'all',
  @subscriber = @subscriber;
GO

権限

sp_dropsubscription を実行できるのは、固定サーバー ロール sysadmin か固定データベース ロール db_owner のメンバ、またはそのサブスクリプションの作成者だけです。