Ready to get started?

Learn more about the CData JDBC Driver for FreshBooks or download a free trial:

Download Now

Process & Analyze FreshBooks Data in Azure Databricks

Host the CData JDBC Driver for FreshBooks in Azure and use Databricks to perform data engineering and data science on live FreshBooks data.

Databricks is a cloud-based service that provides data processing capabilities through Apache Spark. When paired with the CData JDBC Driver, customers can use Databricks to perform data engineering and data science on live FreshBooks data. This article walks through hosting the CData JDBC Driver in Azure, as well as connecting to and processing live FreshBooks data in Databricks.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live FreshBooks data. When you issue complex SQL queries to FreshBooks, the driver pushes supported SQL operations, like filters and aggregations, directly to FreshBooks and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze FreshBooks data using native data types.

Install the CData JDBC Driver in Azure

To work with live FreshBooks data in Databricks, install the driver on your Azure cluster.

  1. Navigate to your Databricks administration screen and select the target cluster.
  2. On the Libraries tab, click "Install New."
  3. Select "Upload" as the Library Source and "Jar" as the Library Type.
  4. Upload the JDBC JAR file (cdata.jdbc.freshbooks.jar) from the installation location (typically C:\Program Files\CData\CData JDBC Driver for FreshBooks\lib).

Connect to Salesforce from Databricks

With the JAR file installed, we are ready to work with live FreshBooks data in Databricks. Start by creating a new notebook in your workspace. Name the notebook, select Python as the language (though Scala is available as well), and choose the cluster where you installed the JDBC driver. When the notebook launches, we can configure the connection, query FreshBooks, and create a basic report.

Configure the Connection to FreshBooks

Connect to FreshBooks by referencing the class for the JDBC Driver and constructing a connection string to use in the JDBC URL.

driver = "cdata.jdbc.freshbooks.FreshBooksDriver"
url = "jdbc:freshbooks:CompanyName=CData;Token=token;"

Built-in Connection String Designer

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

java -jar cdata.jdbc.freshbooks.jar

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

To connect to FreshBooks, you can set the CompanyName and Token connection properties. Alternatively, you can use the OAuth authentication standard.

OAuth can be used to enable other users to access their own company data. To authenticate using OAuth, you will need to obtain the OAuthClientId and OAuthClientSecret by registering an app. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

Load FreshBooks Data

Once the connection is configured, you can load FreshBooks data as a dataframe using the CData JDBC Driver and the connection information.

remote_table = spark.read.format ( "jdbc" ) \
	.option ( "driver" , driver) \
	.option ( "url" , url) \
	.option ( "dbtable" , "Clients") \
	.load ()

Display FreshBooks Data

Check the loaded FreshBooks data by calling the display function.

display (remote_table.select ("Username"))

Analyze FreshBooks Data in Azure Databricks

If you want to process data with Databricks SparkSQL, register the loaded data as a Temp View.

remote_table.createOrReplaceTempView ( "SAMPLE_VIEW" )

The SparkSQL below retrieves the FreshBooks data for analysis.

% sql

SELECT Username, Credit FROM Clients

The data from FreshBooks is only available in the target notebook. If you want to use it with other users, save it as a table.

remote_table.write.format ( "parquet" ) .saveAsTable ( "SAMPLE_TABLE" )

Download a free, 30-day trial of the CData JDBC Driver for FreshBooks and start working with your live FreshBooks data in Apache NiFi. Reach out to our Support Team if you have any questions.