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

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

Install the CData JDBC Driver for Klipfolio

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

Start a Spark Shell and Connect to Klipfolio Data

1. Open a terminal and start the Spark shell with the CData JDBC Driver for Klipfolio JAR file as the jars parameter: $ spark-shell --jars /CData/CData JDBC Driver for Klipfolio/lib/cdata.jdbc.api.jar
2. With the shell running, you can connect to Klipfolio 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 Klipfolio Profile on disk (e.g. C:\profiles\Klipfolio.apip). Next, set the ProfileSettings connection property to the connection string for Klipfolio (see below).

   Klipfolio API Profile Settings

   In order to authenticate to Klipfolio, you'll need to provide your API Key. You can generate an API key from the Klipfolio Dashboard app through either the My Profile page or from Users if you are an administrator (you must have the user.manage permission). Set the API Key in the ProfileSettings property to connect.

   Built-in Connection String Designer

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

   scala> val api_df = spark.sqlContext.read.format("jdbc").option("url", "jdbc:api:Profile=C:\profiles\Klipfolio.apip;ProfileSettings='APIKey=your_api_key';").option("dbtable","DataSources").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 Klipfolio data as a temporary table:

   scala> api_df.registerTable("datasources")

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

   scala> api_df.sqlContext.sql("SELECT Id, Name FROM DataSources WHERE IsDynamic = true").collect.foreach(println)

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

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