VOOZH about

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

⇱ Query SendPulse Data in DataGrip


Query SendPulse Data in DataGrip

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

Create a New Driver Definition for SendPulse

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

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

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

    Built-in Connection String Designer

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

    SendPulse API Profile Settings

    Log into your SendPulse account, navigate to Profile > Account Settings > API, and retrieve your API ID and Secret to use as your OAuth Client ID and Secret.

    πŸ‘ 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\SendPulse.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
  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 SendPulse

To browse through the SendPulse 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 AutoresponderId, AutoresponderName FROM AutomationFlowsStatistics WHERE AutoresponderStatus = '1'
πŸ‘ 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 SendPulse data in DataGrip. Reach out to our Support Team if you have any questions.