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

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

Install the CData JDBC Driver for JotForm

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

Start a Spark Shell and Connect to JotForm Data

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

   JotForm API Profile Settings

   You will need to find your JotForm API Key in order to authenticate. To obtain an API Key, go to 'My Account' > 'API Section' > 'Create a New API Key'. Once you've created your new API Key, you can set it in the ProfileSettings connection property.

   Custom Enterprise API Domains

   Enterprise customers of JotForm are given custom API domains to connect to, rather than the default 'api.jotform.com' domain. If you are an enterprise JotForm customer, then set Domain to you custom API hostname, such as 'your-domain.com' or 'subdomain.jotform.com', inside the ProfileSettings connection property. Conversely, if you do not have a custom domain and still need to connect to 'api.jotform.com', then leave Domain undefined and set only APIKey.

   Built-in Connection String Designer

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

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

   scala> api_df.registerTable("forms")

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

   scala> api_df.sqlContext.sql("SELECT Id, Title FROM Forms WHERE Status = ENABLED").collect.foreach(println)

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

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