sp_add_agent_profile (Transact-SQL)

[アーティクル]
05/07/2013

レプリケーションエージェントの新しいプロファイルを作成します。このストアドプロシージャは、ディストリビューター側で任意のデータベースについて実行されます。

構文

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
新たに挿入されたプロファイルに関連付けられている ID を指定します。 profile_id のデータ型は int です。これは省略可能な OUTPUT パラメーターです。指定した場合、値が新しいプロファイル ID として設定されます。
[ @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 が唯一の有効な値です。 Microsoft SQL Server のみがシステムプロファイルを作成できます。
[ @description= ] 'description'
プロファイルの説明を指定します。 description のデータ型は nvarchar(3000) で、既定値はありません。
[ @default= ] 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 を実行できるのは、固定サーバーロール sysadmin のメンバーだけです。

次の方法で共有

sp_add_agent_profile (Transact-SQL)

構文

引数

戻り値

説明

権限

関連項目

参照

概念

その他のリソース