DataWorks Open Platform で拡張機能を登録、公開、および有効化すると、拡張機能が有効になります。 拡張機能が有効になっているワークスペースのサービスページで、拡張ポイントイベントをトリガーする操作を実行すると、DataWorks はイベントメッセージを拡張機能に送信します。 次に、拡張機能は拡張ポイントイベントをチェックします。 拡張機能から返された結果に基づいて、操作が有効かどうかを判断できます。 このトピックでは、DataStudio でサポートされている拡張ポイントイベントと、拡張ポイントを使用して拡張機能をトリガーし、イベントを確認する方法について説明します。
前提条件
イベントメッセージ サブスクリプション機能が有効になっています。 詳細については、「イベントメッセージ サブスクリプションを有効にする」をご参照ください。
拡張機能が開発およびデプロイされています。 詳細については、「Function Compute に基づいて拡張機能を開発およびデプロイする」をご参照ください。
背景情報
拡張機能を有効にする方法
SettingCenter の [拡張機能] ページで拡張機能を表示し、現在のワークスペースで拡張機能を有効にするかどうかを決定できます。
DataStudio でサポートされている拡張ポイントイベント
DataStudio でサポートされている拡張ポイントイベントには、ファイルデプロイメントの事前イベント、ファイルコミットの事前イベント、テーブルコミットの事前イベントが含まれます。 拡張ポイントイベントの定義と拡張ポイントイベントのリストについては、「拡張機能」をご参照ください。
拡張ポイントイベントがトリガーされると、DataWorks はイベントメッセージを拡張機能に送信します。 次に、拡張機能がトリガーされて拡張ポイントイベントがチェックされ、結果が返されます。 拡張ポイントイベントのトリガー方法については、「サポートされている拡張ポイントイベント」をご参照ください。
制限
データ開発中に生成された拡張ポイントイベントに関連するメッセージに応答するように拡張機能を有効にするシナリオでは、メッセージ通知と応答に関して次の制限に注意してください。
組み込みの拡張機能を有効にした場合、拡張機能は ODPS SQL ノードに対してのみ有効になります。
組み込みの拡張機能は、ODPS SQL ノードの処理ロジックのみをチェックします。 ODPS SQL ノードの場合、拡張ポイントイベントをトリガーする操作が実行されると、DataWorks は操作を中断し、メッセージを拡張機能に送信し、拡張機能が処理ロジックをチェックしてチェック結果を返すのを待ち、チェック結果に基づいて操作を処理します。 他のタイプのノードの場合、拡張ポイントイベントをトリガーする操作が実行されると、DataWorks は操作を中断しますが、組み込みの拡張機能は処理ロジックをチェックせずに成功を返します。
[テーブルデプロイメントの事前イベント] と [テーブルコミットの事前イベント] は、MaxCompute テーブルがコミットおよびデプロイされた場合にのみトリガーおよびチェックできます。
do-while ノード や for-each ノード などのノードグループが拡張チェックをトリガーする場合、後続の操作を実行する前に、ノードグループのすべての内部ノードがチェックに合格するまで待つ必要があります。
機能
DataStudio を使用すると、ローカル サービスは、次の拡張ポイントに関連するイベントが生成されたときにメッセージを受信できます。 さらに、ローカル プログラムを DataWorks 拡張機能として登録し、拡張機能を使用して拡張ポイントイベントに関連するメッセージを受信できます。 拡張機能は、カスタム ロジックに基づいて拡張ポイントイベントを処理し、UpdateIDEEventResult 操作を呼び出すことによって、チェック結果をプラットフォームに送信できます。 これにより、DataWorks で プロセス制御 を実現できます。 DataWorks は、次の拡張ポイントをサポートしています。
ファイルの実行、ファイルのコミット、ファイルのデプロイ、ファイルの削除などのファイルに対する操作の拡張ポイント
テーブルのコミットやテーブルのデプロイなどのテーブルに対する操作の拡張ポイント
説明テーブルの拡張ポイントイベントは、MaxCompute テーブルで特定の操作が実行された場合にのみトリガーおよびチェックできます。
サポートされている拡張ポイントイベント
DataWorks は、データ開発中に次の拡張ポイントに関連するイベントがトリガーされたときに、メッセージを拡張機能に送信し、拡張機能がメッセージをチェックして応答するのを待ちます。
DataStudio でファイルを実行する
DataStudio でファイルをコミットする
DataStudio でファイルをデプロイする
DataStudio でファイルを削除する
DataStudio でテーブルをコミットする
DataStudio でテーブルをデプロイする
参照
拡張機能を有効にする方法については、「拡張機能の使用」をご参照ください。
DataStudio でサポートされているその他の拡張ポイント イベントについては、「拡張機能」をご参照ください。
ファイル変更イベントのメッセージ本文については、「ファイル変更イベントのメッセージ本文（コミット、デプロイ、実行、削除、コードレビュー）」をご参照ください。
テーブル変更イベントのメッセージ本文については、「テーブル変更イベントのメッセージ本文（開発環境へのテーブルのコミットと本番環境へのテーブルのデプロイ）」をご参照ください。