In this article we will discuss how to connect a Google BigQuery database to Preset. There are two methods that we support to do this.
- Method One: Connect by providing a JSON code for authentication; or,
- Method Two: Connect by providing a SQLAlchemy URI and JSON authentication code.
Below we will discuss both methods. For simplicity and ease-of-use, we recommend that users follow Method One.
Setting up the Google Backend
In order to connect to Google BigQuery, regardless of the preferred method, you'll need to:
- Select an existing Google Project or create a new one;
- Create and configure a Google Service Account;
- Create and save a JSON key.
We'll walk you through all of the steps above so that you can get started using your Google BigQuery database connection!
Pre-connection Steps with Google
Step One: Associate a Google Project
A project organizes all your Google Cloud resources. A project consists of a set of users; a set of APIs; and billing, authentication, and monitoring settings for those APIs. So, for example, all of your Cloud Storage buckets and objects, along with user permissions for accessing them, reside in a project (source ).
The first step is to select an existing Google Project or create a new Google Project. You can do this by navigating to the Google Cloud Platform Console .
If this is your first time visiting the Platform Console, be sure to select your country and accept the Terms of Service.
On the Google Cloud Platform Console, ensure that you are logged in to your correct Google Account.
The Platform Console will display any existing projects — feel free to select an existing project if desired.
To create a project, select Create Project.
In the Project name field, enter a name for your project — this will become your project ID.
Take note of the correctly formatted "Project ID" below the Project name field — you will need this if you decide to connect via a SQLAlchemy URI. In the graphic below, the project ID is preset-connections-317005. Select Edit if you want to change this.
If the Google account you are logged in under belongs to an organization (i.e., non-gmail.com), then an Organization field appears and the domain of your organization appears by default.
If needed, select a location in the Location field. When done, select Create.
Post-creation, the Service Accounts screen appears.
Step Two: Create & Configure a Google Service Account
In this step we will create and configure a new Google Service Account.
A service account is a special type of Google account intended to represent a non-human user that needs to authenticate and be authorized to access data in Google APIs (source ).
Create a Service Account
Let's start by selecting + Create Service Account.
In the Service account name field, enter a memorable name for the service account. The Service account ID field will automatically populate based on the defined account name.
In the Service account description field, enter a brief description of the service account.
When done, select Create and Continue.
In this step, you need to grant service account access.
In the Select a role field, grant the desired permissions to the service account, according to your needs:
- If you plan to use Preset for read-only access, granting BigQuery Data Viewer, BigQuery Metadata Viewer, BigQuery Read Session User and BigQuery Job User roles should be sufficient.
- If you also want to perform DML operation within Preset, grant the BigQuery Data Editor role as well.
You can find additional information about all available roles and the permissions associated with them on the Google Cloud Platform documentation.
When ready, select Done (the last step—granting access to users—is not required).
Step Three: Create & Save a JSON Key
A table displaying your new Google Service Account—which we've called Preset Connections—appears.
Our next step is to create a private key in JSON that will be downloaded to your local system. This will be used later on when we configure the database connection in Preset.
In the table, under the Actions column header, select the vertical ellipsis icon and then choose Manage keys.
The Service Account details screen appears with the Keys tab selected. In the Add Key drop-down menu, select Create new key.
The Create private key window appears. By default, the JSON key type is selected. Ensure that this is indeed the case and then select Create.
The key, in JSON file format, will download to your local system. Be sure to save this file.
Alright! So we've created a project, a service account, and now have a JSON key! Time to connect your BigQuery database to Preset.
Allowlist Preset IPs
Preset Cloud currently runs on three regions with the IPs listed below, and those need to be allowlisted so Preset can access your data.
Before connecting to Preset, please take a moment to allowlist the IPs below based on the region that you're deployed in.
|us-west-2 (us1a)||us-east-1 (us2a)||eu-north-1 (eu5a)||ap-northeast-1 (ap1a)|
If you are not sure where your Preset workspace is located, you can refer to the URL on your browser when accessing Preset. It should look like this: https://xxxxxxxx.us2a.app.preset.io/superset..., where us2a means it is in us-east-1.
Method One: Provide your JSON Code
Let's start by selecting + Database — have a look at Connecting your Data if you need help wth this step.
...then select the Google BigQuery icon:
In the Display Name field, enter a nickname for your database for display in the Preset environment.
Option One: Upload JSON File
In the How do you want to enter service account credentials? field, select Upload JSON file and then select Choose File.
Navigate to the JSON file you downloaded earlier and select it for upload to Preset. The JSON filename will appear — select the trash bin icon to remove the file, if needed.
Option Two: Copy & Paste JSON Code
Alternatively, you can directly paste your JSON code.
In the How do you want to enter service account credentials? field, select Copy and Paste JSON credentials. The Service Account text-entry field appears.
Copy your JSON code in its entirety and then paste the contents into the Service Account field.
Making the Connection
If you have any additional parameters, then enter them in the Additional Parameters field.
If not, then go ahead and select Connect.
Great work! You can now make additional configurations to your database, if needed. To learn how to do this, please visit the Advanced Connection Settings article.
Method Two: Connect via a SQLAlchemy URI
Enter SQLAlchemy URI
Like Method One above, start by selecting the Google BigQuery icon, then scroll to the bottom of the Connect a Database panel.
Select Connect this database with a SQLAlchemy URI string instead.
The screen is now organized into two tabs: Basic and Advanced.
In the SQLAlchemy URI field, enter your URI using the following syntax:
Given the example used earlier in this article, the URI would look as follows:
Provide JSON Authentication Code
Select the Advanced tab and then expand the Security panel.
Copy the JSON code from the file you downloaded earlier and then paste it into the Secure Extra field.
To ensure that the code works correctly, please wrap the JSON with a "credentials_info" element. This looks as follows:
If you want to explore other configuration settings, then please see Advanced Connection Settings.
Make the Connection
Next, navigate back to the Basic tab and then select Test Connection.
A notification message will appear indicating success or failure. If the test worked, then go ahead and select Connect to finalize the database connection.