创建 Dataform 开发工作区

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

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

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

  • definitions/:资源定义的目录(采用 Dataform 核心或 JavaScript 形式)。

  • includes/:您可以在整个代码库中重复使用的脚本和变量的空目录。

  • dataform.json:默认的 Dataform 配置文件,包含要在其中发布资源的 Google Cloud 项目 ID 和 BigQuery 架构。您可以替换默认设置,根据需要自定义这些设置,但这并不是开始使用 Dataform 的必要条件。

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

  • definitions/sample.sqlx:一个示例 SQLX 文件,可帮助您入门。

准备工作

创建 Dataform 代码库(如果您尚未创建)。

所需的角色

如需获取创建、初始化和删除开发工作区所需的权限,请让管理员向您授予工作区的 Dataform Editor (roles/dataform.editor) IAM 角色。如需详细了解如何授予角色,请参阅管理访问权限

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

创建 Dataform 开发工作区

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

  1. 在 Google Cloud 控制台中,转到 Dataform 页面。

    转到 Dataform

  2. 选择要在其中创建新的开发工作区的代码库。

  3. 在您的代码库页面上,点击 Create Development workspace

  4. Create Development workspace 窗口中,执行以下操作:

    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. 请点击删除来确认操作。

后续步骤