sp_add_agent_profile (Transact-SQL)

Статья
05/08/2013

Создает новый профиль для агента репликации. Эта хранимая процедура выполняется на распространителе в любой базе данных.

Значок ссылки на раздел Синтаксические обозначения в 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
Идентификатор, связанный с вновь вставленным профилем. Аргумент profile_id имеет тип int и является необязательным параметром «OUTPUT». Если он указан, в качестве его значения устанавливается новый идентификатор профиля.
[ @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).