本頁說明如何在 Cloud Data Fusion 管道中設定偏好設定、巨集和執行階段引數。
重要詞彙
- 巨集
- 巨集是 Cloud Data Fusion 外掛程式設定中的預留位置。這些變數會以
${ }
內的變數表示,例如${input_file_path}
。巨集可讓您使用預留位置值,在執行階段替換為實際值,進而為管道帶來彈性。這可為參數啟用動態設定,例如檔案路徑和資料表名稱。 - 偏好設定
- 偏好設定是預先定義的設定,可在 Cloud Data Fusion 的不同層級套用,包括系統本身、命名空間、應用程式 (包含管道),以及管道中的個別程式。您可以使用偏好設定為常用的設定設定預設值。管道和較低層級的程式可以繼承這些預設值,減少重複的設定工作。
- 執行階段引數
- 執行階段引數是鍵/值組合,可在部署或執行管道時為巨集提供值,並可能覆寫偏好設定。這些設定可高度自訂,讓您根據每個管道執行作業調整設定,而無須修改基礎管道或偏好設定。
設定巨集
如要使用外掛程式屬性值的巨集,請按照下列步驟操作:
- 在 Cloud Data Fusion Studio 中,前往外掛程式節點,然後按一下「Properties」。
- 前往要使用巨集的欄位,然後按一下欄位旁邊的** M**。
- 輸入巨集的鍵。舉例來說,在檔案來源的外掛程式屬性中,請在「格式」欄位輸入以下鍵:
${format.type}
。
設定巨集值
在管道預覽資料和執行管道前,先設定巨集的值。您可以在下列位置設定巨集值:
- 引數設定器外掛程式
- 執行階段引數
- 應用程式偏好設定
- 命名空間偏好設定
- 系統偏好設定
使用巨集執行管道時,會執行下列操作:
- Cloud Data Fusion 會先檢查管道是否包含引數設定器外掛程式:
- 如果巨集有引數設定器,Cloud Data Fusion 會使用巨集的值。
- 如果沒有引數設定器,或是在引數設定器中未指派巨集,Cloud Data Fusion 會改用管道執行階段引數中的值。
- 執行階段引數會繼承應用程式偏好設定中的巨集。
- 應用程式偏好設定會繼承命名空間偏好設定的巨集
- 命名空間偏好設定會繼承系統偏好設定的巨集。
範例
巨集常用於路徑欄位。您可以改用動態路徑,而不要使用硬式編碼路徑。舉例來說,在 Cloud Storage 來源外掛程式中,您可以使用多個巨集取代路徑值。下列值可區分桶、資料夾和檔案元素:gs://${bucket.name}/${folder}/${file.name}
。
以下範例會從靜態值區和檔案名稱不為靜態的檔案載入資料,請輸入值區名稱,並使用巨集做為檔案名稱:gs://<BUCKET_NAME>/${folder}/${file.name}
。
詳情請參閱「巨集和巨集函式」。
設定偏好設定
下節將說明偏好設定階層,其中說明偏好設定的設定、繼承或覆寫方式。
設定系統偏好設定
您可以設定系統偏好設定。由於巨集名稱必須不重複,因此每個偏好設定都會套用至使用該巨集的所有管道。
舉例來說,您有一個含有資料庫來源的管道,並使用巨集做為資料庫名稱和使用者名稱。您可以在系統偏好設定中設定資料庫和使用者名稱偏好設定。該執行個體中的每個命名空間和管道都會繼承這些偏好設定。
如要設定系統偏好設定,請按照下列步驟操作:
- 在 Cloud Data Fusion Studio 中,依序點選「System admin」>「Configuration」。
- 依序按一下 >「編輯系統偏好設定」。 「系統偏好設定」
- 在「Preferences」對話方塊中,輸入新的偏好設定或編輯現有偏好設定。
- 按一下「儲存並關閉」。這些偏好設定適用於所有命名空間、應用程式和管道。
設定命名空間偏好設定
您可以為個別命名空間設定偏好設定。
設定命名空間偏好設定時,系統會顯示任何沿用的系統偏好設定。設定命名空間偏好設定時,您可以設定不同的值來覆寫繼承的偏好設定。您也可以新增新的命名空間偏好設定。
如要設定命名空間偏好設定,請按照下列步驟操作:
- 在 Cloud Data Fusion Studio 中,依序按一下「系統管理員」「設定」。
- 按一下 「命名空間」,然後選取所需命名空間,開啟其設定頁面。
- 如要編輯沿用偏好設定或新增偏好設定,請前往「偏好設定」分頁,然後按一下「編輯」。「Preferences」對話方塊隨即會開啟,您可以在此輸入新的偏好設定,或覆寫繼承的系統偏好設定。按一下
<span class="material-icons">add</span>
「Add」,然後輸入巨集的鍵和新值。 - 按一下「儲存並關閉」。系統會使用新值建立命名空間偏好設定,這會優先於系統偏好設定。
設定應用程式偏好設定
您可以為命名空間中每個已部署的管道設定偏好設定。設定應用程式偏好設定時,系統會顯示任何繼承的系統和命名空間偏好設定。設定應用程式偏好設定時,您可以設定不同的值來覆寫繼承的偏好設定,也可以為應用程式新增偏好設定:
- 在 Cloud Data Fusion Studio 中,按一下 和「命名空間」選單,選取要新增應用程式偏好的命名空間。
- 按一下「控制中心」。
- 按一下「設定偏好設定」的扳手圖示。「Preferences」頁面隨即顯示,並列出所有繼承的偏好設定。
- 如要編輯沿用偏好設定或新增偏好設定,請前往「偏好設定」分頁,然後按一下「編輯」。「Preferences」對話方塊隨即會開啟,您可以在此輸入新的偏好設定,或覆寫繼承的系統偏好設定。按一下
<span class="material-icons">add</span>
「Add」,然後輸入巨集的鍵和新值。 - 按一下「儲存並關閉」。應用程式偏好設定會使用新值建立,這會覆寫系統或命名空間偏好設定。執行已部署的管道時,應用程式偏好設定會顯示為執行階段引數,您可以視需要編輯。
設定執行階段引數
設定執行階段引數,為巨集提供值,並在部署或執行管道時覆寫偏好設定。
用於預覽資料的執行階段引數
如要在 Cloud Data Fusion Studio 中預覽資料時,設定管道中每個巨集的值,請依序按一下「清單」>「設定」。
執行已部署管道的執行階段引數
如果管道包含巨集,請在部署管道後新增執行階段引數,設定巨集的值。
部署含有巨集的管道時,請按一下「Run」旁的
下拉式選單,開啟「Runtime arguments」對話方塊,然後設定每個巨集的值。設定管道偏好設定
如要設定管道的偏好設定,請按照下列步驟操作:
- 在 Cloud Data Fusion Studio 中,依序按一下「清單」>「已部署」,然後選取要查看的已部署管道。
- 在管道畫布中,按一下「執行」旁的 下拉式選單。系統會隨即開啟「RunTime arguments」對話方塊。
- 在隨即開啟的「Runtime arguments」對話方塊中,指定管道中每個巨集的值。
偏好設定、巨集和執行階段引數簡介
您可以在下列層級設定偏好設定:
- 系統偏好設定:您可在此設定整個執行個體的偏好設定 (例如預設值)。
- 命名空間偏好設定:繼承來自系統偏好設定的偏好設定。您可以為特定命名空間設定偏好設定。
- 應用程式偏好設定:繼承來自命名空間偏好設定的偏好設定。這些值可專屬於個別應用程式 (包含管道)。
- 執行階段引數:可覆寫較高層級偏好設定的鍵/值組合。
如果您在系統偏好設定層級設定偏好設定,巨集值會自動填入命名空間偏好設定、應用程式偏好設定和執行階段引數。
如果您在命名空間層級設定偏好設定,這些偏好設定會顯示在應用程式偏好設定的繼承偏好設定清單中。如果管道使用在偏好設定中定義的巨集,則執行階段引數會使用在偏好設定中定義的鍵/值組合。您可以在各偏好設定層級和執行階段引數中,覆寫偏好設定的值。
在下列用途中使用偏好設定、巨集和執行階段引數:
- 開發管道。在需要插件屬性動態值的地方嵌入巨集。
- 選用:設定偏好設定。在不同層級的偏好設定中,設定巨集的預設值。
- 部署及執行管道。執行管道時,會發生下列情況:
- 系統會套用相關層級的偏好設定,例如系統偏好設定或命名空間偏好設定。
- 您提供的任何執行階段引數都會覆寫偏好設定中指派給巨集的值。
- Cloud Data Fusion 會透過從執行階段引數 (如果未提供執行階段引數,則為偏好設定) 替換宏值來解析宏。
示例
管道含有 BigQuery 匯出端,其表格名稱值必須動態變更。如要設定這項功能,請按照下列步驟操作:
- 設定巨集。在接收端的屬性中,請在「Table name」欄位中使用以下巨集:
${output_table}.
- **設定偏好設定。**在應用程式偏好設定中,為
${output_table}
設定偏好設定,並使用以下預設值:data_staging
。 - 設定執行階段引數。執行管道時,請提供執行階段引數,例如
output_table=final_analytics_data
。
在管道執行期間,巨集 ${output_table},
會替換為 final_analytics_data
。