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

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

Install the CData JDBC Driver for Clio

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

Start a Spark Shell and Connect to Clio Data

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

   Clio API Profile Settings

   Clio uses OAuth-based authentication.

   First, register an OAuth application with Clio. You can do so by logging to your Developer Account and clicking the Add button. Enter details and select the scope of your application here - these details will be shown to Clio users when they're asked to authorize your application. Your Oauth application will be assigned a client id (key) and a client secret (secret). Additionally you will need to set the Region in ProfileSettings connection property.

   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 you app settings.
   • OAuthClientSecret: Set this to the client_secret that is specified in you app settings.
   • CallbackURL: Set this to the Redirect URI that is specified in your app settings.
   • Region: Set this in ProfileSettings to your Clio geographic region. Defaults to app.clio.com.

   Built-in Connection String Designer

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

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

   scala> api_df.registerTable("bills")

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

   scala> api_df.sqlContext.sql("SELECT Id, Total FROM Bills WHERE State = awaiting_payment").collect.foreach(println)

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

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