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