Process & Analyze Paddle Data in Databricks (AWS)

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use CData, AWS, and Databricks to perform data engineering and data science on live Paddle 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 Paddle data. This article explains how to host the CData JDBC Driver in AWS, as well as connect to and process live Paddle data in Databricks.

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

Install the CData JDBC Driver in Databricks

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

Access Paddle Data in your Notebook: Python

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

Configure the Connection to Paddle

Connect to Paddle by referencing the JDBC Driver class 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.

Step 1: Connection Information

driver = "cdata.jdbc.api.APIDriver"
url = "jdbc:api:RTK=5246...;Profile=C:\profiles\Paddle.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";"

Built-in Connection String Designer

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

Using API Key Authentication

Paddle uses API key authentication. To obtain an API key:

  1. Sign in to your Paddle account at https://vendors.paddle.com
  2. Navigate to Developer Tools > Authentication
  3. Click "Generate API Key"
  4. Assign the appropriate permissions for the data you wish to access
  5. Copy the generated key (sandbox keys begin with pdl_sdbx_apikey_; production keys begin with pdl_live_apikey_)

After obtaining your API key, set the following connection properties:

  • AuthScheme: Set this to APIKey.
Set the following in the ProfileSettings connection property:
  • APIKey: Set this to your Paddle API key.

Example Connection String

Profile=C:\profiles\Paddle.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";

Connecting to Paddle

Once the authentication is configured, you can connect to Paddle and query data from any of the available tables such as Products, Customers, Subscriptions, and Transactions.

Load Paddle Data

Once you configure the connection, you can load Paddle 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" , "Products") \
	.load ()

Display Paddle Data

Check the loaded Paddle data by calling the display function.

Step 3: Checking the result

display (remote_table.select (""))

Analyze Paddle 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 Paddle data for reporting, visualization, and analysis.

% sql

SELECT ,  FROM SAMPLE_VIEW ORDER BY  DESC LIMIT 5

The data from Paddle 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 Paddle data in Databricks. Reach out to our Support Team if you have any questions.

Ready to get started?

Connect to live data from Paddle with the API Driver

Connect to Paddle