Skip to main content

Connect to Google BigQuery

Connection Modes: Direct

Connection​

To connect to Google BigQuery, select Add Datasource on the datasources overview page to open the Create Datasource dialog and select Google BigQuery as the database type.

image-600 image-600

The Name is a required human-friendly identifier or description of the datasource in Cluvio. Datasource names need not be unique but we recommend to give each datasource a unique and meaningful name for ease of identification, especially if your organization uses multiple datasources.

The Project ID is the identifier for your Google Cloud project that uses BigQuery. See Locate the project ID in the Google Cloud documentation.

The optional Dataset allows restricting Cluvio to only work on a single dataset. See the Introduction to Datasets in the Google Cloud documentation. Cluvio will fetch schema information just this dataset or for all datasets, if no dataset is configured, to populate the almanach in the report editor.

The Service Key (JSON) must be set to the downloaded JSON for a Service Account Key that has permissions to access Google BigQuery in your Google Cloud project. The service key JSON contains a private key that is securely stored by Cluvio and only used to authenticate your Cluvio connection to Google BigQuery. See Create Service Key for details on how to obtain a service key.

When you have entered all the required information, select Test Connection to check that Cluvio can connect to your database. The connection test will report errors if the connection fails. See Troubleshooting for common problems.

Create Service Key​

A service key in the Google Cloud is associated with a service account. You can use an existing service account or create a new service account specifically for Cluvio.

image-200 image-200

From the Actions drop-down menu for the Cluvio service account, select Manage Keys.

image-200 image-200

Create a new service key for Cluvio by selecting Add key > Create new key.

image-200 image-200

Choose JSON as the key type and click Create.

image-500 image-500

The JSON file is automatically downloaded by your web browser. Copy the contents of this file into the Service Key (JSON) field of your datasource configuration.

Configuration​

The Configuration tab of the datasource dialog shows settings that affect the datasource's behavior.

image-600 image-600

The Data Time Zone defaults to UTC and is the time zone that Cluvio assumes for any timestamps returned from queries that do not contain time zone information. See Data Time Zone for details.

The Maximum number of concurrent query executions control the maximum concurrency that Cluvio allows for the datasource. This setting can be used to control the maximum load on your database. The default is 20.

The toggle Update schema nightly controls whether Cluvio queries your database schema nightly to ensure that the almanach in the report editor has up-to-date information on your database schema. Together with fetching schema information, Cluvio also tries to retrieve approximate row counts in each table. If you disable nightly schema updates, the almanach is only updated when you manually trigger a schema refresh on the datasource from the Cluvio datasources overview. Nightly schema updates are enabled by default.

The toggle Update exact row counts is only available when Update schema nightly is enabled. This setting controls whether Cluvio will determine exact row counts for every table in your database schema. Row counts are shown in the report editor almanach. Determining exact row counts usually involves issuing a COUNT(*) query on each table, which may cause undesirable load on your database. You can disable this setting to avoid these nightly queries. When disabled, the tables in the report editor almanach may not show row count information if the database does not provide approximate row counts.

Troubleshooting​

If you need help connecting to your Google BigQuery data, please contact support@cluvio.com.