VOOZH about

URL: https://www.cdata.com/kb/tech/greenhouse-jdbc-datagrip.rst

⇱ Query Greenhouse Data in DataGrip


Query Greenhouse Data in DataGrip

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Create a Data Source for Greenhouse in DataGrip and use SQL to query live Greenhouse data.

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

Create a New Driver Definition for Greenhouse

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

  1. In DataGrip, click File -> New > Project and name the project πŸ‘ Creating a new DataGrip project.
  2. In the Database Explorer, click the plus icon () and select Driver. πŸ‘ Adding a new Driver.
  3. In the Driver tab:
    • Set Name to a user-friendly name (e.g. "CData Greenhouse 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.greenhouse.jar).
    • Set Class to cdata.jdbc.greenhouse.Greenhouse.jar
  4. Click "Apply" then "OK" to save the Connection πŸ‘ A configured Driver (Salesforce is shown).

Configure a Connection to Greenhouse

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

    Built-in Connection String Designer

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

     java -jar cdata.jdbc.greenhouse.jar
     

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

    You need an API key to connect to Greenhouse. To create an API key, follow the steps below:

    1. Click the Configure icon in the navigation bar and locate Dev Center on the left.
    2. Select API Credential Management.
    3. Click Create New API Key.
      • Set "API Type" to Harvest.
      • Set "Partner" to custom.
      • Optionally, provide a description.
    4. Proceed to Manage permissions and select the appropriate permissions based on the resources you want to access through the driver.
    5. Copy the created key and set APIKey to that value.
    πŸ‘ Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
  3. Set URL to the connection string, e.g.,
    jdbc:greenhouse:APIKey=YourAPIKey;
  4. Click "Apply" and "OK" to save the connection string πŸ‘ A configured Data Source (Salesforce is shown).

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against Greenhouse

To browse through the Greenhouse entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

πŸ‘ Exploring the data (Salesforce is shown.)

To execute queries, right click on any table and select "New" -> "Query Console."

πŸ‘ Opening a new Query Console.

In the Console, write the SQL query you wish to execute. For example:

SELECT Id, CandidateId FROM Applications WHERE Status = 'Active'
πŸ‘ Querying with SQL (Salesforce is shown.)

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