Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Access Live IBM Cloud Object Storage Data in AWS Lambda (with IntelliJ IDEA)
Connect to live IBM Cloud Object Storage data in AWS Lambda using IntelliJ IDEA and the CData JDBC Driver to build the function.
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 IBM Cloud Object Storage data when paired with the CData JDBC Driver for IBM Cloud Object Storage. This article describes how to connect to and query IBM Cloud Object Storage data from an AWS Lambda function built with Maven in IntelliJ.
With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live IBM Cloud Object Storage data. When you issue complex SQL queries to IBM Cloud Object Storage, the driver pushes supported SQL operations, like filters and aggregations, directly to IBM Cloud Object Storage 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 IBM Cloud Object Storage data using native data types.
Gather Connection Properties and Build a Connection String
Download the CData JDBC Driver for IBM Cloud Object Storage installer, unzip the package, and run the JAR file to install the driver. Then gather the required connection properties.
Register a New Instance of Cloud Object Storage
If you do not already have Cloud Object Storage in your IBM Cloud account, follow the procedure below to install an instance of SQL Query in your account:
- Log in to your IBM Cloud account.
- Navigate to the page, choose a name for your instance and click Create. You will be redirected to the instance of Cloud Object Storage you just created.
Connecting using OAuth Authentication
There are certain connection properties you need to set before you can connect. You can obtain these as follows:
API Key
To connect with IBM Cloud Object Storage, you need an API Key. You can obtain this as follows:
- Log in to your IBM Cloud account.
- Navigate to the Platform API Keys page.
- On the middle-right corner click "Create an IBM Cloud API Key" to create a new API Key.
- In the pop-up window, specify the API Key name and click "Create". Note the API Key as you can never access it again from the dashboard.
Cloud Object Storage CRN
If you have multiple accounts, you will need to specify the CloudObjectStorageCRN explicitly. To find the appropriate value, you can:
- Query the Services view. This will list your IBM Cloud Object Storage instances along with the CRN for each.
- Locate the CRN directly in IBM Cloud. To do so, navigate to your IBM Cloud Dashboard. In the Resource List, Under Storage, select your Cloud Object Storage resource to get its CRN.
Connecting to Data
You can now set the following to connect to data:
- InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
- ApiKey: Set this to your API key which was noted during setup.
- CloudObjectStorageCRN (Optional): Set this to the cloud object storage CRN you want to work with. While the connector attempts to retrieve this automatically, specifying this explicitly is recommended if you have more than Cloud Object Storage account.
When you connect, the connector completes the OAuth process.
- Extracts the access token and authenticates requests.
- Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
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 IBM Cloud Object Storage JDBC Driver. Double-click the JAR file or execute the jar file from the command line.
java -jar cdata.jdbc.ibmcloudobjectstorage.jar
Fill in the connection properties (including the RTK) and copy the connection string to the clipboard.
Create a Project in IntelliJ
- In IntelliJ IDEA, click New Project.
- Select "Maven Archetype" from the Generators
- Name the project and select "maven.archetypes:maven-archetype-quickstart" Archetype.
- Click "Create"
Install the CData JDBC Driver for IBM Cloud Object Storage JAR File
Use the following Maven command from the project's root folder to install JAR file in the project.
mvn install:install-file -Dfile="PATH/TO/CData JDBC Driver for IBM Cloud Object Storage 20XX/lib/cdata.jdbc.ibmcloudobjectstorage.jar" -DgroupId="org.cdata.connectors" -DartifactId="cdata-ibmcloudobjectstorage-connector" -Dversion="23" -Dpackaging=jar
Add Dependencies
Within the Maven project's pom.xml file, add AWS and the CData JDBC Driver for IBM Cloud Object Storage as dependencies (within the <dependencies> element) using the following XML.
- AWS
<dependency> <groupId>com.amazonaws</groupId> <artifactId>aws-lambda-java-core</artifaceId> <version>1.2.2</version> <!--Replace with the actual version--> </dependency>
- CData JDBC Driver for IBM Cloud Object Storage
<dependency> <groupId>org.cdata.connectors</groupId> <artifactId>cdata-ibmcloudobjectstorage-connector</artifaceId> <version>23</version> <!--Replace with the actual version--> </dependency>
Create an AWS Lambda Function
For this sample project, we create two source files: CDataLambda.java and CDataLambdaTest.java.
Lambda Function Definition
- Update CDataLambda to implement the RequestHandler interface from the AWS Lambda SDK. You will need to add the handleRequest method, which performs the following tasks when the Lambda function is triggered:
- Constructs a SQL query using the input.
- Registers the CData JDBC driver for IBM Cloud Object Storage.
- Establishes a connection to IBM Cloud Object Storage using JDBC.
- Executes the SQL query on IBM Cloud Object Storage.
- Prints the results to the console.
- Returns an output message.
- 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;
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.ibmcloudobjectstorage.IBMCloudObjectStorageDriver"); cdata.jdbc.ibmcloudobjectstorage.IBMCloudObjectStorageDriver driver = new cdata.jdbc.ibmcloudobjectstorage.IBMCloudObjectStorageDriver(); DriverManager.registerDriver(driver); } catch (SQLException ex) { } catch (ClassNotFoundException e) { throw new RuntimeException(e); } Connection connection = null; try { connection = DriverManager.getConnection("jdbc:cdata:ibmcloudobjectstorage:RTK=52465...;ApiKey=myApiKey;CloudObjectStorageCRN=MyInstanceCRN;Region=myRegion;OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;"); } 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()); } return "query: " + query + " complete";
Deploy and Run the Lambda Function
Once you build the function in Intellij, you are ready to deploy the entire Maven project as a single JAR file.
- In IntelliJ, use the mvn install command to build the SNAPSHOT JAR file.
- Create a new function in AWS Lambda (or open an existing one).
- 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).
- Click "Upload from" -> ".zip file" and select your SNAPSHOT JAR file.
- In the "Runtime settings" section, click "Edit" and set Handler to your "handleRequest" method (e.g. package.class::handleRequest)
- You can now test the function. Set the "Event JSON" field to a table name and click, click "Test"
Free Trial & More Information
Download a free, 30-day trial of the CData JDBC Driver for IBM Cloud Object Storage and start working with your live IBM Cloud Object Storage data in AWS Lambda. Reach out to our Support Team if you have any questions.