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

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

Getting Started

---

Install the CData JDBC Driver for QuickBooks Online

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

Start a Spark Shell and Connect to QuickBooks Online Data

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

   $ spark-shell --jars /CData/CData JDBC Driver for QuickBooks Online/lib/cdata.jdbc.quickbooksonline.jar
   

2. With the shell running, you can connect to QuickBooks Online with a JDBC URL and use the SQL Context load() function to read a table.

   QuickBooks Online uses the OAuth authentication standard. OAuth requires the authenticating user to log in through the browser. To authenticate using OAuth, you can use the embedded OAuthClientId, OAuthClientSecret, and CallbackURL or you can obtain your own by registering an app with Intuit. Additionally, if you want to connect to sandbox data, set UseSandbox to true.

   See the Getting Started chapter of the help documentation for a guide to using OAuth.

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.quickbooksonline.jar
   

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

   👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
   

   Configure the connection to QuickBooks Online, using the connection string generated above.

   scala> val quickbooksonline_df = spark.sqlContext.read.format("jdbc").option("url", "jdbc:quickbooksonline:InitiateOAuth=GETANDREFRESH;").option("dbtable","Customers").option("driver","cdata.jdbc.quickbooksonline.QuickBooksOnlineDriver").load()
   

3. Once you connect and the data is loaded you will see the table schema displayed.

4. Register the QuickBooks Online data as a temporary table:

   scala> quickbooksonline_df.registerTable("customers")

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

   scala> quickbooksonline_df.sqlContext.sql("SELECT DisplayName, Balance FROM Customers WHERE FullyQualifiedName = Cook, Brian").collect.foreach(println)

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

   👁 Data in Apache Spark (Salesforce is shown)
   

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