Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →How to Query HubDB Data in MySQL Workbench
Execute MySQL queries against live HubDB data from MySQL Workbench.
You can use the SQL Gateway from the ODBC Driver for HubDB to query HubDB data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live HubDB data in MySQL Workbench.
Connect to HubDB Data
If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.
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.
Configure the SQL Gateway
See the SQL Gateway Overview to set up connectivity to HubDB data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.
Query HubDB from MySQL Workbench
The steps below outline connecting to the virtual HubDB database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live HubDB data.
Connect to HubDB through the SQL Gateway
- In MySQL Workbench, click to add a new MySQL connection.
- Name the connection (CData SQL Gateway for HubDB).
- Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
- Click Store in Vault to set and store the password.
- Click Test Connection to ensure the connection is configured properly and click OK.
NOTE: When we refer to Username and Password, we mean the credentials for the user(s) created for the SQL Gateway.
![](../articles/odbc-mysql-workbench-1.png)
Query HubDB Data
- Open the connection you just created (CData SQL Gateway for HubDB).
- Click File -> New Query Tab.
- Write a SQL query to retrieve HubDB data, like SELECT * FROM `CData HubDB Sys`.NorthwindProducts;
![](../articles/odbc-mysql-workbench-2.png)
With access to live HubDB data from MySQL Workbench, you can easily query and update HubDB, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData ODBC Driver for HubDB and the CData SQL Gateway.