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

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

Install the CData JDBC Driver for FormSite

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

Start a Spark Shell and Connect to FormSite Data

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

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

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

   FormSite API Profile Settings

   Log into your Formsite account and visit the Admin Portal to generate or retrieve your API key. Your

   ServerNumber

   is the numeric part of your server URL and

   UserDirectory

   is your account's directory path.

   Built-in Connection String Designer

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

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

   scala> api_df.registerTable("formitems")

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

   scala> api_df.sqlContext.sql("SELECT Id, Label FROM FormItems WHERE Position = 1").collect.foreach(println)

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

   

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