How to Connect DBeaver to Freshdesk via a JDBC Driver

The CData JDBC Driver for Freshdesk implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to Freshdesk data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for Freshdesk Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the "Database" menu, select the "Driver Manager" option. Click "New" to open the "Create new driver" form.
2. In the Settings tab:
   • Set Driver Name to a user-friendly name for the driver (e.g. CData JDBC Driver for Freshdesk).
   • Set Class Name to the class name for the JDBC driver: cdata.jdbc.freshdesk.FreshDeskDriver.
   • Set URL Template to jdbc:freshdesk:.
3. In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\) and select the JAR file (cdata.jdbc.FreshDesk.jar).

Create a Connection to Freshdesk Data

Follow the steps below to add credentials and other required connection properties.

1. In the "Database" menu, click "New Database Connection."
2. In the "Connect to a database" wizard that results, select the driver you just created (e.g. CData JDBC Driver for Freshdesk) and click "Next >."
3. On the Main tab of the configuration wizard, set the JDBC URL, using the required connection properties:

   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.

   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.

   Below is a typical connection string:

   jdbc:freshdesk:Domain=MyDomain;APIKey=myAPIKey;
4. Click "Test Connection ..." to ensure you have configured the connection properly.
5. Click "Finish."

Query Freshdesk Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click View Table. The data is available on the Data tab.

More Information & Free Trial