使用 JavaScript 套件

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

事前準備

  1. 前往 Google Cloud 控制台的「Dataform」頁面。

    前往 Dataform

  2. 執行下列任一或兩項操作：

    1. 如要在存放區中安裝套件，或驗證私人 NPM 套件以啟用安裝，請按照下列步驟操作：
      1. 選取或建立存放區。
      2. 選取或建立開發工作區。
      3. 選用：如要安裝私人套件，請驗證私人套件。
      4. 如果存放區不含 package.json 檔案，請建立 package.json 並移動 Dataform 核心套件。
    2. 如要建立套件，請按照下列步驟操作：
      1. 建立專用於套件的 Dataform 存放區。將存放區名稱與套件名稱相符。
      2. 將存放區連結至第三方 Git 存放區，該存放區將代管您的套件。
      3. 在 Dataform 存放區中建立並初始化工作區。

  3. 請確認您具備必要權限，可完成本文中的工作。

必要的角色

如要取得完成本文工作所需的權限，請要求管理員授予您下列 IAM 角色：

如要進一步瞭解如何授予角色，請參閱「管理專案、資料夾和組織的存取權」。

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

安裝套件

本節說明如何安裝 JavaScript 套件，並將其匯入 JavaScript 檔案和 SQLX 檔案，以便使用該套件在 Dataform 中開發工作流程。

如要在 Dataform 中使用套件，您必須在存放區中安裝套件。

您可以在 Dataform 中安裝下列類型的套件：

接著，如要在 JavaScript 或 SQLX 檔案中使用套件，您必須將套件的選定內容匯入檔案。您也可以將整個套件匯入 JavaScript 或 SQLX 檔案，而非匯入所選內容。

為避免在正式環境中安裝套件時發生問題，建議您採取下列做法：

  • 在 package.json 中明確指定套件版本，例如 3.0.0。請勿使用其他 dependencies 選項，例如 package.json 中的 >version。

  • 在非正式環境中測試新套件版本。如要進一步瞭解如何設定不同的工作流程生命週期環境，請參閱「工作流程生命週期的最佳做法」。

將套件新增為依附元件

如要在 Dataform 存放區中安裝套件，您需要在 package.json 檔案中將套件新增為依附元件：

  1. 在工作區的「檔案」窗格中，選取 package.json。

  2. 將套件新增至 dependencies 區塊：

    1. 新增已發布的公開 NPM 套件，格式如下：

      "PACKAGE-NAME": "PACKAGE-VERSION"

      更改下列內容：

      • 將 PACKAGE-NAME 替換為套件名稱。
      • PACKAGE-VERSION，並使用已發布的公開 NPM 套件最新版本。為避免套件安裝問題，請明確指定版本，例如 3.0.0。

    2. 新增未發布的公開 NPM 套件，格式如下：

      "PACKAGE-NAME": "PACKAGE-URL"

      更改下列內容：

      • 將 PACKAGE-NAME 替換為套件名稱。
      • PACKAGE-URL，其中 tar.gz 是第三方套件存放區的網址，例如 https://github.com/user/sample-package-repository/archive/master.tar.gz。

    3. 以以下格式新增經過驗證的私人 NPM 套件：

      "REGISTRY-SCOPE/PACKAGE-NAME": "PACKAGE-URL"

      更改下列內容：

      • 將 REGISTRY-SCOPE 替換為套件名稱。 REGISTRY-SCOPE 必須與存放區 .npmrc 檔案中定義的登錄範圍相符。
      • 將 PACKAGE-NAME 替換為套件名稱。
      • PACKAGE-URL，其中 tar.gz 是套件存放區的網址，例如 https://github.com/user/sample-package-repository/archive/master.tar.gz。

  3. 按一下「安裝套件」。

  4. 修訂並