sp_expired_subscription_cleanup (Transact-SQL)

Applies to: SQL Server

Checks the status of all the subscriptions of every publication and drops subscriptions that are expired. This stored procedure is executed at the Publisher on any database, or at the Distributor on the distribution database for a non-SQL Server Publisher.

Transact-SQL syntax conventions

Syntax

sp_expired_subscription_cleanup [ [ @publisher = ] N'publisher' ]
[ ; ]

Arguments

[ @publisher = ] N'publisher'

The name of a non-SQL Server publisher. @publisher is sysname, with a default of NULL. You shouldn't specify this parameter for a SQL Server Publisher.

Return code values

0 (success) or 1 (failure).

Remarks

sp_expired_subscription_cleanup is used in all types of replication.

The Expired Subscription Clean Up job runs sp_expired_subscription_cleanup to detect and remove expired subscriptions from publication databases every 24 hours. If any of the subscriptions are out-of-date, that is, aren't synchronized with the Publisher within the retention period, the publication is declared expired, and the traces of the subscription are cleaned up at the Publisher. For more information, see Subscription Expiration and Deactivation.

Permissions

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