Build a PostgreSQL Interface for HubDB Data using the CData JDBC Driver

There are a vast number of PostgreSQL clients available on the Internet. From standard Drivers to BI and Analytics tools, PostgreSQL is a popular interface for data access. Using our JDBC Drivers, you can now create PostgreSQL entry-points that you can connect to from any standard client.

To access HubDB data as a PostgreSQL database, use the CData JDBC Driver for HubDB and a JDBC foreign data wrapper (FDW). In this article, we compile the FDW, install it, and query HubDB data from PostgreSQL Server.

Connect to HubDB Data as a JDBC Data Source

To connect to HubDB as a JDBC data source, you will need the following:

• Driver JAR path: The JAR is located in the lib subfolder of the installation directory.

• Driver class:

  cdata.jdbc.hubdb.HubDBDriver
  

• JDBC URL: The URL must start with "jdbc:hubdb:" and can include any of the connection properties in name-value pairs separated with semicolons.

  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.

  👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
  

  A typical JDBC URL is below:

  jdbc:hubdb:AuthScheme=OAuth;OAuthClientID=MyOAuthClientID;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH;
  

Build the JDBC Foreign Data Wrapper

The Foreign Data Wrapper can be installed as an extension to PostgreSQL, without recompiling PostgreSQL. The jdbc2_fdw extension is used as an example (downloadable here).

1. Add a symlink from the shared object for your version of the JRE to /usr/lib/libjvm.so. For example:

   ln -s /usr/lib/jvm/java-6-openjdk/jre/lib/amd64/server/libjvm.so /usr/lib/libjvm.so
   

2. Start the build:

   make install USE_PGXS=1
   

Query HubDB Data as a PostgreSQL Database

After you have installed the extension, follow the steps below to start executing queries to HubDB data:

1. Log into your database.
2. Load the extension for the database:

   CREATE EXTENSION jdbc2_fdw;
   

3. Create a server object for HubDB:

   CREATE SERVER HubDB 
   FOREIGN DATA WRAPPER jdbc2_fdw OPTIONS (
   drivername 'cdata.jdbc.hubdb.HubDBDriver',
   url 'jdbc:hubdb:AuthScheme=OAuth;OAuthClientID=MyOAuthClientID;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH;',
   querytimeout '15',
   jarfile '/home/MyUser/CData/CData\ JDBC\ Driver\ for\ Salesforce MyDriverEdition/lib/cdata.jdbc.hubdb.jar'); 
   

4. Create a user mapping for the username and password of a user known to the MySQL daemon.

   CREATE USER MAPPING for postgres SERVER HubDB OPTIONS (
   username 'admin', 
   password 'test');
   

5. Create a foreign table in your local database:

   postgres=# CREATE FOREIGN TABLE northwindproducts (
   northwindproducts_id text,
   northwindproducts_PartitionKey text,
   northwindproducts_Name numeric) 
   SERVER HubDB OPTIONS (
   table_name 'northwindproducts');
   

You can now execute read/write commands to HubDB:

postgres=# SELECT * FROM northwindproducts;