Connect to Google Data Catalog Data in DBeaver

The CData JDBC Driver for Google Data Catalog 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 Data Catalog data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for Google Data Catalog Data

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

1. Open the DBeaver application and, in the Databases menu, select the Driver Manager option. Click New to open the Create New Driver form.
2. In the Driver Name box, enter a user-friendly name for the driver.
3. To add the .jar, click Add File.
4. In the create new driver dialog that appears, select the cdata.jdbc.googledatacatalog.jar file, located in the lib subfolder of the installation directory.
5. Click the Find Class button and select the GoogleDataCatalogDriver class from the results. This will automatically fill the Class Name field at the top of the form. The class name for the driver is cdata.jdbc.googledatacatalog.GoogleDataCatalogDriver.
6. Add jdbc:googledatacatalog: in the URL Template field.

Create a Connection to Google Data Catalog Data

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

1. In the Databases menu, click New Connection.
2. In the Create new connection wizard that results, select the driver.
3. On the next page of the wizard, click the driver properties tab.

4. Enter values for authentication credentials and other properties required to connect to Google Data Catalog.

   Google Data Catalog uses the OAuth authentication standard. Authorize access to Google APIs on behalf on individual users or on behalf of users in a domain.

   Before connecting, specify the following to identify the organization and project you would like to connect to:

   • OrganizationId: The ID associated with the Google Cloud Platform organization resource you would like to connect to. Find this by navigating to the cloud console.

     Click the project selection drop-down, and select your organization from the list. Then, click More -> Settings. The organization ID is displayed on this page.

   • ProjectId: The ID associated with the Google Cloud Platform project resource you would like to connect to.

     Find this by navigating to the cloud console dashboard and selecting your project from the Select from drop-down. The project ID will be present in the Project info card.

   When you connect, the OAuth endpoint opens in your default browser. Log in and grant permissions to the application to completes the OAuth process. For more information, refer to the OAuth section in the Help documentation.

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.googledatacatalog.jar

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

   Below is a typical connection string:

   jdbc:googledatacatalog:ProjectId=YourProjectId;InitiateOAuth=GETANDREFRESH

Query Google Data Catalog Data

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