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

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

Install the CData JDBC Driver for Quickbase

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

Start a Spark Shell and Connect to Quickbase Data

1. Open a terminal and start the Spark shell with the CData JDBC Driver for Quickbase JAR file as the jars parameter: $ spark-shell --jars /CData/CData JDBC Driver for Quickbase/lib/cdata.jdbc.quickbase.jar
2. With the shell running, you can connect to Quickbase with a JDBC URL and use the SQL Context load() function to read a table.

   User Authentication Method

   To authenticate with user credentials, specify the following connection properties:

   1. Set the User and Password.
   2. If your application requires an ApplicationToken;, you must provide it otherwise an error will be thrown. You can find the ApplicationToken under SpecificApp > Settings > App management > App properties > Advanced settings > Security options > Manage Application Token.

   User Token Authentication

   To authenticate with a user token, specify the following connection properties:

   1. Set UserToken and you are ready to connect. You can find the UserToken under Quick Base > My Preferences > My User Information > Manage User Tokens.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Quickbase JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.quickbase.jar

   Fill in the connection properties and copy the connection string to the clipboard.

   Configure the connection to Quickbase, using the connection string generated above.

   scala> val quickbase_df = spark.sqlContext.read.format("jdbc").option("url", "jdbc:quickbase:User=user@domain.com;Password=password;Domain=myinstance.quickbase.com;ApplicationToken=bwkxrb5da2wn57bzfh9xn24").option("dbtable","SampleTable_1").option("driver","cdata.jdbc.quickbase.QuickBaseDriver").load()
3. Once you connect and the data is loaded you will see the table schema displayed.

4. Register the Quickbase data as a temporary table:

   scala> quickbase_df.registerTable("sampletable_1")

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

   scala> quickbase_df.sqlContext.sql("SELECT Id, Column1 FROM SampleTable_1 WHERE Column2 = 100").collect.foreach(println)

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