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

資料庫中 MSagent_profiles 資料表中設定檔的 msdb 識別碼。 @profile_id為 int ，沒有預設值。

若要瞭解此 @profile_id 所代表的代理程式類型，請在 MSagent_profiles （Transact-SQL） 資料表中 尋找 @profile_id ，並記下 agent_type 域值。 其值如下：

值 Description
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 。

相關內容