Process & Analyze Xero Data in Databricks (AWS)

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Xero JDBC Driver

Complete read-write access to Xero accounting enables developers to search (Customers, Transactions, Invoices, Sales Receipts, etc.), update items, edit customers, and more, from any Java/J2EE application.



Host the CData JDBC Driver for Xero in AWS and use Databricks to perform data engineering and data science on live Xero 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 Xero data. This article walks through hosting the CData JDBC Driver in AWS, as well as connecting to and processing live Xero data in Databricks.

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

Install the CData JDBC Driver in Databricks

To work with live Xero data in Databricks, install the driver on your Databricks 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.xero.jar) from the installation location (typically C:\Program Files\CData\CData JDBC Driver for Xero\lib).

Access Xero Data in your Notebook: Python

With the JAR file installed, we are ready to work with live Xero 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 Xero, and create a basic report.

Configure the Connection to Xero

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

Step 1: Connection Information

driver = "cdata.jdbc.xero.XeroDriver"
url = "jdbc:xero:InitiateOAuth=GETANDREFRESH"

Built-in Connection String Designer

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

java -jar cdata.jdbc.xero.jar

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

To connect, set the Schema connection property in addition to any authentication values. Xero offers authentication for private applications, public applications, and partner applications. You will need to set the XeroAppAuthentication property to PUBLIC, PRIVATE, or PARTNER, depending on the type of application configured. To connect from a private application, you will additionally need to set the OAuthAccessToken, OAuthClientId, OAuthClientSecret, CertificateStoreType, CertificateStore, and CertificateStorePassword.

To connect from a public or partner application, you can use the embedded OAuthClientId, OAuthClientSecret, and CallbackURL, or you can register an app to obtain your own OAuth values.

See the "Getting Started" chapter of the help documentation for a guide to authenticating to Xero.

Load Xero Data

Once you configure the connection, you can load Xero data as a dataframe using the CData JDBC Driver and the connection information.

Step 2: Reading the data

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

Display Xero Data

Check the loaded Xero data by calling the display function.

Step 3: Checking the result

display (remote_table.select ("Name"))

Analyze Xero Data in Databricks

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

Step 4: Create a view or table

remote_table.createOrReplaceTempView ( "SAMPLE_VIEW" )

With the Temp View created, you can use SparkSQL to retrieve the Xero data for reporting, visualization, and analysis.

% sql

SELECT Name, QuantityOnHand FROM SAMPLE_VIEW ORDER BY QuantityOnHand DESC LIMIT 5

The data from Xero 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 Xero and start working with your live Xero data in Databricks. Reach out to our Support Team if you have any questions.