sp_MSchange_snapshot_agent_properties (Transact-SQL)

适用范围:SQL Server

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

Transact-SQL 语法约定

语法

sp_MSchange_snapshot_agent_properties
    [ @publisher = ] N'publisher'
    , [ @publisher_db = ] N'publisher_db'
    , [ @publication = ] N'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 = ] N'snapshot_job_name'
    , [ @publisher_security_mode = ] publisher_security_mode
    , [ @publisher_login = ] N'publisher_login'
    , [ @publisher_password = ] N'publisher_password'
    , [ @job_login = ] N'job_login'
    , [ @job_password = ] N'job_password'
    , [ @publisher_type = ] N'publisher_type'
[ ; ]

参数

[ @publisher = ] N'publisher'

发布服务器的名称。 @publisher为 sysname,无默认值。

[ @publisher_db = ] N'publisher_db'

发布数据库的名称。 @publisher_dbsysname,无默认值。

[ @publication = ] N'publication'

发布的名称。 @publicationsysname,无默认值。

[ @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

@frequency_subday_interval单位。 @frequency_subdayint,可以是以下值之一。

说明
1 一次
2 Second
4 Minute
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 = ] N'snapshot_job_name'

使用现有作业时,现有快照代理作业名称的名称。 @snapshot_job_namenvarchar(100),没有默认值。

[ @publisher_security_mode = ] publisher_security_mode

连接到发布服务器时代理使用的安全模式。 @publisher_security_modeint,无默认值。 必须为非 SQL Server 发布服务器指定值 0

  • 0 指定 SQL Server 身份验证
  • 1指定Windows 身份验证

请尽可能使用 Windows 身份验证。

[ @publisher_login = ] N'publisher_login'

连接发布服务器时所使用的登录名。 @publisher_loginsysname,无默认值。 当@publisher_security_mode为0,必须指定@publisher_login。 如果@publisher_loginNULL@publisher_security_mode1,则在连接到发布服务器时使用@job_login中指定的 Windows 帐户。

[ @publisher_password = ] N'publisher_password'

连接到发布服务器时使用的密码。 @publisher_password为 nvarchar(524),没有默认值。

重要

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

[ @job_login = ] N'job_login'

运行代理的 Windows 帐户的登录名。 @job_login为 nvarchar(257),没有默认值。 此 Windows 帐户总是用于与分发服务器建立代理连接。 创建新的快照代理作业时,必须提供此参数。 对于非 SQL Server 发布服务器,无法更改此属性。

[ @job_password = ] N'job_password'

运行代理的 Windows 帐户的密码。 @job_password为 sysname,无默认值。 创建新的快照代理作业时,必须提供此参数。

重要

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

[ @publisher_type = ] N'publisher_type'

指定发布服务器未在 SQL Server 实例中运行时的发布服务器类型。 @publisher_typesysname,可以是以下值之一。

说明
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以返回快照代理作业的当前属性。

可以在发布服务器上使用sp_changepublication_snapshot来更改快照代理作业的属性。

权限

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