How to work with HubDB Data in Apache Spark using SQL

Apache Spark is a fast and general engine for large-scale data processing. When paired with the CData JDBC Driver for HubDB, Spark can work with live HubDB data. This article describes how to connect to and query HubDB data from a Spark shell.

The CData JDBC Driver offers unmatched performance for interacting with live HubDB data due to optimized data processing built into the driver. 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 (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can work with and analyze HubDB data using native data types.

Install the CData JDBC Driver for HubDB

Download the CData JDBC Driver for HubDB installer, unzip the package, and run the JAR file to install the driver.

Start a Spark Shell and Connect to HubDB Data

1. Open a terminal and start the Spark shell with the CData JDBC Driver for HubDB JAR file as the jars parameter: $ spark-shell --jars /CData/CData JDBC Driver for HubDB/lib/cdata.jdbc.hubdb.jar
2. With the shell running, you can connect to HubDB with a JDBC URL and use the SQL Context load() function to read a table.

   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:

   1. Log into your HubSpot app developer account.
      • Note that it must be an app developer account. Standard HubSpot accounts cannot create public apps.
   2. On the developer account home page, click the Apps tab.
   3. Click Create app.
   4. 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.
   5. 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.
   6. Click Create App. HubSpot then generates the application, along with its associated credentials.
   7. On the Auth tab, note the Client ID and Client secret. You will use these later to configure the driver.

   8. 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
   9. Click Save changes.
   10. 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:

   1. In your HubDB account, click the settings icon (the gear) in the main navigation bar.
   2. In the left sidebar menu, navigate to Integrations > Private Apps.
   3. Click Create private app.
   4. On the Basic Info tab, configure the details of your application (name, logo, and description).
   5. On the Scopes tab, select Read or Write for each scope you want your private application to be able to access.
   6. A minimum of hubdb and crm.objects.owners.read is required to access tables.
   7. After you are done configuring your application, click Create app in the top right.
   8. Review the info about your application's access token, click Continue creating, and then Show token.
   9. Click Copy to copy the private application token.

   To connect, set PrivateAppToken to the private application token you retrieved.

   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.

   Configure the connection to HubDB, using the connection string generated above.

   scala> val hubdb_df = spark.sqlContext.read.format("jdbc").option("url", "jdbc:hubdb:AuthScheme=OAuth;OAuthClientID=MyOAuthClientID;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;").option("dbtable","NorthwindProducts").option("driver","cdata.jdbc.hubdb.HubDBDriver").load()
3. Once you connect and the data is loaded you will see the table schema displayed.

4. Register the HubDB data as a temporary table:

   scala> hubdb_df.registerTable("northwindproducts")

5. Perform custom SQL queries against the Data using commands like the one below:

   scala> hubdb_df.sqlContext.sql("SELECT PartitionKey, Name FROM NorthwindProducts WHERE Id = 1").collect.foreach(println)

   You will see the results displayed in the console, similar to the following:

Using the CData JDBC Driver for HubDB in Apache Spark, you are able to perform fast and complex analytics on HubDB data, combining the power and utility of Spark with your data. Download a free, 30 day trial of any of the 200+ CData JDBC Drivers and get started today.