sp_MSchange_snapshot_agent_properties (Transact-SQL)

更改在 Microsoft SQL Server 2005 或更高版本分发服务器上运行的快照代理作业的属性。 当发布服务器在 Microsoft SQL Server 2000 实例上运行时，此存储过程用于更改属性。 此存储过程在分发服务器上对分发数据库执行。

Transact-SQL 语法约定

语法

sp_MSchange_snapshot_agent_properties [ @publisher = ] 'publisher' 
        , [ @publisher_db = ] 'publisher_db' 
        , [ @publication = ] 'publication'  
        , [ @frequency_type= ] frequency_type 
        , [ @frequency_interval= ] frequency_interval 
        , [ @frequency_subday= ] frequency_subday 
        , [ @frequency_subday_interval= ] frequency_subday_interval 
        , [ @frequency_relative_interval= ] frequency_relative_interval 
        , [ @frequency_recurrence_factor= ] frequency_recurrence_factor 
        , [ @active_start_date= ] active_start_date 
        , [ @active_end_date= ] active_end_date 
        , [ @active_start_time_of_day= ] active_start_time_of_day 
        , [ @active_end_time_of_day= ] active_end_time_of_day 
        , [ @snapshot_job_name = ] 'snapshot_agent_name' 
        , [ @publisher_security_mode = ] publisher_security_mode 
        , [ @publisher_login = ] 'publisher_login' 
        , [ @publisher_password = ] 'publisher_password'  
        , [ @job_login = ] 'job_login' 
        , [ @job_password = ] 'job_password' 
        , [ @publisher_type = ] 'publisher_type'

参数

• [ @publisher = ] 'publisher'
  发布服务器的名称。 publisher 的数据类型为 sysname，无默认值。

• [ @publisher_db= ] 'publisher_db'
  发布数据库的名称。 publisher_db 的数据类型为 sysname，无默认值。

• [ @publication = ] 'publication'
  发布的名称。 publication 的数据类型为 sysname，无默认值。

• [ @frequency_type = ] frequency_type
  执行快照代理的频率。 frequency_type 的数据类型为 int，它可以为以下值之一。

  值	说明
  1	一次
  2	按需
  4	每天
  8	每周
  10	每月
  20	每月，相对于频率间隔
  40	当 SQL Server 代理启动时

• [ @frequency_interval = ] frequency_interval
  应用到 frequency_type 所设置频率的值。 frequency_interval 的数据类型为 int，无默认值。

• [ @frequency_subday = ] frequency_subday
  是 freq_subday_interval 的单位。 frequency_subday 的数据类型为 int，可以为下列值之一。

  值	说明
  1	一次
  2	秒
  4	分钟
  8	小时

• [ @frequency_subday_interval=] frequency_subday_interval
  是 frequency_subday 的时间间隔。 frequency_subday_interval 的数据类型为 int，无默认值。

• [ @frequency_relative_interval = ] frequency_relative_interval
  快照代理运行的日期。 frequency_relative_interval 的数据类型为 int，无默认值。

• [ @frequency_recurrence_factor = ] frequency_recurrence_factor
  是 frequency_type 使用的重复因子。 frequency_recurrence_factor 的数据类型为 int，无默认值。

• [ @active_start_date = ] active_start_date
  第一次安排快照代理的日期，格式为 YYYYMMDD。 active_start_date 的数据类型为 int，无默认值。

• [ @active_end_date = ] active_end_date
  停止安排快照代理的日期，格式为 YYYYMMDD。 active_end_date 的数据类型为 int，无默认值。

• [ @active_start_time_of_day=] active_start_time_of_day
  第一次安排快照代理的时间，格式为 HHMMSS。 active_start_time_of_day 的数据类型为 int，无默认值。

• [ @active_end_time_of_day=] active_end_time_of_day
  停止安排快照代理的时间，格式为 HHMMSS。 active_end_time_of_day 的数据类型为 int，无默认值。

• [ @snapshot_job_name = ] 'snapshot_agent_name'
  使用现有作业时现有快照代理作业的名称。 snapshot_agent_name 的数据类型为 nvarchar(100)，无默认值。

• [ @publisher_security_mode= ] publisher_security_mode
  连接到发布服务器时代理所使用的安全模式。 publisher_security_mode 的数据类型为 int，无默认值。 0 指定 SQL Server 身份验证，1 指定 Windows 身份验证。 对于非 SQL Server 发布服务器，必须将该值指定为 0。请尽可能使用 Windows 身份验证。

• [ @publisher_login= ] 'publisher_login'
  连接到发布服务器时所使用的登录名。 publisher_login 的数据类型为 sysname，无默认值。 在 publisher_security_mode 为 0 时，必须指定 publisher_login。 如果 publisher_login 的值为 NULL 且 publisher*_*security_mode 的值为 1，则连接到发布服务器时，将使用 job_login 中指定的 Windows 帐户。

• [ @publisher_password= ] 'publisher_password'
  连接到发布服务器时所使用的密码。 publisher_password 的数据类型为 nvarchar(524)，无默认值。

  安全说明
  请不要将身份验证信息存储在脚本文件中。 为了提高安全性，建议您在运行时提供登录名和密码。

• [ @job_login= ] 'job_login'
  用于运行代理的 Windows 帐户的登录名。 job_login 的数据类型为 nvarchar(257)，无默认值。 此 Windows 帐户总是用于与分发服务器建立代理连接。 创建新的快照代理作业时，必须提供此参数。 对于非 SQL Server 发布服务器来说，这是无法更改的。

• [ @job_password= ] 'job_password'
  用于运行代理的 Windows 帐户的密码。 job_password 的数据类型为 sysname，无默认值。 创建新的快照代理作业时，必须提供此参数。

  安全说明
  请不要将身份验证信息存储在脚本文件中。 为了提高安全性，建议您在运行时提供登录名和密码。

• [ @publisher_type= ] 'publisher_type'
  当发布服务器未在 SQL Server 的实例中运行时指定该发布服务器类型。 publisher_type 的数据类型为 sysname，可以为以下值之一。

  值	说明
  MSSQLSERVER	指定 SQL Server 发布服务器。
  ORACLE	指定标准的 Oracle 发布服务器。
  ORACLE GATEWAY	指定 Oracle 网关发布服务器。

  有关 Oracle 发布服务器与 Oracle 网关发布服务器之间区别的详细信息，请参阅Oracle 发布概述。

返回代码值

0（成功）或 1（失败）

注释

sp_MSchange_snapshot_agent_properties 用于快照复制、事务复制及合并复制。

执行 sp_MSchange_snapshot_agent_properties 时，必须指定所有参数。 执行 sp_helppublication_snapshot 可以返回快照代理作业的当前属性。

当发布服务器在 SQL Server 2005 或更高版本的实例上运行时，应使用 sp_changepublication_snapshot 更改快照代理作业的属性。

权限

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

请参阅

参考

sp_addpublication_snapshot (Transact-SQL)