VOOZH about

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

⇱ Connect to Klaviyo Data in JRuby


Connect to Klaviyo Data in JRuby

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Create a simple JRuby app with access to live Klaviyo data.

JRuby is a high-performance, stable, fully threaded Java implementation of the Ruby programming language. The CData JDBC Driver for Klaviyo makes it easy to integrate connectivity to live Klaviyo data in JRuby. This article shows how to create a simple JRuby app that connects to Klaviyo data, executes a query, and displays the results.

Configure a JDBC Connection to Klaviyo Data

Before creating the app, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Klaviyo\lib).

JRuby natively supports JDBC, so you can easily connect to Klaviyo and execute SQL queries. Initialize the JDBC connection with the getConnection function of the java.sql.DriverManager class.

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.

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.

👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

Below is a typical JDBC connection string for Klaviyo:

jdbc:klaviyo:APIKey=my_api_key;

Create a JRuby App with Connectivity to Klaviyo Data

Create a new Ruby file (for example: KlaviyoSelect.rb) and open it in a text editor. Copy the following code into your file:

require 'java'
require 'rubygems'
require 'C:/Program Files/CData/CData JDBC Driver for Klaviyo 2018/lib/cdata.jdbc.klaviyo.jar'

url = "jdbc:klaviyo:APIKey=my_api_key;"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT Id, Name FROM Campaigns")
while (rs.next) do
 puts rs.getString(1) + ' ' + rs.getString(2)
end

With the file completed, you are ready to display your Klaviyo data with JRuby. To do so, simply run your file from the command line:

jruby -S KlaviyoSelect.rb

Writing SQL-92 queries to Klaviyo allows you to quickly and easily incorporate Klaviyo data into your own JRuby applications. Download a free trial today!