How to connect to HubDB Data in DBVisualizer

The CData JDBC Driver for HubDB implements JDBC standards to provide connectivity to HubDB data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to HubDB data in DBVisualizer and use the table editor to edit and save HubDB data.

Create a New Driver Definition for HubDB Data

Follow the steps below to use the Driver Manager to provide connectivity to HubDB data from DBVisualizer tools.

1. In DBVisualizer, click Tools -> Driver Manager.
2. Click the plus sign "" to create a new driver.
3. Select "Custom" as the template.
4. On the Driver Settings tab:
   • Set Name to a user-friendly name (e.g. "CData HubDB Driver")
   • Set URL Format to jdbc:hubdb:
   • In Driver artifacts and jar files (jars are loaded in order from top):
     1. Click the plus sign "" -> "Add Files"
     2. Navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\)
     3. Select the JAR file (cdata.jdbc.HubDB.jar) and click "Open"
5. The Driver Class should populate automatically. If not, select class (cdata.jdbc.hubdb.HubDBDriver).

Define the Connection to the JDBC Data Source

Close the "Driver Manager" and follow the steps below to save connection properties in the JDBC URL.

1. In the "Databases" tab, click the plus sign "" and select the driver you just created.

2. In the "Connection" section, set the following options:

   • Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
   • Driver Type: Select the driver you just created.

   • Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:hubdb: followed by the connection properties in a semicolon-separated list of name-value pairs.

     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.

     When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

     A typical connection string is below:

     jdbc:hubdb:AuthScheme=OAuth;OAuthClientID=MyOAuthClientID;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH
   • NOTE: Since HubDB does not require a User or Password to authenticate, you may use whatever values you wish for Database Userid and Database Password.
3. On the Connection tab, click Connect.

To browse through tables exposed by the HubDB JDBC Driver, right-click a table and click "Open in New Tab."

To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.

More Information & Free Trial