VOOZH about

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

⇱ Query Klaviyo Data in DataGrip


Query Klaviyo Data in DataGrip

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

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

Create a New Driver Definition for Klaviyo

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

  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 Klaviyo 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.klaviyo.jar).
    • Set Class to cdata.jdbc.klaviyo.Klaviyo.jar
  4. Click "Apply" then "OK" to save the Connection πŸ‘ A configured Driver (Salesforce is shown).

Configure a Connection to Klaviyo

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

    Built-in Connection String Designer

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

     java -jar cdata.jdbc.klaviyo.jar
     

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

    To authenticate to Klaviyo, provide an API Key. You can generate or view your API keys under 'My Account'

    1. Navigate to 'Settings' > 'API Keys'
    2. Click 'Create API Key'.
    3. Name your API key and choose the desired scopes.

    To connect in your CData solutions, set API Key to your Klaviyo API key.

    If you wish to use OAuth authentication, refer to the Help documenation. πŸ‘ 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:klaviyo: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 Klaviyo

To browse through the Klaviyo 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 Campaigns WHERE Status = 'draft'
πŸ‘ Querying with SQL (Salesforce is shown.)

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