sp_add_agent_parameter (Transact-SQL)

  • [アーティクル]

エージェント プロファイルに新しいパラメータとその値を追加します。このストアド プロシージャは、任意のデータベース上のディストリビュータ側で実行されます。

トピック リンク アイコンTransact-SQL 構文表記規則

構文

sp_add_agent_parameter [ @profile_id = ] profile_id
        , [ @parameter_name = ] 'parameter_name' 
        , [ @parameter_value = ] 'parameter_value'

引数

  • [ @profile_id= ] profile_id
    msdb データベース内にある MSagent_profiles テーブルに基づいてプロファイルの ID を指定します。profile_id のデータ型は int で、既定値はありません。

    この profile_id が表すエージェントの種類を調べるには、MSagent_profiles (Transact-SQL) テーブルで profile_id を探し、agent_type フィールドの値を調べます。値は次のとおりです。

    値 説明

    1

    スナップショット エージェント

    2

    ログ リーダー エージェント

    3

    ディストリビューション エージェント

    4

    マージ エージェント

    9

    キュー リーダー エージェント
  • [ @parameter_value=] 'parameter_value'
    パラメータに割り当てる値を指定します。parameter_value のデータ型は nvarchar(255) で、既定値はありません。

解説

sp_add_agent_parameter は、スナップショット レプリケーション、トランザクション レプリケーション、およびマージ レプリケーションで使用します。

権限

sp_add_agent_parameter を実行できるのは、sysadmin 固定サーバー ロールのメンバだけです。

戻り値

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

参照

関連項目

sp_add_agent_profile (Transact-SQL)
sp_change_agent_profile (Transact-SQL)
sp_change_agent_parameter (Transact-SQL)
sp_drop_agent_parameter (Transact-SQL)
sp_help_agent_parameter (Transact-SQL)

その他の技術情報

レプリケーション エージェント プロファイルを扱う方法 (レプリケーション Transact-SQL プログラミング)
レプリケーション エージェント プロファイル

ヘルプおよび情報

SQL Server 2005 の参考資料の入手