sp_cleanup_log_shipping_history (Transact-SQL)
Applies to: SQL Server
This stored procedure cleans up history locally, and on the monitor server, based on retention period.
Transact-SQL syntax conventions
sp_cleanup_log_shipping_history
[ @agent_id = ] 'agent_id'
, [ @agent_type = ] agent_type
[ ; ]
The primary ID for backup or the secondary ID for copy or restore. @agent_id is uniqueidentifier, with no default, and can't be NULL
.
The type of log shipping job. @agent_type is tinyint, with no default, and must be one of these values:
Value | Description |
---|---|
0 | Backup |
1 | Copy |
2 | Restore |
0
(success) or 1
(failure).
None.
sp_cleanup_log_shipping_history
must be run from the master
database on any log shipping server. This stored procedure cleans up local and remote copies of log_shipping_monitor_history_detail
and log_shipping_monitor_error_detail
based on history retention period.
Only members of the sysadmin fixed server role can run this procedure.