Manage the BigQuery Connector

The Composer BigQuery connector lets you access the data available in Google BigQuery storage using the Composer client. The Composer BigQuery connector supports the current version of this software as a microservice (SaaS) product.

The Composer BigQuery connector is a cloud connector that connects to Google BigQuery via the BigQuery API. See Manage Connectors and Connector Servers for general instructions and Connect to BigQuery for details specific to the BigQuery connector.

After setting up the connector, create data sources that specify the necessary connection information and identify the data you want to use. See Manage Data Sources for more information. After you set up your data sources, create dashboards and visuals from from the data in these data sources. See Create Dashboards.

Feature Support

Connector support for specific features is shown in the following table.

Key: Y - Supported; N - Not Supported; N/A - not applicable

Connect to BigQuery

When connecting to BigQuery, provide the following information:

• Key Path: you have to specify the absolute path to the file that must be available for the connector.
• Public Project IDs.

For more information about these values, refer to Google BigQuery's documentation.

Authorize the BigQuery Connection

To authorize the BigQuery connection, you need to create a security key for it. Before you can create the security key, you must access or create a BigQuery microservice account.

Create a BigQuery microservice account

1. Login to your Google API Console.

2. Select the required project from the list.

3. Make sure that current account is linked to a billing account. To check this, select the menu () icon and then select Billing.

4. On the API Manager page, select Credentials:

   

5. On the Credentials page, select Manage service accounts.

6. On the Service Accounts page, select Create Service Account and specify the following:

   • Service account name
   • Role - grant this microservice account role based access to the project. From the list, select the BigQuery category and then select BigQuery Data Viewer and BigQuery User roles.
   • Service account ID

   

7. Select Create.

After you have created an account, create a security key for it.

Create a security key

1. On the Service Accounts page, find the required account.

2. From the menu, select Create key.

3. In the Create private key dialog, select JSON for the key type and select Create. The local copy of the key is saved on your computer.

   For more information, see the following Google resource: BigQuery Introduction to Authentication.

4. Move the file with the key to the server, on which the connector is running.

Connect to BigQuery Using OAuth

To create a BigQuery connection use one of the available authentication methods:

• Key authentication flow requires a security key to be generated at BigQuery and placed to the Logi Composer instance;

• OAuth 2.0 requires providing OAuth client_id and client_secrets generated for a user that will serve for data retrieval, such as an integration user. Users are asked to authenticate via a separate authentication form. Users provide their individual credentials when accessing the data retrieved using this connection.

If both authentication methods are selected, connection via OAuth will have higher priority over key authentication except for the scheduled overrides setup.

Scheduled Override Options

To maintain Logi Composer's ability to perform scheduled operations such as scheduled dashboard reports, alerts notifications, and more when using OAuth 2.0 authentication flow, you can setup scheduled overrides with key authentication method by providing a key path.

Additional OAuth 2.0 parameters available for override, however, already have prepopulated BigQuery values and do not require manual editing:

• OAUTH2.AUTHORIZATION_URI

• OAUTH2.TOKEN_URI

• OAUTH2.SCOPES

Note: Scheduled source refresh is not available when you use OAuth 2.0 authentication.

To avoid frequent authentication requests for users, Logi Composer operates with long-lived tokens and preemptively refreshes the tokens when they are close to expiration.

Important: Users' OAuth sessions are terminated when the OAuth token is revoked, if the connection is deleted, or connection details are modified.