删除日志传送计划。

语法

sp_delete_log_shipping_plan [ @plan_id = ] plan_id |

    [ @plan_name = ] 'plan_name'

    [ , [ @del_plan_db = ] del_plan_db ]

参数

[@plan_id =] plan_id

要删除的计划的标识号。plan_id 的数据类型为 uniqueidentifier，默认值为 NULL。

[@plan_name =] 'plan_name'

要删除的计划的名称。Plan_name 的数据类型为 sysname，默认值为 NULL。

说明  必须指定 plan_id 或者 plan_name，但不能两者都指定。

[@del_plan_db =] del_plan_db

指定将删除属于此计划的 log_shipping_databases 表的所有行。del_plan_db 的数据类型为 bit，默认值为 0。

返回代码值

0（成功）或 1（失败）

注释

如果 log_shipping_databases 表中没有相应行，则 del_plan_db 必须设置为 1。否则存储过程将失败。

权限

只有 sysadmin 固定服务器角色的成员才能执行 sp_delete_log_shipping_plan。

示例

以下示例将删除计划"Pubs 数据库备份"及添加到该计划中的任何数据库。

EXEC   msdb.dbo.sp_delete_log_shipping_plan @plan_name = N'Pubs database backup', @del_plan_db = 1