Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →How to Connect DBeaver to HubDB via a JDBC Driver
Manage HubDB data with visual tools in DBeaver like the query browser.
The CData JDBC Driver for HubDB implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to HubDB data with wizards in DBeaver and browse data in the DBeaver GUI.
Create a JDBC Data Source for HubDB Data
Follow the steps below to load the driver JAR in DBeaver.
- Open the DBeaver application and, in the "Database" menu, select the "Driver Manager" option. Click "New" to open the "Create new driver" form.
- In the Settings tab:
- Set Driver Name to a user-friendly name for the driver (e.g. CData JDBC Driver for HubDB).
- Set Class Name to the class name for the JDBC driver: cdata.jdbc.hubdb.HubDBDriver.
- Set URL Template to jdbc:hubdb:.
- In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\) and select the JAR file (cdata.jdbc.HubDB.jar).
Create a Connection to HubDB Data
Follow the steps below to add credentials and other required connection properties.
- In the "Database" menu, click "New Database Connection."
- In the "Connect to a database" wizard that results, select the driver you just created (e.g. CData JDBC Driver for HubDB) and click "Next >."
- On the Main tab of the configuration wizard, set the JDBC URL, using the required connection 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:
- Log into your HubSpot app developer account.
- Note that it must be an app developer account. Standard HubSpot accounts cannot create public apps.
- On the developer account home page, click the Apps tab.
- Click Create app.
- 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.
- 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.
- Click Create App. HubSpot then generates the application, along with its associated credentials.
- On the Auth tab, note the Client ID and Client secret. You will use these later to configure the driver.
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
- Click Save changes.
- 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:
- In your HubDB account, click the settings icon (the gear) in the main navigation bar.
- In the left sidebar menu, navigate to Integrations > Private Apps.
- Click Create private app.
- On the Basic Info tab, configure the details of your application (name, logo, and description).
- On the Scopes tab, select Read or Write for each scope you want your private application to be able to access.
- A minimum of hubdb and crm.objects.owners.read is required to access tables.
- After you are done configuring your application, click Create app in the top right.
- Review the info about your application's access token, click Continue creating, and then Show token.
- 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.
Below is a typical connection string:
jdbc:hubdb:AuthScheme=OAuth;OAuthClientID=MyOAuthClientID;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH
- Log into your HubSpot app developer account.
- Click "Test Connection ..." to ensure you have configured the connection properly.
- Click "Finish."
Query HubDB Data
You can now query information from the tables exposed by the connection: Right-click a Table and then click View Table. The data is available on the Data tab.
![The results of a query in DBeaver. (Salesforce is shown.)](../articles/jdbc-dbvr-6.png)