How to Connect DBeaver to Google Cloud Storage via a JDBC Driver

The CData JDBC Driver for Google Cloud Storage implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to Google Cloud Storage data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for Google Cloud Storage Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the "Database" menu, select the "Driver Manager" option. Click "New" to open the "Create new driver" form.
2. In the Settings tab:
   • Set Driver Name to a user-friendly name for the driver (e.g. CData JDBC Driver for Google Cloud Storage).
   • Set Class Name to the class name for the JDBC driver: cdata.jdbc.googlecloudstorage.GoogleCloudStorageDriver.
   • Set URL Template to jdbc:googlecloudstorage:.
3. In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\) and select the JAR file (cdata.jdbc.GoogleCloudStorage.jar).

Create a Connection to Google Cloud Storage Data

Follow the steps below to add credentials and other required connection properties.

1. In the "Database" menu, click "New Database Connection."
2. In the "Connect to a database" wizard that results, select the driver you just created (e.g. CData JDBC Driver for Google Cloud Storage) and click "Next >."
3. On the Main tab of the configuration wizard, set the JDBC URL, using the required connection properties:

   Authenticate with a User Account

   You can connect without setting any connection properties for your user credentials. After setting InitiateOAuth to GETANDREFRESH, you are ready to connect.

   When you connect, the Google Cloud Storage OAuth endpoint opens in your default browser. Log in and grant permissions, then the OAuth process completes

   Authenticate with a Service Account

   Service accounts have silent authentication, without user authentication in the browser. You can also use a service account to delegate enterprise-wide access scopes.

   You need to create an OAuth application in this flow. See the Help documentation for more information. After setting the following connection properties, you are ready to connect:

   • InitiateOAuth: Set this to GETANDREFRESH.
   • OAuthJWTCertType: Set this to "PFXFILE".
   • OAuthJWTCert: Set this to the path to the .p12 file you generated.
   • OAuthJWTCertPassword: Set this to the password of the .p12 file.
   • OAuthJWTCertSubject: Set this to "*" to pick the first certificate in the certificate store.
   • OAuthJWTIssuer: In the service accounts section, click Manage Service Accounts and set this field to the email address displayed in the service account Id field.
   • OAuthJWTSubject: Set this to your enterprise Id if your subject type is set to "enterprise" or your app user Id if your subject type is set to "user".
   • ProjectId: Set this to the Id of the project you want to connect to.

   The OAuth flow for a service account then completes.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Google Cloud Storage JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.googlecloudstorage.jar

   Fill in the connection properties and copy the connection string to the clipboard.

   Below is a typical connection string:

   jdbc:googlecloudstorage:ProjectId='project1';InitiateOAuth=GETANDREFRESH
4. Click "Test Connection ..." to ensure you have configured the connection properly.
5. Click "Finish."

Query Google Cloud Storage Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click View Table. The data is available on the Data tab.

More Information & Free Trial