Query IBM Cloud Data Engine 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 IBM Cloud Data Engine, DataGrip can work with live IBM Cloud Data Engine data. This article shows how to establish a connection to IBM Cloud Data Engine data in DataGrip and use the table editor to load IBM Cloud Data Engine data.

Create a New Driver Definition for IBM Cloud Data Engine

The steps below describe how to create a new Data Source in DataGrip for IBM Cloud Data Engine.

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 IBM Cloud Data Engine 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.ibmclouddataengine.jar).
   • Set Class to cdata.jdbc.ibmclouddataengine.IBMCloudDataEngine.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 IBM Cloud Data Engine

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

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.ibmclouddataengine.jar

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

   IBM Cloud Data Engine uses the OAuth and HMAC authentication standards. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

3. Set URL to the connection string, e.g., jdbc:ibmclouddataengine:Api Key=MyAPIKey;Instance CRN=myInstanceCRN;Region=myRegion;Schema=mySchema;OAuth Client Id=myOAuthClientId;OAuth Client Secret=myOAuthClientSecret;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 IBM Cloud Data Engine

To browse through the IBM Cloud Data Engine 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 Id, Status FROM Jobs WHERE UserId = [email protected]

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