次の方法で共有

sp_add_agent_profile (Transact-SQL)

  • [アーティクル]

適用対象: SQL Server Azure 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. の種類profile_type は int で、既定値は 1 です。

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

[ @description = ] N'description'

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

[ @default = ] 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を実行できます。

関連するコンテンツ