Manage workflows

Preview

This product is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA products are available "as is" and might have limited support. For more information, see the launch stage descriptions.

To request support or provide feedback for this feature, email [e-mail].

This document describes how to manage workflows, including how to schedule and delete workflows.

Workflows are powered by Dataform.

Before you begin

Before you begin, create a workflow.

Required roles

To get the permissions that you need to manage workflows, ask your administrator to grant you the following IAM roles:

• To delete workflows: Dataform Admin (roles/dataform.Admin) on the workflow
• To view and run workflows: Dataform Viewer (roles/dataform.Viewer) on the project

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.

For more information about Dataform IAM, see Access control with IAM.

Note: When you create a workflow, BigQuery grants you the Dataform Admin (roles/dataform.admin) role on that workflow. All users with the Dataform Admin (roles/dataform.admin) role granted on the Google Cloud project have owner access to all workflows created in the project.

View all workflows

To view a list of all workflows in your project, do the following:

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

   Go to BigQuery

2. In the Explorer pane, click expand Workflows.

View past manual runs

To view past manual runs of a selected workflow, follow these steps:

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

   Go to BigQuery

2. In the Explorer pane, expand your project and the Workflows folder, and then select a workflow.

3. Click Executions.

4. Optional: To refresh the list of past runs, click Refresh.

Configure alerts for failed workflow runs

Each workflow has a corresponding Dataform repository ID. Each BigQuery workflow run is logged in Cloud Logging using the corresponding Dataform repository ID. You can use Cloud Monitoring to observe trends in Cloud Logging logs for BigQuery workflow runs and to notify you when conditions you describe occur.

To receive alerts when a BigQuery workflow run fails, you can create a log-based alerting policy for the corresponding Dataform repository ID. For instructions, see Configure alerts for failed workflow invocations.

To find the Dataform repository ID of your workflow, do the following:

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

   Go to BigQuery

2. In the Explorer pane, expand your project and the Workflows folder, and then select a workflow.

3. Click Settings.

   The Dataform repository ID of your workflow is displayed at the bottom of the Settings tab.

Delete a workflow

To permanently delete a workflow, follow these steps:

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

   Go to BigQuery

2. In the Explorer pane, expand your project and the Workflows folder. Find the Workflow that you want to delete.

3. Click View actions next to the workflow, and then click Delete.

4. Click Delete.

What's next

• Learn more about workflows in BigQuery.
• Learn how to create workflows.
• Learn how to orchestrate workflows.