次の方法で共有

END CONVERSATION (Transact-SQL)

  • [アーティクル]

更新 : 2007 年 9 月 15 日

既存のメッセージ交換の一方の側を終了します。

構文

 END CONVERSATION conversation_handle    [   [ WITH ERROR = failure_code DESCRIPTION = 'failure_text' ]      | [ WITH CLEANUP ]     ] [ ; ]

引数

  • conversation_handle
    終了するメッセージ交換のメッセージ交換ハンドルを指定します。
  • WITH ERROR = failure_code
    エラー コードを指定します。failure_code のデータ型は int です。このエラー コードはユーザー定義のコードで、メッセージ交換の相手側に送信するエラー メッセージの一部となります。このエラー コードは 0 よりも大きい値にする必要があります。
  • DESCRIPTION = failure_text
    エラー メッセージを指定します。failure_text のデータ型は nvarchar(3000) です。このエラー テキストはユーザー定義のテキストで、メッセージ交換の相手側に送信するエラー メッセージの一部となります。
  • WITH CLEANUP
    正常に完了できなかったメッセージ交換の一方の側のメッセージとカタログ ビュー エントリをすべて削除します。メッセージ交換の相手側には、クリーンアップについて通知されません。Microsoft SQL Server では、メッセージ交換のエンドポイントが削除されます。また、転送キューおよびサービス キューにあるメッセージ交換のすべてのメッセージも削除されます。管理者は、このオプションを使用して、正常に完了できなかったメッセージ交換のメッセージを削除できます。たとえば、リモート サービスが永久的に削除された場合、管理者は WITH CLEANUP を使用してこのサービスに対するメッセージを削除できます。Service Broker アプリケーションのコードでは、WITH CLEANUP を使用しないでください。受信エンドポイントがメッセージの受信を確認する前に END CONVERSATION WITH CLEANUP が実行された場合、送信エンドポイントはもう一度メッセージを送信します。これによって、ダイアログが再実行される可能性があります。

解説

メッセージ交換を終了すると、指定した conversation_handle が属するメッセージ交換グループがロックされ、メッセージ交換の終了時、Service Broker によってこのメッセージ交換のすべてのメッセージがサービス キューから削除されます。

メッセージ交換が終了した後、アプリケーションではそのメッセージ交換のメッセージを送受信できなくなります。メッセージ交換を完了するには、メッセージ交換の両方の参加者が END CONVERSATION を呼び出す必要があります。Service Broker が、メッセージ交換の相手側から終了ダイアログ メッセージまたはエラー メッセージを受信しなかった場合は、Service Broker から相手側に、メッセージ交換が終了したことが通知されます。この場合、このメッセージ交換のメッセージ交換ハンドルが無効になる一方、メッセージ交換のエンドポイントはアクティブなまま残り、この状態はリモート サービスをホストするインスタンスからメッセージの受信確認が返されるまで継続されます。

メッセージ交換の終了ダイアログ メッセージまたはエラー メッセージが Service Broker でまだ処理されていない場合は、Service Broker からメッセージ交換のリモート側に、メッセージ交換が終了したことが通知されます。Service Broker からリモート サービスに送信されるメッセージは、指定されるオプションによって異なります。

  • オプションを指定せずにメッセージ交換を終了し、リモート サービスへのメッセージ交換がアクティブな状態を継続していると、Service Broker からリモート サービスに、https://schemas.microsoft.com/SQL/ServiceBroker/EndDialog のようなメッセージが送信されます。このメッセージは、メッセージ交換の順に転送キューに追加されます。現在転送キューにあるメッセージ交換のすべてのメッセージは、このメッセージが送信されるよりも前に、Service Broker によって送信されます。
  • メッセージ交換がエラーで終了し、リモート サービスへのメッセージ交換がアクティブな状態を継続していると、Service Broker からリモート サービスに、https://schemas.microsoft.com/SQL/ServiceBroker/Error のようなメッセージが送信されます。現在転送キューに残っているメッセージ交換のメッセージはすべて、Service Broker によって削除されます。
  • データベース管理者は WITH CLEANUP 句を使用して、正常に完了しなかったメッセージ交換のメッセージを削除できます。このオプションでは、メッセージ交換のすべてのメッセージとカタログ ビュー エントリが削除されます。この場合、メッセージ交換のリモート側にはメッセージ交換が終了したことが通知されません。また、アプリケーションでは送信されたが、ネットワーク経由では転送されていなかったメッセージは受信できないことがあります。メッセージ交換が正常に完了できない場合にのみ、このオプションを使用してください。

メッセージ交換が終了した後、Transact-SQL SEND ステートメントでそのメッセージ交換ハンドルが指定されると、Transact-SQL エラーが発生します。メッセージ交換の相手側からメッセージを受信した場合、これらのメッセージは Service Broker によって破棄されます。

メッセージ交換が終了し、そのメッセージ交換の未送信のメッセージがリモート サービス側に残っている場合、未送信のメッセージはリモート サービスによって削除されます。これはエラーとして扱われないため、リモート サービスはメッセージの削除に関する通知を受信しません。

WITH ERROR 句のエラー コードは、正の数値で指定する必要があります。負の数値は、Service Broker のエラー メッセージ用に予約されています。Service Broker のエラー メッセージの詳細については、「ブローカ メッセージ」を参照してください。

END CONVERSATION は、ユーザー定義の関数では無効です。

権限

アクティブなメッセージ交換を終了するには、そのメッセージ交換の所有者であるか、sysadmin 固定サーバー ロールまたは db_owner 固定データベース ロールのメンバであることが必要です。

sysadmin 固定サーバー ロールまたは db_owner 固定データベース ロールのメンバであれば、WITH CLEANUP を使用して、既に完了したメッセージ交換のメタデータを削除できます。

例

A. メッセージ交換を終了する

次の例では、@dialog_handle で指定したダイアログを終了します。

END CONVERSATION @dialog_handle ;

B. メッセージ交換を終了し、エラーを返す

次の例では、処理中のステートメントでエラーがレポートされた場合に、@dialog_handle で指定したダイアログを終了し、エラーを返します。これは簡単なエラー処理であり、アプリケーションによってはこの方法が適切でない場合があります。

DECLARE @dialog_handle UNIQUEIDENTIFIER,
        @ErrorSave INT,
        @ErrorDesc NVARCHAR(100) ;
BEGIN TRANSACTION ;

<receive and process message>

SET @ErrorSave = @@ERROR ;

IF (@ErrorSave <> 0)
  BEGIN
      ROLLBACK TRANSACTION ;
      SET @ErrorDesc = N'An error has occurred.' ;
      END CONVERSATION @dialog_handle 
      WITH ERROR = @ErrorSave DESCRIPTION = @ErrorDesc ;
  END
ELSE

COMMIT TRANSACTION ;

C. 正常に完了しなかったメッセージ交換をクリーンアップする

次の例では、@dialog_handle で指定したダイアログを終了します。SQL Server ではサービス キューと転送キューからすべてのメッセージが直ちに削除され、リモート サービスに通知は送信されません。このようにクリーンアップと共にダイアログを終了すると、リモート サービスに通知が送信されないため、この方法は、リモート サービスで EndDialog または Error メッセージを受信できない場合にのみ使用してください。

END CONVERSATION @dialog_handle WITH CLEANUP ;

参照

関連項目

BEGIN CONVERSATION TIMER (Transact-SQL)
BEGIN DIALOG CONVERSATION (Transact-SQL)
sys.conversation_endpoints (Transact-SQL)

その他の技術情報

ブローカ メッセージ
ダイアログ メッセージ交換
Service Broker のチュートリアル

ヘルプおよび情報

SQL Server 2005 の参考資料の入手

変更履歴

リリース 履歴

2007 年 9 月 15 日
変更内容 :
  • WITHOUT CLEANUP の使用法を明記しました。