sp_droppullsubscription (Transact-SQL)
Applies to: SQL Server Azure SQL Managed Instance
Drops a subscription at the current database of the Subscriber. This stored procedure is executed at the Subscriber on the pull subscription database.
Transact-SQL syntax conventions
Syntax
sp_droppullsubscription
[ @publisher = ] N'publisher'
[ , [ @publisher_db = ] N'publisher_db' ]
, [ @publication = ] N'publication'
[ , [ @reserved = ] reserved ]
[ , [ @from_backup = ] from_backup ]
[ ; ]
Arguments
[ @publisher = ] N'publisher'
The remote server name. @publisher is sysname, with no default. If all
, the subscription is dropped at all the Publishers.
[ @publisher_db = ] N'publisher_db'
The name of the Publisher database. @publisher_db is sysname, with a default of NULL
. all
means all the Publisher databases.
[ @publication = ] N'publication'
The publication name. @publication is sysname, with no default. If all
, the subscription is dropped to all the publications.
[ @reserved = ] reserved
Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.
[ @from_backup = ] from_backup
Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.
Return code values
0
(success) or 1
(failure).
Remarks
sp_droppullsubscription
is used in snapshot replication and transactional replication.
sp_droppullsubscription
deletes the corresponding row in the MSreplication_subscriptions table and the corresponding Distributor Agent at the Subscriber. If no rows are left in MSreplication_subscriptions, it drops the table.
Examples
-- 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 is the batch executed at the Subscriber to drop
-- a pull subscription to a transactional publication.
DECLARE @publication AS sysname;
DECLARE @publisher AS sysname;
DECLARE @publicationDB AS sysname;
SET @publication = N'AdvWorksProductTran';
SET @publisher = $(PubServer);
SET @publicationDB = N'AdventureWorks2022';
USE [AdventureWorks2022Replica]
EXEC sp_droppullsubscription
@publisher = @publisher,
@publisher_db = @publicationDB,
@publication = @publication;
GO
Permissions
Only members of the sysadmin fixed server role or the user who created the pull subscription can execute sp_droppullsubscription
. The db_owner fixed database role is only able to execute sp_droppullsubscription
if the user who created the pull subscription belongs to this role.