sp_add_agent_profile (Transact-SQL)

  • [アーティクル]

適用対象: SQL ServerAzure SQL Managed Instance

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

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

新しく挿入されたプロファイルに関連付けられている ID。 @profile_idは int であり、省略可能な OUTPUT パラメーターです。 指定した場合、値は新しいプロファイル ID に設定されます。

[ @profile_name = ] 'profile_name'

プロファイルの名前。 @profile_nameは sysname で、既定値はありません。

[ @agent_type = ] agent_type

レプリケーション エージェントの種類。 @agent_typeは int で、既定値はなく、これらの値のいずれかを指定できます。

Value 説明
1 スナップショット エージェント
2 ログ リーダー エージェント (Log Reader Agent)
3 ディストリビューション エージェント
4 [マージ エージェント]
9 キュー リーダー エージェント (Queue Reader Agent)

[ @profile_type = ] profile_type

プロファイルの種類。 profile_typeは int で、既定値は 1.

0 はシステム プロファイルを示します。 1 はカスタム プロファイルを示します。 このストアド プロシージャを使用して作成できるのはカスタム プロファイルだけです。したがって、唯一の有効な値は .1 システム プロファイルを作成するのは SQL Server だけです。

[ @description = ] N'description'

プロファイルの説明です。 @descriptionは nvarchar(3000) で、既定値はありません。

[ @default = ] 既定値

プロファイルが@agent_typeの既定値かどうかを示します。 @defaultはビットで、既定値は 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) テーブルに追加されます。

アクセス許可

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

関連するコンテンツ