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

Create a New Driver Definition for ShipEngine

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

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 ShipEngine 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 ShipEngine

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

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the ShipEngine 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 ShipEngine Profile on disk (e.g. C:\profiles\ShipEngine.apip). Next, set the ProfileSettings connection property to the connection string for ShipEngine (see below).

   ShipEngine API Profile Settings

   Retrieve your ShipEngine API Key from the Dashboard at app.shipengine.com under API Management.

   👁 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\ShipEngine.apip;ProfileSettings='APIKey=your_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 ShipEngine

To browse through the ShipEngine 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 BatchId, Error FROM BatchErrors WHERE BatchId = 'batch_123'

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