在DataWorks開放平台,成功註冊、上線並啟用擴充程式後,在該擴充程式所生效的工作空間中,使用頁面部分功能(即觸發擴充點事件)時,DataWorks會將事件訊息發送至您的擴充程式,根據擴充程式返回的結果,您可以決定該操作是否生效。本文將為您介紹資料開發DataStudio中支援的擴充點事件,以及使用擴充點觸發擴充程式的操作過程。
前提條件
已開啟訊息訂閱操作,詳情請參見開啟訊息訂閱。
已完成擴充程式的開發部署操作,詳情請參見開發部署擴充程式:Function Compute方式。
背景資訊
啟動擴充程式。
您可以在工作空間頁面查看擴充程式,並控制是否需要在當前工作空間啟用該擴充程式校正。
資料開發支援的擴充點事件。
DataWorks的資料開發模組,支援擴充點事件包括檔案發布前置事件、檔案提交前置事件、表提交前置事件等。擴充點事件的概念和詳細列表請參見支援的擴充點事件列表。
DataWorks支援對擴充點事件進行訊息通知,通過擴充程式來自動化校正並響應,擴充點觸發過程詳情請參見支援的擴充點事件。
使用限制
擴充程式啟用後,實際資料開發過程中,擴充事件被觸發後的訊息通知與響應有以下限制。
系統內建擴充程式啟用後,暫時僅支援對ODPS SQL類的節點生效。
即啟用後,僅ODPS SQL類節點中相應擴充點事件被觸發時,流程會被阻斷,通過內建擴充程式對對應的邏輯進行校正並返回校正結果。非ODPS SQL節點對應的事件被觸發後,流程會被阻斷,但是內建擴充程式不會校正邏輯是否符合預期,直接返回校正成功。
擴充點事件中,表發布前置事件和表提交前置事件暫時僅支援MaxCompute表提交與發布時觸發並進行檢測。
有內部節點的組合類別節點,例如:建立並使用PAI Studio節點、do-while節點邏輯原理介紹、for-each節點邏輯原理介紹在觸發檢查時,需要內部節點都檢查通過才可繼續進行下一步操作。
能力概述
資料開發模組支援您的本地服務接收以下擴充點事件的訊息。此外,還支援將本地程式註冊為DataWorks擴充程式,通過擴充程式接收擴充點事件訊息。實現擴充程式對擴充點事件的自訂邏輯處理,並通過回調UpdateIDEEventResultAPI將處理結果返回至平台,實現DataWorks上的流程管控。支援的擴充點如下:
檔案操作:運行檔案、提交檔案、發布檔案、刪除檔案。
表操作:提交表、發行資料表。
說明資料開發表操作擴充事件僅支援對MaxCompute表的觸發與檢測。
支援的擴充點事件
DataWorks資料開發中,目前支援對以下的擴充點事件進行訊息通知,通過擴充程式實現校正並響應。
DataStudio-運行檔案
DataStudio-提交檔案
DataStudio-發布檔案
DataStudio-刪除檔案
DataStudio-提交表
DataStudio-發行資料表
相關文檔
啟用擴充程式,詳情請參見:應用擴充程式。
資料開發更多擴充點事件,詳情請參見:支援的擴充點事件列表。
檔案變更事件的訊息實體格式,詳情請參見:檔案變更事件(提交、發布、運行、刪除、程式碼檢閱)。
表變更事件的訊息實體格式,詳情請參見:表變更事件(提交表至開發環境、發行資料表至生產環境)。