sp_subscription_cleanup (Transact-SQL)

APPLIES TO: yesSQL Server noAzure SQL Database noAzure SQL Data Warehouse noParallel Data Warehouse

Removes metadata when a subscription is dropped at a Subscriber. For a synchronizing transaction subscription, it also includes immediate-updating triggers. This stored procedure is executed at the Subscriber on the subscription database.

Topic link icon Transact-SQL Syntax Conventions

Syntax

  
sp_subscription_cleanup [ @publisher = ] 'publisher'  
        , [ @publisher_db = ] 'publisher_db'  
    [ , [ @publication = ] 'publication']  
    [ , [ @reserved = ] 'reserved']  

Arguments

[ @publisher = ] 'publisher' Is the name of the Publisher. publisher is sysname, with no default.

[ @publisher_db = ] 'publisher_db' Is the name of the Publisher database. publisher_db is sysname, with no default.

[ @publication = ] 'publication' Is the name of the publication. publication is sysname, with a default of NULL. If NULL, subscriptions using a shared agent publication in the publishing database will be deleted.

[ @reserved = ] 'reserved'

Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.

Return Code Values

0 (success) or 1 (failure)

Remarks

sp_subscription_cleanup is used in transactional and snapshot replication.

Permissions

Only members of the sysadmin fixed server role or the db_owner fixed database role can execute sp_subscription_cleanup.

See Also

sp_expired_subscription_cleanup (Transact-SQL)
sp_mergesubscription_cleanup (Transact-SQL)
System Stored Procedures (Transact-SQL)