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

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

Install the CData JDBC Driver for Freshservice

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

Start a Spark Shell and Connect to Freshservice Data

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

   $ spark-shell --jars /CData/CData JDBC Driver for Freshservice/lib/cdata.jdbc.api.jar
   

2. With the shell running, you can connect to Freshservice 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 Freshservice Profile on disk (e.g. C:\profiles\Freshservice.apip). Next, set the ProfileSettings connection property to the connection string for Freshservice (see below).

   Freshservice API Profile Settings

   Obtain your API Key from Profile Settings in the top-right corner of Freshservice. Your Domain is the subdomain from your account URL.

   Built-in Connection String Designer

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

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

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

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

   scala> api_df.registerTable("agentgroups")

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

   scala> api_df.sqlContext.sql("SELECT Id, Name FROM AgentGroups WHERE Name = Support Team").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 Freshservice in Apache Spark, you are able to perform fast and complex analytics on Freshservice 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.