Create and execute a SQL workflow in Dataform

Create a Dataform repository

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

   Go to Dataform

2. Click add Create repository.

3. On the Create repository page, do the following:

   1. In the Repository ID field, enter quickstart-repository.

   2. In the Region list, select europe-west4.

   3. Click Create.

Create and initialize a Dataform development workspace

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

   Go to Dataform

2. Click quickstart-repository.

3. Click add Create development workspace.

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

   1. In the Workspace ID field, enter quickstart-workspace.

   2. Click Create.

   The development workspace page appears.

5. Click Initialize workspace.

Create a view

In the following sections, you define a view that you will later use as a data source for a table.

Create a SQLX file for defining a view

1. In the Files pane, next to definitions/, click the more_vert More menu.

2. Click Create file.

3. In the Create new file pane, do the following:

   1. In the Add a file path field, enter definitions/quickstart-source.sqlx.

   2. Click Create file.

Define a view

1. In the Files pane, expand the definitions folder.

2. Click definitions/quickstart-source.sqlx.

3. In the file, enter the following code snippet:

   config {
     type: "view"
   }
   
   SELECT
     "apples" AS fruit,
     2 AS count
   UNION ALL
   SELECT
     "oranges" AS fruit,
     5 AS count
   UNION ALL
   SELECT
     "pears" AS fruit,
     1 AS count
   UNION ALL
   SELECT
     "bananas" AS fruit,
     0 AS count
   

4. Click Format.

Create a table

In the following sections, you define the table type in a SQLX file, and then write a SELECT statement to define the table structure within the same file.

Create a SQLX file for table definition

1. In the Files pane, next to definitions/, click the more_vert More menu, and then select Create file.

2. In the Add a file path field, enter definitions/quickstart-table.sqlx.

3. Click Create file.

Define the table type, structure and dependencies

1. In the Files pane, expand the definitions/ directory.

2. Select quickstart-table.sqlx, and then enter the following table type and SELECT statement:

   config {
     type: "table"
   }
   
   SELECT
     fruit,
     SUM(count) as count
   FROM ${ref("quickstart-source")}
   GROUP BY 1
   

3. Click Format.

After defining the table type, Dataform throws a query validation error because quickstart-source does not exist in BigQuery yet. This error is resolved when you execute the SQL workflow later in this tutorial.

Grant Dataform access to BigQuery

To execute workflows in BigQuery, the Dataform service account must have the following required roles:

• BigQuery Data Editor on projects to which Dataform needs both read and write access. They usually include the project hosting your Dataform repository.
• BigQuery Data Viewer on projects to which Dataform needs read-only access.
• BigQuery Job User on the project hosting your Dataform repository.

To grant these roles, follow these steps:

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

   Go to the IAM page

2. Click Add.

3. In the New principals field, enter your Dataform service account ID.

4. In the Select a role drop-down list, select the BigQuery Job User role.

5. Click Add another role, and then in the Select a role drop-down list, select the BigQuery Data Editor role.

6. Click Add another role, and then in the Select a role drop-down list, select the BigQuery Data Viewer role.

7. Click Save.

Execute the workflow

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

   Go to Dataform

2. On the quickstart-workspace page, click Start execution.

3. Click All actions.

4. In the Execute pane, click Start execution.

   Dataform uses the default repository settings to create the contents of your workflow in a BigQuery dataset called dataform.

View execution logs in Dataform

1. On the quickstart-repository page, click Workflow Execution Logs.

2. To view details of your execution, click the latest execution.