创建 Dataform 开发工作区

本页面介绍如何完成以下任务：

• 创建 Dataform 开发工作区。

• 初始化一个空的 Dataform 开发工作区。

• 删除 Dataform 开发工作区。

当您首次在新代码库中创建开发工作区时，Dataform 会提示您使用一组 Dataform 运行所需的配置文件初始化开发工作区。

初始化的开发工作区包含以下目录和文件：

• definitions/：Dataform 核心或 JavaScript 中的资源定义目录。

• includes/：用于存放脚本和变量的空目录，您可以在整个代码库中重复使用这些脚本和变量。

• workflow_settings.yaml：默认的 Dataform 配置文件，其中包含要发布资源的 Google Cloud 项目 ID 和 BigQuery 架构。您可以替换默认设置，以根据自己的需求对其进行自定义，但这并不是开始使用 Dataform 的必要条件。

• package.json：包含最新版 @dataform/core 的默认 Dataform 依赖项配置文件。您可以使用此文件导入软件包。

• definitions/sample.sqlx：一个 SQLX 示例文件，可帮助您上手使用。

准备工作

如果您尚未创建 Dataform 代码库，请创建 Dataform 代码库。

所需的角色

如需获得创建、初始化和删除开发工作区的权限，请让您的管理员向您授予工作区的 Dataform Editor (roles/dataform.editor) IAM 角色。 如需详细了解如何授予角色，请参阅管理对项目、文件夹和组织的访问权限。

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

创建 Dataform 开发工作区

如需创建新的 Dataform 开发工作区，请按以下步骤操作：

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

   前往 Dataform

2. 选择要用于创建新开发工作区的代码库。

3. 在代码库页面上，点击创建开发工作区。

4. 在创建开发工作区窗口中，执行以下操作：

   1. 在工作区 ID 字段中，输入开发工作区的唯一 ID。

      ID 只能包含数字、字母、连字符和下划线。

   2. 点击创建。

初始化 Dataform 代码库中的第一个开发工作区

如需初始化 Dataform 开发工作区，请按以下步骤操作：

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

   前往 Dataform

2. 选择要初始化空工作区的代码库。

3. 在开发工作区标签页中，点击要初始化的空工作区的名称。

4. 在开发工作区页面上，点击初始化工作区。

删除 Dataform 开发工作区

创建 Dataform 开发工作区不会产生任何相关费用。但是，如果要删除开发工作区，请按以下步骤操作：

1. 在 Dataform 页面上，点击包含要删除的工作区的代码库。

2. 为避免删除未提交的更改，请提交更改并将其推送到 Git 代码库。

3. 在开发工作区标签页中，选择要删除的开发工作区，然后点击删除所选工作区。

   您可以一次删除多个工作区。

4. 请点击删除来确认操作。

后续步骤

• 如需了解如何定义表，请参阅定义表。

• 如需详细了解 Dataform，请参阅 Dataform 概览。