创建新的日志传送计划。在 log_shipping_plans 表中插入一行。

语法

sp_add_log_shipping_plan [ @plan_name = ] 'plan_name' ,

    [ @description = ] 'description' ,

    [ @source_server = ] 'source_server' ,

    [ @source_dir = ] 'source_dir' ,

    [ @destination_dir = ] 'destination_dir' ,

    [ @history_retention_period = ] history_retention_period ,

    [ @file_retention_period = ] file_retention_period ,

    [ @copy_frequency = ] copy_frequency ,

    [ @restore_frequency = ] restore_frequency ,

    [ @plan_id = ] plan_id OUTPUT

参数

[@plan_name =] 'plan_name'

计划的名称。此名称必须唯一，不能含有百分比 (%) 字符。plan_name 的数据类型为 sysname，没有默认设置。

[@description =] 'description'

计划的描述。description 的数据类型为 nvarchar(500)，默认设置为 NULL。

[@source_server =] 'source_server'

源服务器的名称。source_server 的数据类型为 sysname。

[@source_dir =] 'source_dir'

事务日志文件将被复制到目录的完整路径。source_dir 的数据类型为 nvarchar(500)。

[@destination_dir =] 'destination_dir'

事务日志将要复制到的目录。destination_dir 的数据类型为 nvarchar(500)。

[@history_retention_period =] history_retention_period

历史记录被删除前保留在 log_shipping_history 表中的时间，单位为分钟。history_retention_period 的数据类型为 int，默认设置为 2,880 分钟（两天）。

[@file_retention_period =] file_retention_period

在删除之前将日志记录文件存储在第二个服务器上的时间长度，以分钟单位。file_retention_period 的数据类型为 int，默认值为 2,880 分钟（两天）。

[@copy_frequency =] copy_frequency

复制计划的频率，单位为分钟。copy_frequency 的数据类型为 int，默认设置为 5 分钟。

[@restore_frequency =] restore_frequency

计划的还原作业发生的频率，单位为分钟。restore_frequency 的数据类型为 int，默认设置为 5 分钟。

[@plan_id =] plan_id OUTPUT

指派给成功创建的计划的计划标识号。plan_id 是 uniqueidentifier 类型的输出变量，默认设置为 NULL。

返回代码值

0（成功）或 1（失败）

注释

sp_add_log_shipping_plan 也可用于创建两个作业以执行该计划的复制和装载。

在成功执行 sp_add_log_shipping_plan 后，可以执行 sp_add_log_shipping plan_database 以将数据库添加到计划中。

权限

只有 sysadmin 固定服务器角色的成员才可以执行 sp_add_log_shipping_plan。

示例

EXEC   msdb.dbo.sp_add_log_shipping_plan
   @plan_name=N'Pubs database backup'
   @description= N'Log shipping the pubs database',
   @source_server= N'my_source',
   @source_dir= N'\\my_source\pubs_logshipping',
   @destination_dir= N'c:\logshipping\pubs',
   @history_retention_period= 60,  -- 1 hour
   @file_retention_period= 1440,  -- 1 day
   @copy_frequency= 10,  -- copy files every 10 minutes
   @restore_frequency= 30  -- load files every 30 minutes