此页面由 Cloud Translation API 翻译。

在 Dataform 中安装软件包
使用集合让一切井井有条根据您的偏好保存内容并对其进行分类。

本文档介绍了如何在 Dataform 代码库中安装 JavaScript 软件包，并将其导入 JavaScript 文件和 SQLX 文件，以便使用该软件包在 Dataform 中开发 SQL 工作流。

如需在 Dataform 中使用软件包，您需要将其安装在代码库中。

您可以在 Dataform 中安装以下类型的软件包：

发布了公共 NPM 软件包。
未发布的公共 NPM 软件包。
经过身份验证的专用 NPM 软件包。

然后，如需在 JavaScript 或 SQLX 文件中使用该软件包，您需要将软件包的所选内容导入该文件。您还可以将整个软件包导入 JavaScript 或 SQLX 文件，而不是导入其所选内容。

为防止生产环境中出现软件包安装问题，我们建议您执行以下操作：

在 package.json 中明确指定软件包版本，例如 3.0.0。请勿使用 package.json 的其他 dependencies 选项，例如 >version。
在非生产环境中测试新的软件包版本。如需详细了解如何配置不同的代码生命周期环境，请参阅管理代码生命周期。

准备工作

在 Google Cloud 控制台中，进入 Dataform 页面。

前往 Dataform 页面
选择或创建代码库。
选择或创建开发工作区。
如果您的代码库不包含 package.json 文件，请创建 package.json 并移动 Dataform 核心软件包。
可选：如需安装私有软件包，请对私有软件包进行身份验证。

所需的角色

如需获得安装软件包所需的权限，请让您的管理员为您授予工作区的 Dataform Editor (roles/dataform.editor) IAM 角色。如需详细了解如何授予角色，请参阅管理对项目、文件夹和组织的访问权限。

您也可以通过自定义角色或其他预定义角色来获取所需的权限。

安装软件包

如需在 Dataform 代码库中安装软件包，您需要在 package.json 文件中将其添加为依赖项。

如需在 package.json 文件中将软件包添加为依赖项，请执行以下操作：

在工作区中，选择 Files（文件）窗格中的 package.json。
将该软件包添加到 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 必须与代码库中的 .nmprc 文件中定义的注册表范围相匹配。
  - 将 PACKAGE-NAME 替换为软件包的名称。
  - 将 PACKAGE-URL 替换为软件包仓库的 tar.gz 网址，例如 https://github.com/user/sample-package-repository/archive/master.tar.gz。
点击安装软件包。
提交并推送您的更改。

以下代码示例展示了添加到 .package.json 文件中的公共开源“Slowly changing dimensions”软件包：

 ```json
 {
   "name": "repository-name",
   "dependencies": {
     "@dataform/core": "2.0.3",
     "dataform-scd": "https://github.com/dataform-co/dataform-scd/archive/0.3.tar.gz"
   }
 }
 ```

将软件包函数或常量导入到 Dataform 中的 JavaScript 文件

如需在 Dataform 的 JavaScript 文件中使用软件包中的函数或常量，您需要先将其导入该文件。

如需将函数或常量从软件包导入 JavaScript 文件，请按以下步骤操作：

在工作区内的 Files 窗格中，选择要使用该软件包的 .js 文件。
在该文件中，使用以下格式导入函数或常量：
```
const { EXPORT-NAME } = require("PACKAGE-NAME");
```
1. 将 EXPORT-NAME 替换为您要使用的函数或常量的名称，该名称在软件包 index.js 文件的 module.exports 中声明。
2. 将 PACKAGE-NAME 替换为您要使用的软件包的名称。
提交并推送您的更改。

以下代码示例展示了从 postoffice 软件包导入并在 JavaScript 文件中使用的 getDomain 函数：

/*
 * Contents of postoffice index.js:
 * module.exports = { getDomain };
 */

const { getDomain } = require("postoffice");
getDomain();

将整个软件包导入 Dataform 中的 JavaScript 文件

如需将整个软件包导入 JavaScript 文件，而不是将所选函数或常量导入 JavaScript 文件，请按以下步骤操作：

在工作区内的 Files 窗格中，选择要使用该软件包的 .js 文件。
在该文件中，按以下格式导入该软件包：
```
const CONSTANT-NAME = require("PACKAGE-NAME");
```
1. 将 CONSTANT-NAME 替换为常量的名称。
2. 将 PACKAGE-NAME 替换为您要使用的软件包的名称。
提交并推送您的更改。

以下代码示例展示了 JavaScript 文件中使用的导入的 postoffice 软件包中的 getDomain 函数：

/*
 * Contents of postoffice index.js:
 * module.exports = { getDomain };
 */

const postoffice = require("postoffice");
postoffice.getDomain();

将软件包函数或常量导入 Dataform 中的 SQLX 文件

如需在 SQLX 文件中使用软件包中的函数或常量，您需要先将其导入到该文件中。

如需将函数或常量从软件包导入 SQLX 文件，请按以下步骤操作：

在工作区内的 Files 窗格中，选择要使用该软件包的 .sqlx 文件。
在文件中，输入以下 js 代码块：
```
js {
  const { EXPORT-NAME } = require("PACKAGE-NAME");
}
```
1. 将 EXPORT-NAME 替换为您要使用的函数或常量的名称，该名称在软件包 index.js 文件的 module.exports 中声明。
2. 将 PACKAGE-NAME 替换为您要使用的软件包的名称。
提交并推送您的更改。

以下代码示例展示了 postoffice 软件包中的 getDomain 函数，该函数在 js 块中导入，并在 SQLX 文件的 SELECT 语句中使用：

/*
 * Contents of postoffice index.js:
 * module.exports = { getDomain };
 */

config {
    type: "table",
}

js {
  const { getDomain } = require("postoffice");
}

SELECT ${getDomain("email")} as test

将整个软件包导入 Dataform 中的 SQLX 文件

如需将整个软件包导入 SQLX 文件，而不是将所选函数或常量导入 JavaScript 文件，请按以下步骤操作：

在工作区内的 Files 窗格中，选择要使用该软件包的 .sqlx 文件。
在该文件中，按以下格式导入该软件包：
```
js {
  const CONSTANT-NAME = require("PACKAGE-NAME");
}
```
1. 将 CONSTANT-NAME 替换为常量的名称。
2. 将 PACKAGE-NAME 替换为您要使用的软件包的名称。
提交并推送您的更改。

以下代码示例展示了在 js 块中导入的 postoffice 软件包及其在 SQLX 文件的 SELECT 语句中使用的 getDomain 函数：

/*
 * Contents of postoffice index.js:
 * module.exports = { getDomain };
 */

config {
    type: "table",
}

js {
  const postoffice = require("postoffice");
}

SELECT ${postoffice.getDomain("email")} as test

后续步骤

如需了解如何在 Dataform 中对专用 NPM 软件包进行身份验证，请参阅在 Dataform 中对专用软件包进行身份验证。
如需了解如何管理所需的 Dataform 核心软件包，请参阅管理 Dataform 核心软件包。
如需了解如何在 Dataform 中创建自己的软件包，请参阅在 Dataform 中创建软件包。
如需了解如何在 Dataform 中使用开源软件包，请参阅在 Dataform 中使用缓慢变化的维度。

在 Dataform 中安装软件包 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。