Build AI/ML Models with Live HubDB Data using Dataiku

Dataiku is a data science and machine learning platform used for data preparation, analysis, visualization, and AI/ML model deployment, enabling collaborative and efficient data-driven decision-making. When paired with the CData JDBC Driver for HubDB, Dataiku enhances data integration, preparation, real-time analysis, and reliable model deployment for HubDB data.

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.

This article shows how you can easily integrate to HubDB using CData JDBC Driver for HubDB in Dataiku DSS (Data Science Studio) platform, allowing you to prepare the data and build custom AI/ML models.

Preparing the Dataiku DSS environment

In this section, we will explore how to set up Dataiku, as previously introduced, with HubDB data. Be sure to install Dataiku DSS (On-Prem version) for your preferred operating system, beforehand.

Install the CData JDBC Driver for HubDB

First, install the CData JDBC Driver for HubDB on the same machine as Dataiku. The JDBC Driver will be installed in the following path:

Connecting the JDBC Driver in Dataiku DSS

To use the CData JDBC driver in Dataiku, you must create a new SQL database connection and add the JDBC Driver JAR file in the DSS connection settings.

1. Log into Dataiku DSS platform. It should open locally in your browser (e.g. localhost:11200)
2. Click on Navigate to other sections of Dataiku menu on the top right section of the platform and select Administration.
3. Select the Connections tab.
4. In Connections, click on New Connections button.
5. Now, scroll down and select Other SQL databases.

6. Generate a JDBC URL for connecting to HubDB, beginning with jdbc:hubdb: followed by a series of semicolon-separated connection string properties.

   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.

   A typical JDBC URL is given below:

   jdbc:hubdb:AuthScheme=OAuth;OAuthClientID=MyOAuthClientID;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH
7. On the New SQL database (JDBC) connection screen, enter a name in the New connection name field and specify the basic parameters:
   • JDBC Driver Class: cdata.jdbc.hubdb.HubDBDriver
   • JDBC URL: JDBC connection URL obtained in the previous step
   • Driver jars directory: the folder path where the JAR file is installed on your system

   Next, select the SQL dialect of your choice. Here, we have selected 'SQL Server' as the preferred dialect. Click on Create. If the connection is successful, a prompt will display, saying 'Connection OK'.

8. The Data Catalog window will appear. Select the desired connection, catalog, and schema from the Connection to browse, Restrict to catalog, and Restrict to schema dropdowns, then click on List Tables. The Dataiku platform will list all the required tables.
9. Select any table from the list and click Preview to view the table data. Click Close to exit the window.

Creating a new project

To prepare data flows, create dashboards, analyze the HubDB data, and build AI and ML models in the Dataiku DSS platform, you need to first create a new project.

1. Select Projects from the Navigate to other sections of Dataiku menu.
2. In the Projects screen, click New Project and select + Blank Project.
3. In the New Project window, assign a Name and Project Key. Click Create. The new project dashboard opens up.
4. Select Notebooks from the menu at the top of the project screen.
5. Click on + Create Your First Notebook dropdown menu and select Write your own option.
6. In the New Notebook window, select SQL.
7. Now, select the required connection from the Connection dropdown and enter a name in the Notebook Name field.

Testing the connection

To test the HubDB connection and analyze the HubDB data, write a query in the query compiler and click Run. The queried/filtered HubDB data results will then appear on the screen.

Get Started Today

Download a free, 30-day trial of the CData JDBC Driver for HubDB to integrate with Dataiku, and effortlessly build custom AI/ML models from HubDB data.

Reach out to our Support Team if you have any questions.