Query HubDB Data in ColdFusion



Write standard ColdFusion data access code to connect to HubDB data.

The CData JDBC Driver for HubDB seamlessly integrates connectivity to HubDB data with the rapid development tools in ColdFusion. This article shows how to connect to HubDB data in ColdFusion and query HubDB tables.

Create a JDBC Data Source for HubDB in ColdFusion

The JDBC data source enables you to execute SQL from standard ColdFusion tags like cfquery and CFScript like executeQuery.

  1. Copy the driver JAR and .lic file from the installation directory onto the ColdFusion classpath. For example, copy the files into C:\MyColdFusionDirectory\cfusion\wwwroot\WEB-INF\lib. Or, open the Java and JVM page in the ColdFusion Administrator and enter the path to the files in the ColdFusion Class Path box.

    The JAR and license for the driver are located in the lib subfolder of the installation directory.

    Restart the server after this step.

  2. Add the driver as a data source:

    From the ColdFusion administrator interface, expand the Data & Services node and click Data Sources. In the Add New Data Source section, enter a name for the data source and select Other in the Driver menu.

  3. Populate the driver properties:

    • JDBC URL: Enter connection properties in the JDBC URL. The JDBC URL begins with jdbc:hubdb: and is 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.

      A typical JDBC URL is below:

      jdbc:hubdb:AuthScheme=OAuth;OAuthClientID=MyOAuthClientID;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH
    • Driver Class: Enter the driver class. The driver class is cdata.jdbc.hubdb.HubDBDriver.
    • Driver Name: Enter a user-defined name for the driver.
    • Username: Enter the username used to authenticate.
    • Password: Enter the password used to authenticate.

You can now test the connection by enabling the CData HubDB data source in the Actions column. After reporting a status of OK, the HubDB data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to HubDB, including INSERT, UPDATE, and DELETE.. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

Note: To use the cfquery and cfscript, create a .cfm file. Inside the .cfm file, write the code to execute the query (see below). Place the file directly in the root directory of your web server (e.g., wwwroot in Adobe ColdFusion). Restart the service after placing the file for the changes to take effect.

<cfquery name="HubDBQuery" dataSource="CDataHubDB"> SELECT * FROM NorthwindProducts WHERE Id = <cfqueryparam value="#Id#" cfsqltype="cf_sql_varchar"> </cfquery> <cfdump var="#HubDBQuery#">

Below is the equivalent in CFScript:


<cfscript>
result = queryExecute(
  "SELECT * FROM NorthwindProducts WHERE Id = ?", 
  [
    { value="1", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataHubDB" }
);

writeDump( var= result );
</cfscript> 

You can then make requests to your .cfm like the following:

http://MyServer:8500/query.cfm?Id=1

Ready to get started?

Download a free trial of the HubDB Driver to get started:

 Download Now

Learn more:

HubDB Icon HubDB JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with HubDB.