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

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

Install the CData JDBC Driver for Typeform

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

Start a Spark Shell and Connect to Typeform Data

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

   TypeForm API Profile Settings

   Authentication to TypeForm uses the OAuth standard.

   To authenticate to TypeForm, you must first register and configure an OAuth application with TypeForm here: https://admin.typeform.com/account#/section/tokens. Your app will be assigned a client ID and a client secret which can be set in the connection string. More information on setting up an OAuth application can be found at https://developer.typeform.com/get-started/.

   Note that there are several different use scenarios which all require different redirect URIs:

   • CData Desktop Applications: CData desktop applications (Sync, API Server, ArcESB) accept OAuth tokens at /src/oauthCallback.rst. The host and port is the same as the default port used by the application. For example, if you use http://localhost:8019/ to access CData Sync then the redirect URI will be http://localhost:8019/src/oauthCallback.rst.
   • CData Cloud Applications: CData cloud applications are similar to their desktop counterparts. If you access Connect Cloud at https://1.2.3.4/ then you should use the redirect https://1.2.3.4/src/oauthCallback.rst.
   • Desktop Application: When using a desktop application, the URI https://localhost:33333 is recommended.
   • Web Application: When developing a web application using the driver, use your own URI here such as https://my-website.com/oauth.

   After setting the following connection properties, you are ready to connect:

   • AuthScheme: Set this to OAuth.
   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
   • OAuthClientId: Set this to the Client Id that is specified in your app settings.
   • OAuthClientSecret: Set this to Client Secret that is specified in your app settings.
   • CallbackURL: Set this to the Redirect URI you specified in your app settings.

   Built-in Connection String Designer

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

   scala> val api_df = spark.sqlContext.read.format("jdbc").option("url", "jdbc:api:Profile=C:\profiles\TypeForm.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;").option("dbtable","Tags").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 Typeform data as a temporary table:

   scala> api_df.registerTable("tags")

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

   scala> api_df.sqlContext.sql("SELECT Id, Title FROM Tags WHERE SettingsIsPublic = true").collect.foreach(println)

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

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