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

Create a New Driver Definition for Freshdesk

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

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 Freshdesk 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.freshdesk.jar).
   • Set Class to cdata.jdbc.freshdesk.FreshDesk.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 Freshdesk

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

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.freshdesk.jar

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

   FreshDesk makes use of basic authentication. To connect to data, set the following connection properties:

   • Domain: Set this to the domain associated with your FreshDesk account. For example, in your URL: https://my_domain.freshdesk.com.
   • APIKey: Set this to the API key associated with your FreshDesk account. To retrieve your API key, Log into your support Portal -> Click on profile picture in the top right corner -> profile settings page. The API key will be available below the change password section to the right.
3. Set URL to the connection string, e.g., jdbc:freshdesk:Domain=MyDomain;APIKey=myAPIKey;
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 Freshdesk

To browse through the Freshdesk 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 Tickets WHERE Status = '2'

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