Integration Services (SSIS) のイベント ハンドラー
実行可能ファイル (パッケージ、Foreach ループ コンテナー、For ループ コンテナー、シーケンス コンテナー、およびタスク ホスト コンテナー) は実行時にイベントを発生させます。 たとえば、エラーが発生すると、OnError イベントが発生します。 これらのイベントに対してカスタム イベント ハンドラーを作成し、パッケージ機能を拡張すると、実行時のパッケージを容易に管理できます。 イベント ハンドラーは、次のタスクを実行できます。
パッケージまたはタスクの実行が完了したとき、一時データ ストレージをクリーンアップします。
システム情報を取得して、パッケージを実行する前にリソースの可用性を評価します。
参照テーブル内の参照が失敗したとき、テーブル内のデータを更新します。
エラーまたは警告が発生したとき、またはタスクが失敗したときに、電子メール メッセージを送信します。
イベントにイベント ハンドラーがない場合、パッケージのコンテナー階層で上位にあたる次のコンテナーでイベントが発生します。 このコンテナーにイベント ハンドラーがある場合、イベントに応答してイベント ハンドラーが実行されます。 イベント ハンドラーがない場合、コンテナー階層で上位にあたる次のコンテナーでイベントが発生します。
次の図は、1 つの SQL 実行タスクを含む For ループ コンテナーを持つ、簡単なパッケージを示しています。
.gif "パッケージ、For ループ、タスク ホスト、および SQL 実行タスク")
OnError イベントに対するイベント ハンドラーを持つのは、パッケージのみです。 SQL 実行タスクの実行時にエラーが発生した場合、パッケージの OnError イベント ハンドラーが実行されます。 次の図は、パッケージの OnError イベント ハンドラーにより実行される呼び出しの順序を示しています。
.gif "イベント ハンドラーのフロー")
イベント ハンドラーは、イベント ハンドラー コレクションのメンバーであり、このコレクションはすべてのコンテナーに含まれています。 SSIS デザイナーを使用してパッケージを作成すると、イベント ハンドラー コレクションのメンバーは、SSIS デザイナーの [パッケージ エクスプローラー] タブ上の [イベント ハンドラー] フォルダー内に表示されます。
イベント ハンドラーのコンテナーは、次の方法で構成できます。
イベント ハンドラーの名前と説明を指定します。
イベント ハンドラーを実行するかどうか、イベント ハンドラーが失敗した場合にパッケージが失敗するかどうか、イベント ハンドラーが失敗するまでに発生するエラーの最大数を示します。
実行時にイベント ハンドラーが返す実際の実行結果の代わりに、返される実行結果を指定します。
イベント ハンドラーのトランザクション オプションを指定します。
イベント ハンドラーが使用するログ モードを指定します。
イベント ハンドラーの内容
イベント ハンドラーの作成方法は、パッケージの構築方法と同様です。つまり、イベント ハンドラーには、制御フロー内で順序付けられたタスクとコンテナーがあります。また、イベント ハンドラーにデータ フローを含めることもできます。 SSIS デザイナーには [イベント ハンドラー] タブが含まれており、これを使用してカスタム イベント ハンドラーを作成します。 詳細については、「Integration Services (SSIS) のイベント ハンドラー」を参照してください。
イベント ハンドラーは、プログラムによって作成することもできます。 詳細については、「プログラムによるイベントの処理」を参照してください。
実行時イベント
次の表に、Integration Services で用意されているイベント ハンドラーの一覧を示します。また、イベント ハンドラーによって実行される実行時イベントについて説明します。
イベント ハンドラー |
イベント |
|---|---|
OnError |
OnError イベントのイベント ハンドラーです。 このイベントは、エラー発生時に実行可能ファイルから発生します。 |
OnExecStatusChanged |
OnExecStatusChanged イベントのイベント ハンドラーです。 このイベントは、実行状態が変化したときに実行可能ファイルから発生します。 |
OnInformation |
OnInformation イベントのイベント ハンドラーです。 このイベントは、実行可能ファイルの検証時および実行時に、情報をレポートするために発生します。 このイベントは情報を伝達するだけのもので、エラーや警告は発生しません。 |
OnPostExecute |
OnPostExecute イベントのイベント ハンドラーです。 このイベントは、実行可能ファイルの実行完了直後に、実行可能ファイルから発生します。 |
OnPostValidate |
OnPostValidate イベントのイベント ハンドラーです。 このイベントは、実行可能ファイルの検証が完了したときに、実行可能ファイルから発生します。 |
OnPreExecute |
OnPreExecute イベントのイベント ハンドラーです。 このイベントは、実行可能ファイルが実行される直前に、実行可能ファイルから発生します。 |
OnPreValidate |
OnPreValidate イベントのイベント ハンドラーです。 このイベントは、実行可能ファイルの検証を開始するときに、実行可能ファイルから発生します。 |
OnProgress |
OnProgress イベントのイベント ハンドラーです。 このイベントは、実行可能ファイルで重要な進行があったときに、実行可能ファイルから発生します。 |
OnQueryCancel |
OnQueryCancel イベントのイベント ハンドラーです。 このイベントは、実行可能ファイルの実行を停止するかどうかを決定するために、実行可能ファイルから発生します。 |
OnTaskFailed |
OnTaskFailed イベントのイベント ハンドラーです。 このイベントは、タスクが失敗したときにタスクから発生します。 |
OnVariableValueChanged |
OnVariableValueChanged イベントのイベント ハンドラーです。 このイベントは、変数の値が変化したときに実行可能ファイルから発生します。 イベントは、変数が定義されている実行可能ファイルで発生します。 変数の RaiseChangeEvent プロパティが False に設定されている場合、このイベントは発生しません。 詳細については、「Integration Services (SSIS) の変数」を参照してください。 |
OnWarning |
OnWarning イベントのイベント ハンドラーです。 このイベントは、警告の発生時に実行可能ファイルから発生します。 |
イベント ハンドラーの構成
プロパティを設定するには、SQL Server データ ツール (SSDT) の [プロパティ] ウィンドウで行うか、またはプログラムによって設定します。
これらのプロパティを SQL Server データ ツール (SSDT) で設定する方法の詳細については、「タスクまたはコンテナーのプロパティを設定する」を参照してください。
プログラムによってこれらのプロパティを設定する方法の詳細については、「DtsEventHandler」を参照してください。
関連タスク
パッケージにイベント ハンドラーを追加する方法については、「パッケージにイベント ハンドラーを追加する」を参照してください。
関連コンテンツ
|
.gif "Integration Services のアイコン (小)")
最新の Integration Services の入手