Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Process & Analyze HubDB Data in Databricks (AWS)
Use CData, AWS, and Databricks to perform data engineering and data science on live HubDB 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 HubDB data. This article walks through hosting the CData JDBC Driver in AWS, as well as connecting to and processing live HubDB data in Databricks.
With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live HubDB data. When you issue complex SQL queries to HubDB, the driver pushes supported SQL operations, like filters and aggregations, directly to HubDB 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 HubDB data using native data types.
Install the CData JDBC Driver in Databricks
To work with live HubDB data in Databricks, install the driver on your Databricks cluster.
- Navigate to your Databricks administration screen and select the target cluster.
- On the Libraries tab, click "Install New."
- Select "Upload" as the Library Source and "Jar" as the Library Type.
- Upload the JDBC JAR file (cdata.jdbc.hubdb.jar) from the installation location (typically C:\Program Files\CData[product_name]\lib).
![Loading the JDBC JAR File into AWS](../articles/jdbc-aws-databricks-1.png)
Access HubDB Data in your Notebook: Python
With the JAR file installed, we are ready to work with live HubDB 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 HubDB, and create a basic report.
Configure the Connection to HubDB
Connect to HubDB 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.hubdb.HubDBDriver" url = "jdbc:hubdb:RTK=5246...;AuthScheme=OAuth;OAuthClientID=MyOAuthClientID;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH"
Built-in Connection String Designer
For assistance in constructing the JDBC URL, use the connection string designer built into the HubDB JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.
java -jar cdata.jdbc.hubdb.jar
Fill in the connection properties and copy the connection string to the clipboard.
There are two authentication methods available for connecting to HubDB data source: OAuth Authentication with a public HubSpot application and authentication with a Private application token.
Using a Custom OAuth App
AuthScheme must be set to "OAuth" in all OAuth flows. Be sure to review the Help documentation for the required connection properties for you specific authentication needs (desktop applications, web applications, and headless machines).
Follow the steps below to register an application and obtain the OAuth client credentials:
- Log into your HubSpot app developer account.
- Note that it must be an app developer account. Standard HubSpot accounts cannot create public apps.
- On the developer account home page, click the Apps tab.
- Click Create app.
- On the App info tab, enter and optionally modify values that are displayed to users when they connect. These values include the public application name, application logo, and a description of the application.
- On the Auth tab, supply a callback URL in the "Redirect URLs" box.
- If you're creating a desktop application, set this to a locally accessible URL like http://localhost:33333.
- If you are creating a Web application, set this to a trusted URL where you want users to be redirected to when they authorize your application.
- Click Create App. HubSpot then generates the application, along with its associated credentials.
- On the Auth tab, note the Client ID and Client secret. You will use these later to configure the driver.
Under Scopes, select any scopes you need for your application's intended functionality.
A minimum of the following scopes is required to access tables:
- hubdb
- oauth
- crm.objects.owners.read
- Click Save changes.
- Install the application into a production portal with access to the features that are required by the integration.
- Under "Install URL (OAuth)", click Copy full URL to copy the installation URL for your application.
- Navigate to the copied link in your browser. Select a standard account in which to install the application.
- Click Connect app. You can close the resulting tab.
Using a Private App
To connect using a HubSpot private application token, set the AuthScheme property to "PrivateApp."
You can generate a private application token by following the steps below:
- In your HubDB account, click the settings icon (the gear) in the main navigation bar.
- In the left sidebar menu, navigate to Integrations > Private Apps.
- Click Create private app.
- On the Basic Info tab, configure the details of your application (name, logo, and description).
- On the Scopes tab, select Read or Write for each scope you want your private application to be able to access.
- A minimum of hubdb and crm.objects.owners.read is required to access tables.
- After you are done configuring your application, click Create app in the top right.
- Review the info about your application's access token, click Continue creating, and then Show token.
- Click Copy to copy the private application token.
To connect, set PrivateAppToken to the private application token you retrieved.
![Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)](../articles/jdbc-url-builder-0.png)
Load HubDB Data
Once you configure the connection, you can load HubDB 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" , "NorthwindProducts") \ .load ()
Display HubDB Data
Check the loaded HubDB data by calling the display function.
Step 3: Checking the result
display (remote_table.select ("PartitionKey"))
![Displaying HubDB Data](../articles/jdbc-aws-databricks-2.png)
Analyze HubDB 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 HubDB data for reporting, visualization, and analysis.
% sql SELECT PartitionKey, Name FROM SAMPLE_VIEW ORDER BY Name DESC LIMIT 5
![Displaying HubDB Data](../articles/jdbc-aws-databricks-3.png)
The data from HubDB 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 HubDB and start working with your live HubDB data in Databricks. Reach out to our Support Team if you have any questions.