How to connect and process Quickbase Data from Azure Databricks

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 Quickbase data. This article walks through hosting the CData JDBC Driver in Azure, as well as connecting to and processing live Quickbase data in Databricks.

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

Install the CData JDBC Driver in Azure

To work with live Quickbase 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.quickbase.jar) from the installation location (typically C:\Program Files\CData[product_name]\lib).

Connect to Quickbase from Databricks

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

Configure the Connection to Quickbase

Connect to Quickbase by referencing the class for the JDBC Driver and constructing a connection string to use in the JDBC URL. Additionally, you will need to set the RTK property in the JDBC URL (unless you are using a Beta driver). You can view the licensing file included in the installation for information on how to set this property.

driver = "cdata.jdbc.quickbase.QuickBaseDriver"
url = "jdbc:quickbase:RTK=5246...;User=user@domain.com;Password=password;Domain=myinstance.quickbase.com;ApplicationToken=bwkxrb5da2wn57bzfh9xn24"

Built-in Connection String Designer

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

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

User Authentication Method

To authenticate with user credentials, specify the following connection properties:

1. Set the User and Password.
2. If your application requires an ApplicationToken;, you must provide it otherwise an error will be thrown. You can find the ApplicationToken under SpecificApp > Settings > App management > App properties > Advanced settings > Security options > Manage Application Token.

User Token Authentication

To authenticate with a user token, specify the following connection properties:

1. Set UserToken and you are ready to connect. You can find the UserToken under Quick Base > My Preferences > My User Information > Manage User Tokens.

Load Quickbase Data

Once the connection is configured, you can load Quickbase 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" , "SampleTable_1") \
	.load ()

Display Quickbase Data

Check the loaded Quickbase data by calling the display function.

display (remote_table.select ("Id"))

Analyze Quickbase 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 Quickbase data for analysis.

% sql

SELECT Id, Column1 FROM SampleTable_1 WHERE Column2 = '100'

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