VOOZH about

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

⇱ Query JobNimbus Data in DataGrip


Query JobNimbus Data in DataGrip

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

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 JobNimbus data. This article shows how to establish a connection to JobNimbus data in DataGrip.

Create a New Driver Definition for JobNimbus

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

  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 JobNimbus 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
  4. Click "Apply" then "OK" to save the Connection πŸ‘ A configured Driver (Salesforce is shown).

Configure a Connection to JobNimbus

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

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the JobNimbus 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.

    Using API Key Authentication

    JobNimbus uses API key authentication to control access to the API. To obtain a JobNimbus API key:

    1. Log in to your JobNimbus account.
    2. Navigate to Settings > Integrations > API.
    3. Generate or copy your existing API key from this page.

    After obtaining your API key, set the following connection properties:

    • AuthScheme: Set this to APIKey.
    Set the following in the ProfileSettings connection property:
    • APIKey: Set this to your JobNimbus API key.

    Example Connection String

    Profile=C:\profiles\JobNimbus.apip;AuthScheme=APIKey;ProfileSettings='APIKey=my_api_key';
    
    πŸ‘ 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:api:Profile=C:\profiles\JobNimbus.apip;AuthScheme=APIKey;ProfileSettings='APIKey=my_api_key';
  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 JobNimbus

To browse through the JobNimbus 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 , FROM AccountUsers WHERE = ''
πŸ‘ Querying with SQL (Salesforce is shown.)

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