建立 Dataform 開發工作區

本文件說明如何執行下列操作:

第一次在新存放區中建立開發工作區時,Dataform 會提示您使用一組 Dataform 運作所需的設定檔初始化開發工作區。

已初始化的開發工作區包含下列目錄和檔案:

  • definitions/:Dataform 核心或 JavaScript 中的資產定義目錄。

  • includes/:空白目錄,可用於存放可在存放區中重複使用的指令碼和變數。

  • workflow_settings.yaml:預設的 Dataform 設定檔,其中包含 Google Cloud 專案 ID 和 BigQuery 結構定義,用於發布資產。您可以覆寫預設設定,根據需求自訂,但這並非開始使用 Dataform 的必要條件。

  • package.json:預設的 Dataform 依附元件設定檔,包含最新版本的 @dataform/core。您可以使用這個檔案匯入套件

  • definitions/sample.sqlx:SQLX 範例檔案,協助您快速上手。

事前準備

如果您尚未建立 Dataform 存放區,請建立

必要的角色

如要取得建立、初始化及刪除開發工作區所需的權限,請要求管理員為您授予工作區的 Dataform 編輯者 (roles/dataform.editor) 身分與存取權管理角色。如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和機構的存取權」。

您或許還可透過自訂角色或其他預先定義的角色取得必要權限。

建立 Dataform 開發工作區

如要建立新的 Dataform 開發工作區,請按照下列步驟操作:

  1. 在 Google Cloud 控制台中,前往「Dataform」頁面。

    前往 Dataform

  2. 選取要建立新開發工作區的存放區。

  3. 在存放區頁面中,按一下「Create development workspace」(建立開發工作區)

  4. 在「建立開發工作區」視窗中執行下列操作:

    1. 在「工作區 ID」欄位中,輸入開發工作區的專屬 ID。

      ID 只能包含數字、英文字母、連字號和底線。

    2. 點選「建立」

在 Dataform 存放區中初始化第一個開發工作區

如要初始化 Dataform 開發工作區,請按照下列步驟操作:

  1. 在 Google Cloud 控制台中,前往「Dataform」頁面。

    前往 Dataform

  2. 選取要初始化空白工作區的存放區。

  3. 在「Development workspaces」分頁中,按一下要初始化的空白工作區名稱。

  4. 在開發工作區頁面中,按一下「Initialize workspace」

刪除 Dataform 開發工作區

建立 Dataform 開發工作區不會產生任何費用。不過,如果您想刪除開發工作區,請按照下列步驟操作:

  1. 在「Dataform」頁面中,按一下包含要刪除的工作區的存放區。

  2. 為避免刪除未提交的變更,請將變更提交並推送至 Git 存放區

  3. 在「Development workspaces」(開發工作區) 分頁中,選取要刪除的開發工作區,然後按一下「Delete selected workspaces」(刪除所選工作區)

    你可以一次刪除多個工作區。

  4. 按一下「Delete」(刪除) 確認操作。

後續步驟