sp_update_agent_profile (Transact-SQL)

適用対象: SQL Server

レプリケーション エージェントによって使用されるプロファイルを更新します。 このストアド プロシージャは、ディストリビューション データベースのディストリビューターで実行されます。

Transact-SQL 構文表記規則

構文

sp_update_agent_profile
    [ @agent_type = ] agent_type
    , [ @agent_id = ] agent_id
    , [ @profile_id = ] profile_id
[ ; ]

引数

[ @agent_type = ] agent_type

@agent_typeint で、既定値はありません。

エージェントの種類。 agent_type は既定値なしで int であり、これらの値のいずれかを指定できます。

Value 説明
1 スナップショット エージェント。
2 ログ リーダー エージェント。
3 ディストリビューション エージェント。
4 マージ エージェント。
9 キュー リーダー エージェント

[ @agent_id = ] agent_id

エージェントの ID。 @agent_idint で、既定値はありません。

[ @profile_id = ] profile_id

エージェントが使用するプロファイルの ID。 @profile_idint で、既定値はありません。 エージェントごとに定義されているプロファイルの一覧を表示するには、 sp_help_agent_profileを使用します。 システム プロファイルの詳細については、「 Replication エージェント プロファイルを参照してください。

リターン コードの値

0 (成功) または 1 (失敗)。

解説

sp_update_agent_profile は、すべての種類のレプリケーションで使用されます。

アクセス許可

sysadmin固定サーバー ロールのメンバーのみがsp_update_agent_profileを実行できます。