Bridge HubDB Connectivity with Apache NiFi

Apache NiFi supports powerful and scalable directed graphs of data routing, transformation, and system mediation logic. When paired with the CData JDBC Driver for HubDB, NiFi can work with live HubDB data. This article describes how to connect to and query HubDB data from an Apache NiFi Flow.

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.

Connecting to HubDB Data in Apache NiFi

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

2. Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.hubdb.jar (and cdata.jdbc.hubdb.lic), to the Apache NiFi lib subfolder, for example, C:\nifi-1.3.0-bin\nifi-1.3.0\lib.

   On Windows, the default location for the CData JDBC Driver is C:\Program Files\CData\CData JDBC Driver for HubDB.

3. Start Apache NiFi by running the run-nifi.bat file in bin subfolder, for example, C:\nifi-1.3.0-bin\nifi-1.3.0\bin.

   (OR)

   Use the command prompt to navigate to the particular directory and run the run-nifi.bat file for example:

   cd C:\nifi-1.3.0-bin\nifi-1.3.0\bin
   .\run-nifi.bat
   

4. Navigate to the Apache NiFi UI in your web browser: It should be https://localhost:8443/nifi.

   Note: If users are utilizing an older version of Apache NiFi, they should access it via http://localhost:8080/nifi. In earlier versions, HTTP was the protocol employed. However, in the most recent version, HTTPS is the standard. By default, HTTP operates on port 8080, while HTTPS uses port 8443.

5. When accessing Apache NiFi via a URL, it prompts you to enter a username and password for login.

   To retrieve login credentials, users should consult the 'App.log' file located within the log directory of their NiFi installation. This file typically contains the necessary details for accessing the NiFi interface.

6. Click the (Configuration) button from the Operate sidebar under the "NiFi Flow" process group.
7. In the NiFi Flow Configuration page, navigate to the "Controller Services" tab.
8. Click the button to create a new controller service.
9. In the Add Controller Service page, select "DBCPConnectionPool", and then click Add.
10. In the Configure Controller Service page, navigate to the "Properties" tab.
11. Click the gear button to configure the new DBCPConnection Pool.

12. Fill in the properties:

    Property	Value
    Database Connection URL	jdbc:hubdb:AuthScheme=OAuth;OAuthClientID=MyOAuthClientID;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH
    Database Driver Class Name	cdata.jdbc.hubdb.HubDBDriver
    Database Driver Location(s)	Path to your Apache NiFi's lib folder where the JAR files are present.

    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:

    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.

13. To establish a connection and execute a select query, simply drag and drop the processor (indicated by the yellow highlight) into the workspace.
14. Select the 'ExecuteSQL' processor and click the 'Add' button to make it visible in the workspace.
15. Click on the added processor (ExecuteSQL)to open the connection page.
16. Click on the Verify Properties button and verify to test the connection.
17. Ensure that all the verification results are successful, and then click on APPLY.
18. Activate the connection by clicking the small button at the right corner of the screen.

Your HubDB data is now available for use in Apache NiFi. For example, you can use the DBCPConnection Pool as the source for a QueryDatabaseTable processor (shown below).

Download a free, 30-day trial of the CData JDBC Driver for HubDB and start working with your live HubDB data in Apache NiFi. Reach out to our Support Team if you have any questions.