sp_add_agent_parameter (Transact-SQL)

  • Статья

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

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

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

Синтаксис

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

Аргументы

[ @profile_id = ] profile_id

Идентификатор профиля из MSagent_profiles таблицы в msdb базе данных. @profile_id не используется без значения по умолчанию.

Чтобы узнать, какой тип агента представляет этот @profile_id, найдите @profile_id в таблице MSagent_profiles и запишите 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 используется в репликации моментальных снимков, репликации транзакций и репликации слиянием.

Разрешения

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

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