Joining streaming data with Dataflow SQL

---

Caution: Dataflow SQL is deprecated. As of July 31, 2024, you can no longer access Dataflow SQL in the Google Cloud console. As of January 31, 2025, you can no longer use Dataflow SQL in the Google Cloud CLI. For information about alternative methods of creating SQL queries with Dataflow, see Beam SQL and beam_sql magic.

This tutorial shows you how to use Dataflow SQL to join a stream of data from Pub/Sub with data from a BigQuery table.

Objectives

In this tutorial, you:

• Write a Dataflow SQL query that joins Pub/Sub streaming data with BigQuery table data.
• Deploy a Dataflow job from the Dataflow SQL UI.

Costs

In this document, you use the following billable components of Google Cloud:

• Dataflow
• Cloud Storage
• Pub/Sub
• Data Catalog

To generate a cost estimate based on your projected usage, use the pricing calculator. New Google Cloud users might be eligible for a free trial.

Before you begin

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Cloud Dataflow, Compute Engine, Logging, Cloud Storage, Cloud Storage JSON, BigQuery, Cloud Pub/Sub, Cloud Resource Manager and Data Catalog. APIs.

   Enable the APIs

5. Create a service account:

   1. In the Google Cloud console, go to the Create service account page.

      Go to Create service account
   2. Select your project.

   3. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

      In the Service account description field, enter a description. For example, Service account for quickstart.

   4. Click Create and continue.

   5. Grant the Project > Owner role to the service account.

      To grant the role, find the Select a role list, then select Project > Owner.

      Note: The Role field affects which resources the service account can access in your project. You can revoke these roles or grant additional roles later. In production environments, do not grant the Owner, Editor, or Viewer roles. Instead, grant a predefined role or custom role that meets your needs.
   6. Click Continue.

   7. Click Done to finish creating the service account.

      Do not close your browser window. You will use it in the next step.

6. Create a service account key:

   1. In the Google Cloud console, click the email address for the service account that you created.
   2. Click Keys.
   3. Click Add key, and then click Create new key.
   4. Click Create. A JSON key file is downloaded to your computer.
   5. Click Close.

7. Set the environment variable GOOGLE_APPLICATION_CREDENTIALS to the path of the JSON file that contains your credentials. This variable applies only to your current shell session, so if you open a new session, set the variable again.

   Example: Linux or macOS

   export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

   Replace KEY_PATH with the path of the JSON file that contains your credentials.

   For example:

   export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

   Example: Windows

   For PowerShell:

   $env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

   Replace KEY_PATH with the path of the JSON file that contains your credentials.

   For example:

   $env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

   For command prompt:

   set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

   Replace KEY_PATH with the path of the JSON file that contains your credentials.

8. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

9. Make sure that billing is enabled for your Google Cloud project.

10. Enable the Cloud Dataflow, Compute Engine, Logging, Cloud Storage, Cloud Storage JSON, BigQuery, Cloud Pub/Sub, Cloud Resource Manager and Data Catalog. APIs.

    Enable the APIs

11. Create a service account:

    1. In the Google Cloud console, go to the Create service account page.

       Go to Create service account
    2. Select your project.

    3. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

       In the Service account description field, enter a description. For example, Service account for quickstart.

    4. Click Create and continue.

    5. Grant the Project > Owner role to the service account.

       To grant the role, find the Select a role list, then select Project > Owner.

       Note: The Role field affects which resources the service account can access in your project. You can revoke these roles or grant additional roles later. In production environments, do not grant the Owner, Editor, or Viewer roles. Instead, grant a predefined role or custom role that meets your needs.
    6. Click Continue.

    7. Click Done to finish creating the service account.

       Do not close your browser window. You will use it in the next step.

12. Create a service account key:

    1. In the Google Cloud console, click the email address for the service account that you created.
    2. Click Keys.
    3. Click Add key, and then click Create new key.
    4. Click Create. A JSON key file is downloaded to your computer.
    5. Click Close.

13. Set the environment variable GOOGLE_APPLICATION_CREDENTIALS to the path of the JSON file that contains your credentials. This variable applies only to your current shell session, so if you open a new session, set the variable again.

    Example: Linux or macOS

    export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

    Replace KEY_PATH with the path of the JSON file that contains your credentials.

    For example:

    export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

    Example: Windows

    For PowerShell:

    $env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

    Replace KEY_PATH with the path of the JSON file that contains your credentials.

    For example:

    $env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

    For command prompt:

    set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

    Replace KEY_PATH with the path of the JSON file that contains your credentials.

14. Install and initialize the gcloud CLI. Choose one of the installation options. You might need to set the project property to the project that you are using for this walkthrough.
15. Go to the Dataflow SQL web UI in the Google Cloud console. This opens your most recently accessed project. To switch to a different project, click the name of the project at the top of the Dataflow SQL web UI, and search for the project you want to use.
    Go to the Dataflow SQL web UI
    

Create example sources

If you would like to follow the example provided in this tutorial, create the following sources and use them in the steps of the tutorial.

• A Pub/Sub topic called transactions - A stream of transaction data that arrives via a subscription to the Pub/Sub topic. The data for each transaction includes information like the product purchased, the sale price, and the city and state in which the purchase occurred. After you create the Pub/Sub topic, you create a script that publishes messages to your topic. You will run this script in a later section of this tutorial.
• A BigQuery table called us_state_salesregions - A table that provides a mapping of states to sales regions. Before you create this table, you need to create a BigQuery dataset.

Create a Pub/Sub topic and publisher script

1. Use the Google Cloud CLI to create your Pub/Sub topic. Name the topic transactions.

   gcloud pubsub topics create transactions

2. Create a Python script that publishes messages to your Pub/Sub topic. If you don't have Python installed, you must install Python. You will run this script in a command-line window just before you execute your SQL query.
   1. Create a text file and name it transactions_injector.py.
   2. Copy and paste the following code into transactions_injector.py. Replace project-id with your project ID.

      #!/usr/bin/env python
      
      import datetime, json, os, random, time
      
      # Set the `project` variable to a Google Cloud project ID.
      project = 'project-id'
      
      FIRST_NAMES = ['Monet', 'Julia', 'Angelique', 'Stephane', 'Allan', 'Ulrike', 'Vella', 'Melia',
          'Noel', 'Terrence', 'Leigh', 'Rubin', 'Tanja', 'Shirlene', 'Deidre', 'Dorthy', 'Leighann',
          'Mamie', 'Gabriella', 'Tanika', 'Kennith', 'Merilyn', 'Tonda', 'Adolfo', 'Von', 'Agnus',
          'Kieth', 'Lisette', 'Hui', 'Lilliana',]
      CITIES = ['Washington', 'Springfield', 'Franklin', 'Greenville', 'Bristol', 'Fairview', 'Salem',
          'Madison', 'Georgetown', 'Arlington', 'Ashland',]
      STATES = ['MO','SC','IN','CA','IA','DE','ID','AK','NE','VA','PR','IL','ND','OK','VT','DC','CO','MS',
          'CT','ME','MN','NV','HI','MT','PA','SD','WA','NJ','NC','WV','AL','AR','FL','NM','KY','GA','MA',
          'KS','VI','MI','UT','AZ','WI','RI','NY','TN','OH','TX','AS','MD','OR','MP','LA','WY','GU','NH']
      PRODUCTS = ['Product 2', 'Product 2 XL', 'Product 3', 'Product 3 XL', 'Product 4', 'Product 4 XL', 'Product 5',
          'Product 5 XL',]
      
      while True:
        first_name, last_name = random.sample(FIRST_NAMES, 2)
        data = {
          'tr_time_str': datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"),
          'first_name': first_name,
          'last_name': last_name,
          'city': random.choice(CITIES),
          'state':random.choice(STATES),
          'product': random.choice(PRODUCTS),
          'amount': float(random.randrange(50000, 70000)) / 100,
        }
      
        # For a more complete example on how to publish messages in Pub/Sub.
        #   https://cloud.google.com/pubsub/docs/publisher
        message = json.dumps(data)
        command = "gcloud --project={} pubsub topics publish transactions --message='{}'".format(project, message)
        print(command)
        os.system(command)
        time.sleep(random.randrange(1, 5))
      

Create a BigQuery dataset and table

1. In the BigQuery web UI, create a BigQuery dataset. A BigQuery dataset is a top-level container used to contain your tables. BigQuery tables must belong to a dataset.
   1. In the Explorer panel, open the actions for your project. In the menu, click Create dataset. In the following screenshot, the project ID is dataflow-sql.

      

   2. In the Create dataset panel that opens, for Dataset ID, enter dataflow_sql_tutorial.
   3. For Data location, select an option from the menu.
   4. Click Create dataset.

      

2. Create a BigQuery table.
   1. Create a text file and name it us_state_salesregions.csv.
   2. Copy and paste the following data into us_state_salesregions.csv. In the next steps you will load this data into your BigQuery table.

      state_id,state_code,state_name,sales_region
      1,MO,Missouri,Region_1
      2,SC,South Carolina,Region_1
      3,IN,Indiana,Region_1
      6,DE,Delaware,Region_2
      15,VT,Vermont,Region_2
      16,DC,District of Columbia,Region_2
      19,CT,Connecticut,Region_2
      20,ME,Maine,Region_2
      35,PA,Pennsylvania,Region_2
      38,NJ,New Jersey,Region_2
      47,MA,Massachusetts,Region_2
      54,RI,Rhode Island,Region_2
      55,NY,New York,Region_2
      60,MD,Maryland,Region_2
      66,NH,New Hampshire,Region_2
      4,CA,California,Region_3
      8,AK,Alaska,Region_3
      37,WA,Washington,Region_3
      61,OR,Oregon,Region_3
      33,HI,Hawaii,Region_4
      59,AS,American Samoa,Region_4
      65,GU,Guam,Region_4
      5,IA,Iowa,Region_5
      32,NV,Nevada,Region_5
      11,PR,Puerto Rico,Region_6
      17,CO,Colorado,Region_6
      18,MS,Mississippi,Region_6
      41,AL,Alabama,Region_6
      42,AR,Arkansas,Region_6
      43,FL,Florida,Region_6
      44,NM,New Mexico,Region_6
      46,GA,Georgia,Region_6
      48,KS,Kansas,Region_6
      52,AZ,Arizona,Region_6
      56,TN,Tennessee,Region_6
      58,TX,Texas,Region_6
      63,LA,Louisiana,Region_6
      7,ID,Idaho,Region_7
      12,IL,Illinois,Region_7
      13,ND,North Dakota,Region_7
      31,MN,Minnesota,Region_7
      34,MT,Montana,Region_7
      36,SD,South Dakota,Region_7
      50,MI,Michigan,Region_7
      51,UT,Utah,Region_7
      64,WY,Wyoming,Region_7
      9,NE,Nebraska,Region_8
      10,VA,Virginia,Region_8
      14,OK,Oklahoma,Region_8
      39,NC,North Carolina,Region_8
      40,WV,West Virginia,Region_8
      45,KY,Kentucky,Region_8
      53,WI,Wisconsin,Region_8
      57,OH,Ohio,Region_8
      49,VI,United States Virgin Islands,Region_9
      62,MP,Commonwealth of the Northern Mariana Islands,Region_9
      

   3. In the Explorer panel of the BigQuery UI, expand your project to see the dataflow_sql_tutorial dataset.
   4. Open the actions menu for the dataflow_sql_tutorial dataset, and click Open.
   5. Click Create table.

      

   6. In the Create table panel that opens:
      1. For Create table from, select Upload.

         

      2. For Select file, click Browse, and choose your us_state_salesregions.csv file.
      3. For Table, enter us_state_salesregions.
      4. Under Schema, select Auto detect.
      5. Click Advanced options to expand the Advanced options section.
      6. For Header rows to skip, enter 1, and then click Create table.

         

   7. In the Explorer panel, click us_state_salesregions. Under Schema, you can view the schema that was auto-generated. Under Preview, you can see the table data.

      

Assign a schema to your Pub/Sub topic

Assigning a schema lets you run SQL queries on your Pub/Sub topic data. Currently, Dataflow SQL expects messages in Pub/Sub topics to be serialized in JSON format.

To assign a schema to the example Pub/Sub topic transactions:

1. Create a text file and name it transactions_schema.yaml. Copy and paste the following schema text into transactions_schema.yaml.

     - column: event_timestamp
       description: Pub/Sub event timestamp
       mode: REQUIRED
       type: TIMESTAMP
     - column: tr_time_str
       description: Transaction time string
       mode: NULLABLE
       type: STRING
     - column: first_name
       description: First name
       mode: NULLABLE
       type: STRING
     - column: last_name
       description: Last name
       mode: NULLABLE
       type: STRING
     - column: city
       description: City
       mode: NULLABLE
       type: STRING
     - column: state
       description: State
       mode: NULLABLE
       type: STRING
     - column: product
       description: Product
       mode: NULLABLE
       type: STRING
     - column: amount
       description: Amount of transaction
       mode: NULLABLE
       type: FLOAT
   

2. Assign the schema using the Google Cloud CLI.

   a. Update the gcloud CLI with the following command. Ensure that the gcloud CLI version is 242.0.0 or higher.

     gcloud components update
   

   b. Run the following command in a command-line window. Replace project-id with your project ID, and path-to-file with the path to your transactions_schema.yaml file.

     gcloud data-catalog entries update \
       --lookup-entry='pubsub.topic.`project-id`.transactions' \
       --schema-from-file=path-to-file/transactions_schema.yaml
   

   For more information about the command's parameters and allowed schema file formats, see the documentation page for gcloud data-catalog entries update.

   Note: You must use ` to escape special characters in the project ID.

   c. Confirm that your schema was successfully assigned to the transactions Pub/Sub topic. Replace project-id with your project ID.

     gcloud data-catalog entries lookup 'pubsub.topic.`project-id`.transactions'
   

Find Pub/Sub sources

The Dataflow SQL UI provides a way to find Pub/Sub data source objects for any project you have access to, so you don't have to remember their full names.

For the example in this tutorial, navigate to the Dataflow SQL editor and search for the transactions Pub/Sub topic that you created:

1. Navigate to the SQL Workspace.

2. In the Dataflow SQL Editor panel, in the search bar, search for projectid=project-id transactions. Replace project-id with your project ID.

   

View the schema

1. In the Dataflow SQL Editor panel of the Dataflow SQL UI, click transactions or search for a Pub/Sub topic by typing projectid=project-id system=cloud_pubsub, and select the topic.

2. Under Schema, you can view the schema that you assigned to the Pub/Sub topic.

   

Create a SQL query

The Dataflow SQL UI lets you create SQL queries to run your Dataflow jobs.

The following SQL query is a data enrichment query. It adds an additional field, sales_region, to the Pub/Sub stream of events (transactions), using a BigQuery table (us_state_salesregions) that maps states to sales regions.

Copy and paste the following SQL query into the Query editor. Replace project-id with your project ID.

SELECT tr.*, sr.sales_region
FROM pubsub.topic.`project-id`.transactions as tr
  INNER JOIN bigquery.table.`project-id`.dataflow_sql_tutorial.us_state_salesregions AS sr
  ON tr.state = sr.state_code

When you enter a query in the Dataflow SQL UI, the query validator verifies the query syntax. A green check mark icon is displayed if the query is valid. If the query is invalid, a red exclamation point icon is displayed. If your query syntax is invalid, clicking on the validator icon provides information about what you need to fix.

The following screenshot shows the valid query in the Query editor. The validator displays a green check mark.

Create a Dataflow job to run your SQL query

If you created example sources: Before you execute your SQL query, run the transactions_injector.py Python script in a command-line window. The script periodically publishes messages to your Pub/Sub topic, transactions, and the script continues to publish messages to your topic until you stop the script.

python transactions_injector.py

To run your SQL query, create a Dataflow job from the Dataflow SQL UI.

1. In the Query editor, click Create job.

2. In the Create Dataflow job panel that opens:

   • For Destination, select BigQuery.
   • For Dataset ID, select dataflow_sql_tutorial.
   • For Table name, enter sales.

   

3. Optional: Dataflow automatically chooses the settings that are optimal for your Dataflow SQL job, but you can expand the Optional parameters menu to manually specify the following pipeline options:

   • Maximum number of workers
   • Zone
   • Service account email
   • Machine type
   • Additional experiments
   • Worker IP address configuration
   • Network
   • Subnetwork

4. Click Create. Your Dataflow job takes a few minutes to start running.

View the Dataflow job

Dataflow turns your SQL query into an Apache Beam pipeline. Click View job to open the Dataflow web UI, where you can see a graphical representation of your pipeline.

To see a breakdown of the transformations occurring in the pipeline, click the boxes. For example, if you click the first box in the graphical representation, labeled Run SQL Query, a graphic appears that shows the operations taking place behind the scenes.

The first two boxes represent the two inputs you joined: the Pub/Sub topic, transactions, and the BigQuery table, us_state_salesregions.

To view the output table that contains the job results, go to the BigQuery UI. In the Explorer panel, in your project, click the dataflow_sql_tutorial dataset that you created. Then, click the output table, sales. The Preview tab displays the contents of the output table.

Note: The sales table isn't immediately available. The output table must be generated first.

View past jobs and edit your queries

The Dataflow UI stores past jobs and queries in the Dataflow Jobs page.

You can use the job history list to see previous SQL queries. For example, you want to modify your query to aggregate sales by sales region every 15 seconds. Use the Jobs page to access the running job that you started earlier in the tutorial, copy the SQL query, and run another job with a modified query.

1. From the Dataflow Jobs page, click the job you want to edit.

2. On the Job details page, in the Job info panel, under Pipeline options, locate the SQL query. Find the row for queryString.

   

3. Copy and paste the following SQL query into the Dataflow SQL Editor in the SQL Workspace to add tumbling windows. Replace project-id with your project ID.

    SELECT
      sr.sales_region,
      TUMBLE_START("INTERVAL 15 SECOND") AS period_start,
      SUM(tr.amount) as amount
    FROM pubsub.topic.`project-id`.transactions AS tr
      INNER JOIN bigquery.table.`project-id`.dataflow_sql_tutorial.us_state_salesregions AS sr
      ON tr.state = sr.state_code
    GROUP BY
      sr.sales_region,
      TUMBLE(tr.event_timestamp, "INTERVAL 15 SECOND")
   

4. Click Create job to create a new job with the modified query.

Clean up

To avoid incurring charges to your Cloud Billing account for the resources used in this tutorial:

1. Stop your transactions_injector.py publishing script if it is still running.

2. Stop your running Dataflow jobs. Go to the Dataflow web UI in the Google Cloud console.

   Go to the Dataflow web UI

   For each job you created from following this walkthrough, do the following steps:

   1. Click the name of the job.

   2. On the Job details page, click Stop. The Stop Job dialog appears with your options for how to stop your job.

   3. Select Cancel.

   4. Click Stop job. The service halts all data ingestion and processing as soon as possible. Because Cancel immediately halts processing, you might lose any "in-flight" data. Stopping a job might take a few minutes.

3. Delete your BigQuery dataset. Go to the BigQuery web UI in the Google Cloud console.

   Go to the BigQuery web UI

   1. In the Explorer panel, in the Resources section, click the dataflow_sql_tutorial dataset you created.

   2. In the details panel, click Delete. A confirmation dialog opens.

   3. In the Delete dataset dialog box, confirm the delete command by typing delete, and then click Delete.

4. Delete your Pub/Sub topic. Go to the Pub/Sub topics page in the Google Cloud console.

   Go to the Pub/Sub topics page

   1. Select the transactions topic.

   2. Click Delete to permanently delete the topic. A confirmation dialog opens.

   3. In the Delete topic dialog box, confirm the delete command by typing delete, and then click Delete.

   4. Go to the Pub/Sub subscriptions page.

   5. Select any remaining subscriptions to transactions. If your jobs are not running anymore, there might not be any subscriptions.

   6. Click Delete to permanently delete the subscriptions. In the confirmation dialog, click Delete.

5. Delete the Dataflow staging bucket in Cloud Storage. Go to the Cloud Storage Buckets page in the Google Cloud console.

   Go to Buckets

   1. Select the Dataflow staging bucket.

   2. Click Delete to permanently delete the bucket. A confirmation dialog opens.

   3. In the Delete bucket dialog box, confirm the delete command by typing DELETE, and then click Delete.

What's next

• See an introduction to Dataflow SQL.
• Learn about streaming pipeline basics.
• Explore the Dataflow SQL reference.
• Watch the streaming analytics demo given at Cloud Next 2019.