How to work with Omnisend Data in Apache Spark using SQL

Apache Spark is a fast and general engine for large-scale data processing. When paired with the CData JDBC Driver for Omnisend, Spark can work with live Omnisend data. This article describes how to connect to and query Omnisend data from a Spark shell.

The CData JDBC Driver offers unmatched performance for interacting with live Omnisend data due to optimized data processing built into the driver. When you issue complex SQL queries to Omnisend, the driver pushes supported SQL operations, like filters and aggregations, directly to Omnisend and utilizes the embedded SQL engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can work with and analyze Omnisend data using native data types.

Install the CData JDBC Driver for Omnisend

Download the CData JDBC Driver for Omnisend installer, unzip the package, and run the JAR file to install the driver.

Start a Spark Shell and Connect to Omnisend Data

1. Open a terminal and start the Spark shell with the CData JDBC Driver for Omnisend JAR file as the jars parameter:

   $ spark-shell --jars /CData/CData JDBC Driver for Omnisend/lib/cdata.jdbc.api.jar
   

2. With the shell running, you can connect to Omnisend with a JDBC URL and use the SQL Context load() function to read a table.

   Start by setting the Profile connection property to the location of the Omnisend Profile on disk (e.g. C:\profiles\Omnisend.apip). Next, set the ProfileSettings connection property to the connection string for Omnisend (see below).

   Omnisend API Profile Settings

   Navigate to your Omnisend account integrations at https://app.omnisend.com/#/my-account/integrations/api-keys to generate an API key.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Omnisend 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.

   

   Configure the connection to Omnisend, using the connection string generated above.

   scala> val api_df = spark.sqlContext.read.format("jdbc").option("url", "jdbc:api:Profile=C:\profiles\Omnisend.apip;ProfileSettings='APIKey=your_api_key';").option("dbtable","Batches").option("driver","cdata.jdbc.api.APIDriver").load()
   

3. Once you connect and the data is loaded you will see the table schema displayed.

4. Register the Omnisend data as a temporary table:

   scala> api_df.registerTable("batches")

5. Perform custom SQL queries against the Data using commands like the one below:

   scala> api_df.sqlContext.sql("SELECT BatchId, Method FROM Batches WHERE Status = completed").collect.foreach(println)

   You will see the results displayed in the console, similar to the following:

   

Using the CData JDBC Driver for Omnisend in Apache Spark, you are able to perform fast and complex analytics on Omnisend data, combining the power and utility of Spark with your data. Download a free, 30 day trial of any of the hundreds of CData JDBC Drivers and get started today.