sp_replmonitorhelpmergesession (Transact-SQL)

特定のレプリケーション マージ エージェントの過去のセッションに関する情報を返します。フィルタ選択基準に一致するセッションごとに 1 行が返されます。このストアド プロシージャは、マージ レプリケーションの監視に使用し、ディストリビュータ側でディストリビューション データベースについて実行されるか、サブスクライバ側でサブスクリプション データベースについて実行されます。

Transact-SQL 構文表記規則

構文

sp_replmonitorhelpmergesession [ [ @agent_name = ] 'agent_name' ]
    [ , [ @hours = ] hours ]
    [ , [ @session_type = ] session_type ]
    [ , [ @publisher = ] 'publisher' ]
    [ , [ @publisher_db = ] 'publisher_db' ]
    [ , [ @publication = ] 'publication' ] 

引数

• [ @agent_name = ] 'agent_name'
  エージェントの名前を指定します。agent_name のデータ型は nvarchar(100) で、既定値はありません。

• [ @hours = ] hours
  履歴エージェント セッション情報を返す時間の範囲を時間単位で指定します。hours のデータ型は int で、次のいずれかの範囲を指定できます。

  値	説明
  < 0	過去のエージェント実行に関する情報を、最大 100 回分まで返します。
  0 (既定値)	過去のすべてのエージェント実行に関する情報を返します。
  > 0	過去 hours 時間内に発生したエージェント実行に関する情報を返します。

• [ @session_type = ] session_type
  セッションの終了結果に応じて結果セットにフィルタを適用します。session_type のデータ型は int で、次のいずれかの値を指定できます。

  値	説明
  1 (既定値)	再試行されたか成功したエージェント セッション。
  0	失敗したエージェント セッション。

• [ @publisher = ] 'publisher'
  パブリッシャの名前を指定します。publisher のデータ型は sysname で、既定値は NULL です。このパラメータは、サブスクライバ側で sp_replmonitorhelpmergesession を実行するときに使用します。

• [ @publisher_db = ] 'publisher_db'
  パブリケーション データベースの名前を指定します。publisher_db のデータ型は sysname で、既定値は NULL です。このパラメータは、サブスクライバ側で sp_replmonitorhelpmergesession を実行するときに使用します。

• [ @publication= ] 'publication'
  パブリケーションの名前を指定します。publication のデータ型は sysname で、既定値は NULL です。このパラメータは、サブスクライバ側で sp_replmonitorhelpmergesession を実行するときに使用します。

結果セット

列名	データ型	説明
Session_id	int	エージェント ジョブ セッションの ID。
Status	int	エージェント実行状態。 1 = 開始 2 = 成功 3 = 実行中 4 = アイドル 5 = 再試行 6 = 失敗
StartTime	datetime	エージェント ジョブ セッションが開始した時刻。
EndTime	datetime	エージェント ジョブ セッションが完了した時刻。
Duration	int	ジョブ セッションの累積時間 (秒単位)。
UploadedCommands	int	エージェント セッション中にアップロードされたコマンド数。
DownloadedCommands	int	エージェント セッション中にダウンロードされたコマンド数。
ErrorMessages	int	エージェント セッション中に生成されたエラー メッセージ数。
ErrorID	int	発生したエラーの ID。
PercentageDone	decimal	アクティブなセッションで既に配信された全変更の推定パーセンテージ。
TimeRemaining	int	アクティブなセッションでの推定残り秒数。
CurrentPhase	int	アクティブなセッションの現在のフェーズ。次のいずれかになります。 1 = アップロード 2 = ダウンロード
LastMessage	nvarchar(500)	セッション中にマージ エージェントによりログに記録された最後のメッセージ。

戻り値

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

説明

sp_replmonitorhelpmergesession は、マージ レプリケーションの監視に使用します。

sp_replmonitorhelpmergesession をサブスクライバ側で実行した場合は、過去 5 回のマージ エージェント セッションに関する情報のみが返されます。

権限

sp_replmonitorhelpmergesession を実行できるのは、ディストリビュータ側のディストリビューション データベースまたはサブスクライバ側のサブスクリプション データベースでの、db_owner 固定データベース ロールまたは replmonitor 固定データベース ロールのメンバだけです。

関連項目

タスク

レプリケーションをプログラムから監視する方法 (レプリケーション Transact-SQL プログラミング)