Query Azure 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 Azure Data Catalog, DataGrip can work with live Azure Data Catalog data. This article shows how to establish a connection to Azure Data Catalog data in DataGrip.

Create a New Driver Definition for Azure Data Catalog

The steps below describe how to create a new Data Source in DataGrip for Azure 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 Azure 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.azuredatacatalog.jar).
   • Set Class to cdata.jdbc.azuredatacatalog.AzureDataCatalog.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 Azure Data Catalog

1. Once the connection is saved, click the plus (), then "Data Source" then "CData Azure Data Catalog Driver" to create a new Azure Data Catalog Data Source.
2. In the new window, configure the connection to Azure 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 Azure Data Catalog JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.azuredatacatalog.jar

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

   You can optionally set the following to read the different catalog data returned from Azure Data Catalog.

   CatalogName: Set this to the CatalogName associated with your Azure Data Catalog. To get your Catalog name, navigate to your Azure Portal home page > Data Catalog > Catalog Name

   Connect Using OAuth Authentication

   You must use OAuth to authenticate with Azure Data Catalog. OAuth requires the authenticating user to interact with Azure Data Catalog using the browser. For more information, refer to the OAuth section in the help documentation.

3. Set URL to the connection string, e.g., jdbc:azuredatacatalog: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 Azure Data Catalog

To browse through the Azure 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 DslAddressDatabase, Type FROM Tables WHERE Name = 'FactProductInventory'

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