Access Live HubDB Data in AWS Lambda

AWS Lambda is a compute service that lets you build applications that respond quickly to new information and events. AWS Lambda functions can work with live HubDB data when paired with the CData JDBC Driver for HubDB. This article describes how to connect to and query HubDB data from an AWS Lambda function built in Eclipse.

At the time this article was written (June 2022), Eclipse version 2019-12 and Java 8 were the highest versions supported by the AWS Toolkit for Eclipse.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live HubDB data. When you issue complex SQL queries to HubDB, the driver pushes supported SQL operations, like filters and aggregations, directly to HubDB and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). In addition, its built-in dynamic metadata querying allows you to work with and analyze HubDB data using native data types.

Gather Connection Properties and Build a Connection String

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.

NOTE: To use the JDBC driver in an AWS Lambda function, you will need a license (full or trial) and a Runtime Key (RTK). For more information on obtaining this license (or a trial), contact our sales team.

Built-in Connection String Designer

For assistance constructing the JDBC URL, use the connection string designer built into the HubDB JDBC Driver. 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 (including the RTK) and copy the connection string to the clipboard.

Create an AWS Lambda Function

1. Download the CData JDBC Driver for HubDB installer, unzip the package, and run the JAR file to install the driver.

2. Create a new AWS Lambda Java Project in Eclipse using the AWS Toolkit for Eclipse. You can follow the tutorial from AWS (amazon.com).

   For this article, set the Input Type for the project to "Custom" so we can enter a table name as the input.

   👁 Creating a new AWS Lambda Java project
   
3. Add the CData JDBC Driver for HubDB JAR file (cdata.jdbc.hubdb.jar) to the build path. The file is found in INSTALL_PATH\lib\. 👁 Adding the JDBC Driver JAR file
   
4. Add the following import statements to the Java class:

   import java.sql.Connection;
   import java.sql.DriverManager;
   import java.sql.ResultSet;
   import java.sql.ResultSetMetaData;
   import java.sql.SQLException;
   import java.sql.Statement;
   

5. Replace the body of the handleRequest method with the code below. Be sure to fill in the connection string in the DriverManager.getConnection method call.

   String query = "SELECT * FROM " + input;
   
   try {
   	Class.forName("cdata.jdbc.hubdb.HubDBDriver");
   } catch (ClassNotFoundException ex) {
   	context.getLogger().log("Error: class not found");
   }
   
   Connection connection = null;
    
   try {
   	connection = DriverManager.getConnection("jdbc:cdata:hubdb:RTK=52465...;AuthScheme=OAuth;OAuthClientID=MyOAuthClientID;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH;");
   } catch (SQLException ex) {
   	context.getLogger().log("Error getting connection: " + ex.getMessage());
   } catch (Exception ex) {
   	context.getLogger().log("Error: " + ex.getMessage());
   }
    
   if(connection != null)
   {
   	context.getLogger().log("Connected Successfully!\n");
   }
    
   ResultSet resultSet = null;
   try
   {
   	//executing query
   	Statement stmt = connection.createStatement();
   	resultSet = stmt.executeQuery(query);
   
   	ResultSetMetaData metaData = resultSet.getMetaData();
   	int numCols = metaData.getColumnCount();
   
   	//printing the results
   	while(resultSet.next())
   	{
   		for(int i = 1; i <= numCols; i++)
   		{
   			System.out.printf("%-25s", (resultSet.getObject(i) != null) ? resultSet.getObject(i).toString().replaceAll("\n", "") : null );
   		}
   		System.out.print("\n");
   	}
   }
   catch (SQLException ex)
   {
   	System.out.println("SQL Exception: " + ex.getMessage());
   }
   catch (Exception ex)
   {
   	System.out.println("General exception: " + ex.getMessage());
   }
    
   String output = "query: " + query + " complete";
   return output;
   

Deploy and Run the Lambda Function

Once you build the function in Eclipse, you are ready to upload and run the function. In this article, the output is written to the AWS logs, but you can use this is a template to implement you own custom business logic to work with HubDB data in AWS Lambda functions.

1. Right-click the Package and select Amazon Web Services -> Upload function to AWS Lamba. 👁 Uploading the function to AWS Lambda
   
2. Name the function, select an IAM role, and set the timeout value to a high enough value to ensure the function completes (depending on the result size of your query).
3. Right-click the Package and select Amazon Web Services -> Run function on AWS Lambda and set the input to the name of the HubDB object you wish to query (i.e. "NorthwindProducts"). 👁 Entering the table name as input
   
4. After the job runs, you can view the output in the CloudWatch logs. 👁 The data in AWS CloudWatch (Salesforce is shown).
   

Free Trial & More Information

Download a free, 30-day trial of the CData JDBC Driver for HubDB and start working with your live HubDB data in AWS Lambda. Reach out to our Support Team if you have any questions.