sp_add_agent_parameter (Transact-SQL)

  • 项目

适用于：SQL ServerAzure SQL 托管实例

将新参数及其值添加到代理配置文件中。 此存储过程在分发服务器上的任何数据库中执行。

Transact-SQL 语法约定

语法

sp_add_agent_parameter [ @profile_id = ] profile_id
        , [ @parameter_name = ] 'parameter_name'
        , [ @parameter_value = ] 'parameter_value'
[ ; ]

参数

[ @profile_id = ] profile_id

数据库中表的msdb配置文件MSagent_profiles的 ID。 @profile_id为 int，无默认值。

若要了解此@profile_id表示的代理类型，请在 MSagent_profiles （Transact-SQL） 表中查找@profile_id，并记下agent_type字段值。 这些值如下所示：

值 说明
1 快照代理
2 日志读取器代理
3 分发代理
4 合并代理
9 队列读取器代理

[ @parameter_name = ] 'parameter_name'

参数的名称。 @parameter_name 为 sysname，无默认值。 有关已在系统配置文件中定义的参数列表，请参阅 复制代理配置文件。 若要查看每个代理的有效参数的完整列表，请参阅下列主题：

[ @parameter_value = ] 'parameter_value'

要分配给参数的值。 @parameter_value 为 nvarchar（255），没有默认值。

返回代码值

0（成功）或 1（失败）。

备注

sp_add_agent_parameter用于快照 副本 (replica)、事务副本 (replica)和合并副本 (replica)。

权限

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

相关内容