Query Aha Data in DataGrip

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

Create a New Driver Definition for Aha

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

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 Aha 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.api.jar).
   • Set Class to cdata.jdbc.api.API.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 Aha

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

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.api.jar

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

   Start by setting the Profile connection property to the location of the Aha! Profile on disk (e.g. C:\profiles\aha.apip). Next, set the ProfileSettings connection property to the connection string for Aha! (see below).

   Aha! API Profile Settings

   The Aha! API uses OAuth-based authentication.

   You will first need to register an OAuth app with Aha!. This can be done from your Aha! account under 'Settings' > 'Personal' > 'Developer' > 'OAuth Applications'. Additionally, you will need to set the Domain, found in the domain name of your Aha account. For example if your Aha account is acmeinc.aha.io, then the Domain should be 'acmeinc'.

   After setting the following in the connection string, you are ready to connect:

   • AuthScheme: Set this to OAuth.
   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
   • OAuthClientId: Set this to the client_id that is specified in you app settings.
   • OAuthClientSecret: Set this to the client_secret that is specified in you app settings.
   • CallbackURL: Set this to the Redirect URI you specified in your app settings.
   • Domain: Set this in the ProfileSettings to your Aha domain.
3. Set URL to the connection string, e.g., jdbc:api:Profile=C:\profiles\aha.apip;ProfileSettings='Domain=acmeinc';Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
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 Aha

To browse through the Aha 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, Name FROM Ideas WHERE AssignedToUserId = 'my_user_id'

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