Create a Dataform development workspace

This document shows you how to do the following:

When you create a development workspace in a new repository for the first time, Dataform prompts you to initialize the development workspace with a set of configuration files that are required for Dataform to work.

An initialized development workspace contains the following directories and files:

  • definitions/: a directory for asset definitions, in Dataform core or JavaScript.

  • includes/: an empty directory for scripts and variables that you can reuse across the repository.

  • dataform.json: the default Dataform configuration file containing the Google Cloud project ID and BigQuery schema to publish assets in. You can override the default settings to customize them to your needs, but it's not a requirement to begin using Dataform.

  • package.json: the default Dataform dependencies configuration file with the latest version of @dataform/core. You can use this file to import packages.

  • definitions/sample.sqlx: a sample SQLX file to help you get started.

Before you begin

If you haven't done so already, create a Dataform repository.

Required roles

To get the permissions that you need to create, initialize, and delete a development workspace, ask your administrator to grant you the Dataform Editor (roles/dataform.editor) IAM role on workspaces. For more information about granting roles, see Manage access to projects, folders, and organizations.

You might also be able to get the required permissions through custom roles or other predefined roles.

Create a Dataform development workspace

To create a new Dataform development workspace, follow these steps:

  1. In the Google Cloud console, go to the Dataform page.

    Go to Dataform

  2. Select the repository where you want to create the new development workspace.

  3. On your repository page, click Create development workspace.

  4. In the Create development workspace window, do the following:

    1. In the Workspace ID field, enter a unique ID for the development workspace.

      IDs can only include numbers, letters, hyphens, and underscores.

    2. Click Create.

Initialize the first development workspace in a Dataform repository

To initialize a Dataform development workspace, follow these steps:

  1. In the Google Cloud console, go to the Dataform page.

    Go to Dataform

  2. Select the repository where you want to initialize the empty workspace.

  3. In the Development workspaces tab, click the name of the empty workspace you want to initialize.

  4. On the development workspace page, click Initialize workspace.

Delete a Dataform development workspace

There are no costs associated with creating Dataform development workspaces. However, if you want to delete a development workspace, follow these steps:

  1. On the Dataform page, click the repository that contains the workspace that you want to delete.

  2. To avoid deleting uncommitted changes, commit and push changes to your Git repository.

  3. In the Development workspaces tab, select the development workspace that you want to delete, and then click Delete selected workspaces.

    You can delete multiple workspaces at once.

  4. To confirm, click Delete.

What's next