How to work with iContact 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 iContact, Spark can work with live iContact data. This article describes how to connect to and query iContact data from a Spark shell.

The CData JDBC Driver offers unmatched performance for interacting with live iContact data due to optimized data processing built into the driver. When you issue complex SQL queries to iContact, the driver pushes supported SQL operations, like filters and aggregations, directly to iContact 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 iContact data using native data types.

Install the CData JDBC Driver for iContact

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

Start a Spark Shell and Connect to iContact Data

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

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

2. With the shell running, you can connect to iContact 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 iContact Profile on disk (e.g. C:\profiles\IContact.apip). Next, set the ProfileSettings connection property to the connection string for iContact (see below).

   iContact API Profile Settings

   In your iContact account, navigate to Settings & Billing > Integrations and create a Custom API Integration. Your AppId, Username, Password, and AccountId are all available on the Getting Connected page of that integration.

   Built-in Connection String Designer

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

   scala> val api_df = spark.sqlContext.read.format("jdbc").option("url", "jdbc:api:Profile=C:\profiles\IContact.apip;ProfileSettings='AppId=your_app_id;Username=your_username;Password=your_password;AccountId=your_account_id';").option("dbtable","Campaigns").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 iContact data as a temporary table:

   scala> api_df.registerTable("campaigns")

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

   scala> api_df.sqlContext.sql("SELECT ClientFolderId, CampaignId FROM Campaigns WHERE Name = Summer Newsletter 2024").collect.foreach(println)

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

   

Using the CData JDBC Driver for iContact in Apache Spark, you are able to perform fast and complex analytics on iContact 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.