How to connect and process Shippo Data from Azure Databricks



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

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

Install the CData JDBC Driver in Azure

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

Connect to Shippo from Databricks

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

Configure the Connection to Shippo

Connect to Shippo 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.api.APIDriver"
url = "jdbc:api:RTK=5246...;Profile=C:\profiles\Shippo.apip;ProfileSettings='APIKey=my_api_key';"

Built-in Connection String Designer

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

Start by setting the Profile connection property to the location of the Shippo Profile on disk (e.g. C:\profiles\Shippo.apip). Next, set the ProfileSettings connection property to the connection string for Shippo (see below).

Shippo API Profile Settings

In order to authenticate to Shippo, you will need an API Key. You can find this API key under 'Settings' > 'API' > 'Generate Token'. After generating your key, set it to the APIKey in ProfileSettings connection property.

Load Shippo Data

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

Display Shippo Data

Check the loaded Shippo data by calling the display function.

display (remote_table.select ("ObjectId "))

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

% sql

SELECT ObjectId , OrderStatus FROM Orders WHERE ShopApp = 'Shippo'

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

Ready to get started?

Connect to live data from Shippo with the API Driver

Connect to Shippo