How to integrate Metabase with HubDB Data

Metabase is an open source data visualization tool that allows users to create interactive dashboards. When paired with CData Connect AI, users can easily create visualizations and dashboards linked to live HubDB data. This article describes how to connect to HubDB and build a simple visualization using HubDB data.

CData Connect provides a pure cloud-to-cloud interface for HubDB, allowing you to easily integrate with live HubDB data in Metabase — without replicating the data. Connect looks exactly like a SQL Server database to Metabase and uses optimized data processing out of the box to push all supported SQL operations (filters, JOINs, etc) directly to HubDB, leveraging server-side processing to quickly return HubDB data.

Configure HubDB Connectivity for Metabase

Connectivity to HubDB from Metabase is made possible through CData Connect AI. To work with HubDB data from Metabase, we start by creating and configuring a HubDB connection.

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select "HubDB" from the Add Connection panel

3. Enter the necessary authentication properties to connect to HubDB.

   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.

   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add HubDB Connection page and update the User-based permissions.

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to HubDB data from Metabase.

Connect to CData Connect AI from Metabase

After creating the connection in Connect AI, navigate to your Metabase instance. Use the SQL Server interface to connect to Connect AI.

1. Navigate to the administration screen (Settings -> Admin) and click "Add Database" from the "Databases" tab
2. Configure the connection to Connect AI and click "Save"
   • Database type: Select "SQL Server"
   • Name: Name the connection (e.g. "HubDB (Connect AI)")
   • Host: tds.cdata.com
   • Port: 14333
   • Database name: The name of the connection you just created (e.g. HubDB1)
   • Username: A Connect AI username (e.g. [email protected])
   • Password: The PAT previously created
   • Click to Use a secure connection (SSL)
   

Execute HubDB Data with Metabase

Once you configure the connection to Connect AI, you can query HubDB and build visualizations.

1. Use the "Write SQL" tool to retrieve the HubDB data
2. Write a SQL query based on the HubDB connection in CData Connect AI, e.g.
   
   

   SELECT PartitionKey, Name FROM NorthwindProducts WHERE Id = '1'

   
3. Navigate to the "Visualization" screen, choose a visualization, and configure the visualization

More Information & Free Trial

At this point, you have built a simple visualization from HubDB data in Metabase. You can continue to work with live HubDB data in Metabase just like you would any SQL Server database. For more information on creating a live connection to HubDB (and more than 100 other data sources), visit the Connect AI page. Sign up for a free trial and start working with live HubDB data in Metabase today.