通过

  • 项目

sp_add_agent_profile (Transact-SQL)

为复制代理创建新的配置文件。 此存储过程在分发服务器的任何数据库中执行。

主题链接图标Transact-SQL 语法约定

语法

sp_add_agent_profile [ [ @profile_id= ] profile_id OUTPUT ]
        , [ @profile_name= ] 'profile_name' 
        , [ @agent_type= ] 'agent_type' ] 
    [ , [ @profile_type= ] profile_type ]
    [ , [ @description= ] 'description' ]
    [ , [ @default= ] default ]

参数

  • [ @profile_id= ] profile_id
    与新插入的配置文件关联的 ID。profile_id 的数据类型为 int，并且是可选的 OUTPUT 参数。 如果指定该 ID，则值将设置为新的配置文件 ID。

  • [ @profile_name= ] 'profile_name'
    配置文件的名称。profile_name 的数据类型为 sysname，无默认值。

  • [ @agent_type= ] 'agent_type'
    复制代理的类型。agent_type 的数据类型为 int，无默认值，可以是下列值之一。

    值

    说明

    1

    快照代理

    2

    日志读取器代理

    3

    分发代理

    4

    合并代理

    9

    队列读取器代理

  • [ @profile_type= ] profile_type
    配置文件的类型。profile_type 的数据类型为 int，默认值为 1。

    0 指示系统配置文件。 1 指示自定义配置文件。 只能使用此存储过程创建自定义配置文件；因此，唯一有效的值是 1。 只有 MicrosoftSQL Server 才能创建系统配置文件。

  • [ @description =] 'description'
    配置文件的说明。description 的数据类型为 nvarchar(3000)，无默认值。

  • [ @default= ] default
    指示该配置文件是否为 agent_type *的默认配置文件。*default 的数据类型为 bit，默认值为 0。 1 指示对于 agent_type 指定的代理来说，要添加的配置文件将成为新的默认配置文件。

返回代码值

0（成功）或 1（失败）

注释

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

自定义代理配置文件与默认代理参数值一起添加。 使用 sp_change_agent_parameter (Transact-SQL) 可以更改这些默认值，使用 sp_add_agent_parameter (Transact-SQL) 可以添加其他参数。

执行 sp_add_agent_profile 时，将在 MSagent_profiles (Transact-SQL) 表中为新的自定义配置文件添加一行，并将该配置文件的相关默认参数添加到 MSagent_parameters (Transact-SQL) 表中。

权限

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