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

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

Install the CData JDBC Driver for BambooHR

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

Start a Spark Shell and Connect to BambooHR Data

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

   BambooHR API Profile Settings

   In order to authenticate to BambooHR, you'll need to provide your API Key. To generate an API key, log in and click your name in the upper right-hand corner of any page to get to the user context menu. If you have sufficient permissions, there will be an "API Keys" option in that menu to go to the page, where you can create a new API Key. Additionally, you will need to set the Domain, found in the domain name of your BambooHR account. For example if your BambooHR account is acmeinc.bamboohr.com, then the Domain should be 'acmeinc'. Set both the API Key and Domain in the ProfileSettings property to connect.

   Built-in Connection String Designer

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

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

   scala> api_df.registerTable("employees")

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

   scala> api_df.sqlContext.sql("SELECT Id, DisplayName FROM Employees WHERE Department = Sales").collect.foreach(println)

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

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