sp_add_agent_profile (Transact-SQL)

  • Статья

Область применения: SQL Server Управляемый экземпляр SQL Azure

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

Соглашения о синтаксисе Transact-SQL

Синтаксис

sp_add_agent_profile [ [ @profile_id = ] profile_id OUTPUT ]
      , [ @profile_name = ] 'profile_name'
      , [ @agent_type = ] agent_type
    [ , [ @profile_type = ] profile_type ]
    [ , [ @description = ] N'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. Только SQL Server создает системные профили.

[ @description = ] N'description'

Описание профиля. @description — nvarchar(3000), без значения по умолчанию.

[ @default = ] по умолчанию

Указывает, является ли профиль по умолчанию для @agent_type. @default бит с значением по умолчанию0. 1 указывает, что добавляемый профиль станет новым профилем по умолчанию для агента, указанного @agent_type.

Значения кода возврата

0 (успешно) или 1 (сбой).

Замечания

sp_add_agent_profile используется в репликации моментальных снимков, репликации транзакций и репликации слиянием.

Пользовательские профили агента добавляются со значениями параметров агента по умолчанию. Используйте sp_change_agent_parameter для изменения этих значений по умолчанию или sp_add_agent_parameter для добавления дополнительных параметров.

При sp_add_agent_profile выполнении строка добавляется для нового пользовательского профиля в таблице MSagent_profiles, а связанные параметры по умолчанию для этого профиля добавляются в таблицу MSagent_parameters.

Разрешения

Могут выполняться sp_add_agent_profileтолько члены предопределенных ролей сервера sysadmin.

Связанный контент