Query Google Data Catalog Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData JDBC Driver for Google Data Catalog, DataGrip can work with live Google Data Catalog data. This article shows how to establish a connection to Google Data Catalog data in DataGrip.

Create a New Driver Definition for Google Data Catalog

The steps below describe how to create a new Data Source in DataGrip for Google Data Catalog.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData Google Data Catalog Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.googledatacatalog.jar).
   • Set Class to cdata.jdbc.googledatacatalog.GoogleDataCatalog.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to Google Data Catalog

1. Once the connection is saved, click the plus (), then "Data Source" then "CData Google Data Catalog Driver" to create a new Google Data Catalog Data Source.
2. In the new window, configure the connection to Google Data Catalog with a JDBC URL.

   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.

   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.

3. Set URL to the connection string, e.g., jdbc:googledatacatalog:ProjectId=YourProjectId;InitiateOAuth=GETANDREFRESH
4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against Google Data Catalog

To browse through the Google Data Catalog entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example: SELECT Type, DatasetName FROM Schemas WHERE ProjectId = 'bigquery-public-data'

Download a free, 30-day trial of the CData JDBC Driver for Google Data Catalog and start working with your live Google Data Catalog data in DataGrip. Reach out to our Support Team if you have any questions.