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

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

Install the CData JDBC Driver in Azure

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

Connect to ShipStation from Databricks

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

Configure the Connection to ShipStation

Connect to ShipStation 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.shipstation.ShipStationDriver"
url = "jdbc:shipstation:RTK=5246...;APIKey='YourAPIKey';APISecret='YourAPISecret'"

Built-in Connection String Designer

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

Use the BASIC Authentication standard to connect.

1. Login to your ShipStation account
2. Click on the settings icon in the upper right corner. A column menu will show up on the left
3. Click Account -> API Settings
4. On the API Settings page, note the API Key and API Secret.

Authenticating to ShipStation

• APIKey: Set this to the API key from the API settings page.
• APISecret: Set this to the Secret key from the API settings page.

Load ShipStation Data

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

Display ShipStation Data

Check the loaded ShipStation data by calling the display function.

display (remote_table.select ("Id"))

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

% sql

SELECT Id, Color FROM Tags WHERE CustomerId = '1368175'

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