在DataWorks開放平台,成功註冊、上線並啟用擴充程式後,在該擴充程式所生效的工作空間中,使用頁面部分功能(即觸發擴充點事件)時,DataWorks會將事件訊息發送至您的擴充程式,根據擴充程式返回的結果,您可以決定該操作是否生效。本文將為您介紹資料開發DataStudio中支援的擴充點事件,以及使用擴充點觸發擴充程式的操作過程。
前提條件
-
已開啟訊息訂閱操作,詳情請參見開啟訊息訂閱。
-
已完成擴充程式的開發部署操作,詳情請參見開發部署擴充程式:Function Compute方式。
背景資訊
-
啟動擴充程式。
您可以在管理中心頁面查看擴展程序,並控制是否需要在當前工作空間啟用該擴充程式校正。
-
資料開發支援的擴充點事件。
DataWorks的資料開發模組,支援擴充點事件包括檔案發布前置事件、檔案提交前置事件、表提交前置事件等。擴充點事件的概念和詳細列表請參見支援的擴充點事件列表。
-
DataWorks支援對擴充點事件進行訊息通知,通過擴充程式來自動化校正並響應,擴充點觸發過程詳情請參見支援的擴充點事件。
使用限制
擴充程式啟用後,實際資料開發過程中,擴充事件被觸發後的訊息通知與響應有以下限制。
-
系統內建擴充程式啟用後,暫時僅支援對ODPS SQL類的節點生效。
即啟用後,僅ODPS SQL類節點中相應擴充點事件被觸發時,流程會被阻斷,通過內建擴充程式對對應的邏輯進行校正並返回校正結果。非ODPS SQL節點對應的事件被觸發後,流程會被阻斷,但是內建擴充程式不會校正邏輯是否符合預期,直接返回校正成功。
-
擴充點事件中,表發布前置事件和表提交前置事件暫時僅支援MaxCompute表提交與發布時觸發並進行檢測。
-
有內部節點的組合類別節點,例如:do-while節點、for-each節點在觸發檢查時,需要內部節點都檢查通過才可繼續進行下一步操作。
能力概述
資料開發模組支援您的本地服務接收以下擴充點事件的訊息。此外,還支援將本地程式註冊為DataWorks擴充程式,通過擴充程式接收擴充點事件訊息。實現擴充程式對擴充點事件的自訂邏輯處理,並通過回調UpdateIDEEventResultAPI將處理結果返回至平台,實現DataWorks上的流程管控。支援的擴充點如下:
-
檔案操作:運行檔案、提交檔案、發布檔案、刪除檔案。
-
表操作:提交表、發行資料表。
說明資料開發表操作擴充事件僅支援對MaxCompute表的觸發與檢測。
支援的擴充點事件
DataWorks資料開發中,目前支援對以下的擴充點事件進行訊息通知,通過擴充程式實現校正並響應。
DataStudio-運行檔案在DataStudio代碼編輯器中,單擊運行按鈕觸發擴充程式前置事件校正,介面彈出檢查中浮層提示"檢查通過後將自動執行操作,請在[操作檢查]中查看結果"。在左側操作檢查面板中可查看所有校正記錄(包括運行、提交檔案、刪除等類型),單擊對應記錄可開啟詳情彈窗,查看各擴充程式的檢查類型、狀態及詳情。
DataStudio-提交檔案在DataStudio中提交檔案時,系統將觸發檔案提交前置事件檢查。單擊工具列中的提交按鈕,觸發擴充程式檢查,編輯器彈出"檢查中"提示,檢查通過後將自動執行操作。在左側操作檢查面板中可查看各檢查項的狀態,列表展示"觸發檔案提交前置事件檢查"
DataStudio-發布檔案檔案發布時觸發前置事件檢查的流程:在代碼編輯器中單擊發布按鈕提交檔案後,系統觸發擴充程式檢查;進入建立發布包介面,檔案清單中對應節點的節點狀態顯示為檢查驗證中;單擊節點狀態可開啟操作檢查彈窗,查看檢查類型、狀態及校正詳情。
DataStudio-刪除檔案在資料開發檔案樹中,按右鍵目標節點並選擇刪除,觸發擴充程式前置事件檢查。頁面底部出現藍色提示"此操作觸發了檢查,檢查通過後操作自動生效,請在「操作檢查」中查看檢查結果。"進入操作檢查頁面,可查看檢查記錄列表(包含名稱/操作時間、類型、狀態列),單擊具體記錄可查看操作檢查詳情,包括檢查類型(如"刪除前組合 測試")和目前狀態(如"檢查中"),並提供查看詳情和查看文檔連結。
DataStudio-提交表提交表(如xc_table_prod)到開發環境或生產環境時,系統自動觸發擴充程式前置事件檢查,彈出檢查中對話方塊提示"檢查通過後將自動執行操作,請在「操作檢查」中查看結果"。在左側操作檢查側邊欄可按類型和狀態篩選查看所有檢查記錄。單擊具體記錄可開啟操作檢查詳情彈窗,查看當前操作觸發的擴充程式校正列表(如檢查類型"表提交前檢查-測試程式")及校正狀態,支援查看詳情和重新檢查操作。
DataStudio-發行資料表在表配置頁面單擊提交到生產環境頁簽觸發擴充程式檢查,系統彈出提示"檢查中 - 檢查通過後將自動執行操作,請在「操作檢查」中查看結果"。進入操作檢查頁面可查看檢查記錄列表,包含表名、提交時間、檢查類型及狀態。單擊某條記錄可查看檢查詳情,包括檢查類型(如表發布前檢查)和目前狀態,並支援查看詳情和查看文檔操作。該操作會觸發工作空間中已開啟的表發布前置事件類型的擴充程式校正。
相關文檔
-
啟用擴充程式,詳情請參見:應用擴充程式。
-
資料開發更多擴充點事件,詳情請參見:支援的擴充點事件列表。
-
檔案變更事件的訊息實體格式,詳情請參見:檔案變更事件(提交、發布、運行、刪除、程式碼檢閱)。
-
表變更事件的訊息實體格式,詳情請參見:表變更事件(提交表至開發環境、發行資料表至生產環境)。