VOOZH about

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

⇱ Query Testmonitor Data in DataGrip


Query Testmonitor Data in DataGrip

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Create a Data Source for Testmonitor in DataGrip and use SQL to query live Testmonitor 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 Testmonitor data. This article shows how to establish a connection to Testmonitor data in DataGrip.

Create a New Driver Definition for Testmonitor

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

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

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

    Built-in Connection String Designer

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

    Testmonitor API Profile Settings

    Generate a token in TestMonitor by navigating to My Account > API > Create Token. Your Domain is extracted from your account subdomain.

    πŸ‘ 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\Testmonitor.apip;ProfileSettings='APIKey=your_api_key;Domain=your_subdomain';
  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 Testmonitor

To browse through the Testmonitor 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, Name FROM Applications WHERE Name = 'MyApplication'
πŸ‘ 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 Testmonitor data in DataGrip. Reach out to our Support Team if you have any questions.