BigQuery

In this section, we provide guides and references to use the BigQuery connector.

Configure and schedule BigQuery metadata and profiler workflows from the OpenMetadata UI:

If you don't want to use the OpenMetadata Ingestion container to configure the workflows via the UI, then you can check the following docs to connect using Airflow SDK or with the CLI.

To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment.

GCP Permissions

To execute metadata extraction and usage workflow successfully the user or the service account should have enough access to fetch required data. Following table describes the minimum required permissions

#GCP PermissionGCP RoleRequired For
1bigquery.datasets.getBigQuery Data ViewerMetadata Ingestion
2bigquery.tables.getBigQuery Data ViewerMetadata Ingestion
3bigquery.tables.getDataBigQuery Data ViewerMetadata Ingestion
4bigquery.tables.listBigQuery Data ViewerMetadata Ingestion
5resourcemanager.projects.getBigQuery Data ViewerMetadata Ingestion
6bigquery.jobs.createBigQuery Job UserMetadata Ingestion
7bigquery.jobs.listAllBigQuery Job UserMetadata Ingestion
8datacatalog.taxonomies.getBigQuery Policy AdminFetch Policy Tags
9datacatalog.taxonomies.listBigQuery Policy AdminFetch Policy Tags
10bigquery.readsessions.createBigQuery AdminBigquery Usage Workflow
11bigquery.readsessions.getDataBigQuery AdminBigquery Usage Workflow

The first step is ingesting the metadata from your sources. Under Settings, you will find a Services link an external source system to OpenMetadata. Once a service is created, it can be used to configure metadata, usage, and profiler workflows.

To visit the Services page, select Services from the Settings menu.

Visit Services Page

Find Services under the Settings menu

Click on the Add New Service button to start the Service creation.

Create a new service

Add a new Service from the Services page

Select BigQuery as the service type and click Next.

Select Service

Select your service from the list

Provide a name and description for your service as illustrated below.

Service Name

OpenMetadata uniquely identifies services by their Service Name. Provide a name that distinguishes your deployment from other services, including the other {connector} services that you might be ingesting metadata from.

Add New Service

Provide a Name and description for your Service

In this step, we will configure the connection settings required for this connector. Please follow the instructions below to ensure that you've configured the connector to read from your bigquery service as desired.

Configure service connection

Configure the service connection by filling the form

Once the credentials have been added, click on Test Connection and Save the changes.

Test Connection

Test the connection and save the Service

Connection Options

  • Host and Port: This is the BigQuery APIs URL.
  • Username (Optional): Specify the User to connect to BigQuery. It should have enough privileges to read all the metadata.
  • Project ID(Optional): The BigQuery Project ID is required only if the credentials path is being used instead of values. To add multiple Project ID, select Multiple Project ID under Project ID option.
  • GCS Credentials: We support two ways of authenticating to BigQuery:
    1. Passing the raw credential values provided by BigQuery. This requires us to provide the following information, all provided by BigQuery:
    2. Passing a local file path that contains the credentials:
      • GCS Credentials Path
  • Enable Policy Tag Import (Optional): Mark as 'True' to enable importing policy tags from BigQuery to OpenMetadata.
  • Tag Category Name (Optional): If the Tag import is enabled, the name of the Tag Category will be created at OpenMetadata.
  • Database (Optional): The database of the data source is an optional parameter, if you would like to restrict the metadata reading to a single database. If left blank, OpenMetadata ingestion attempts to scan all the databases.
  • Connection Options (Optional): Enter the details for any additional connection options that can be sent to BigQuery during the connection. These details must be added as Key-Value pairs.
  • Connection Arguments (Optional): Enter the details for any additional connection arguments such as security or protocol configs that can be sent to BigQuery during the connection. These details must be added as Key-Value pairs.
    • In case you are using Single-Sign-On (SSO) for authentication, add the authenticator details in the Connection Arguments as a Key-Value pair as follows: "authenticator" : "sso_login_url"
    • In case you authenticate with SSO using an external browser popup, then add the authenticator details in the Connection Arguments as a Key-Value pair as follows: "authenticator" : "externalbrowser"

If you want to use ADC authentication for BigQuery you can just leave the GCS credentials empty. This is why they are not marked as required.

In this step we will configure the metadata ingestion pipeline, Please follow the instructions below

Configure Metadata Ingestion

Configure Metadata Ingestion Page

Metadata Ingestion Options

  • Name: This field refers to the name of ingestion pipeline, you can customize the name or use the generated name.
  • Database Filter Pattern (Optional): Use to database filter patterns to control whether or not to include database as part of metadata ingestion.
    • Include: Explicitly include databases by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all databases with names matching one or more of the supplied regular expressions. All other databases will be excluded.
    • Exclude: Explicitly exclude databases by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all databases with names matching one or more of the supplied regular expressions. All other databases will be included.
  • Schema Filter Pattern (Optional): Use to schema filter patterns to control whether or not to include schemas as part of metadata ingestion.
    • Include: Explicitly include schemas by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all schemas with names matching one or more of the supplied regular expressions. All other schemas will be excluded.
    • Exclude: Explicitly exclude schemas by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all schemas with names matching one or more of the supplied regular expressions. All other schemas will be included.
  • Table Filter Pattern (Optional): Use to table filter patterns to control whether or not to include tables as part of metadata ingestion.
    • Include: Explicitly include tables by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all tables with names matching one or more of the supplied regular expressions. All other tables will be excluded.
    • Exclude: Explicitly exclude tables by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all tables with names matching one or more of the supplied regular expressions. All other tables will be included.
  • Include views (toggle): Set the Include views toggle to control whether or not to include views as part of metadata ingestion.
  • Include tags (toggle): Set the Include tags toggle to control whether or not to include tags as part of metadata ingestion.
  • Enable Debug Log (toggle): Set the Enable Debug Log toggle to set the default log level to debug, these logs can be viewed later in Airflow.
  • Mark Deleted Tables (toggle): Set the Mark Deleted Tables toggle to flag tables as soft-deleted if they are not present anymore in the source system.
  • Mark Deleted Tables from Filter Only (toggle): Set the Mark Deleted Tables from Filter Only toggle to flag tables as soft-deleted if they are not present anymore within the filtered schema or database only. This flag is useful when you have more than one ingestion pipelines. For example if you have a schema

Scheduling can be set up at an hourly, daily, or weekly cadence. The timezone is in UTC. Select a Start Date to schedule for ingestion. It is optional to add an End Date.

Review your configuration settings. If they match what you intended, click Deploy to create the service and schedule metadata ingestion.

If something doesn't look right, click the Back button to return to the appropriate step and change the settings as needed.

Schedule the Workflow

Schedule the Ingestion Pipeline and Deploy

After configuring the workflow, you can click on Deploy to create the pipeline.

Once the workflow has been successfully deployed, you can view the Ingestion Pipeline running from the Service Page.

View Ingestion Pipeline

View the Ingestion Pipeline from the Service Page

If there were any errors during the workflow deployment process, the Ingestion Pipeline Entity will still be created, but no workflow will be present in the Ingestion container.

You can then edit the Ingestion Pipeline and Deploy it again.

Workflow Deployment Error

Edit and Deploy the Ingestion Pipeline

From the Connection tab, you can also Edit the Service if needed.

Still have questions?

You can take a look at our Q&A or reach out to us in Slack

Was this page helpful?

editSuggest edits