sp_add_agent_profile （Transact-SQL）

  • 發行項

適用於：SQL ServerAzure 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 = ] 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，沒有預設值，而且可以是下列其中一個值。

值 Description
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為 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） 數據表。

權限

只有系統管理員固定伺服器角色的成員才能執行 sp_add_agent_profile。

相關內容