sp_add_agent_profile (Transact-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= ] '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,預設值是 01 表示加入的設定檔將成為 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) 資料表中。

權限

只有系統管理員 (sysadmin) 固定伺服器角色的成員,才能夠執行 sp_add_agent_profile