VOOZH about

URL: https://www.cdata.com/kb/tech/xml-jdbc-aws-lambda-intellij.rst

โ‡ฑ Access Live XML Data in AWS Lambda (with IntelliJ IDEA)


Access Live XML Data in AWS Lambda (with IntelliJ IDEA)

๐Ÿ‘ Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
Connect to live XML 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 XML data when paired with the CData JDBC Driver for XML. This article describes how to connect to and query XML 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 XML data. When you issue complex SQL queries to XML, the driver pushes supported SQL operations, like filters and aggregations, directly to XML 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 XML data using native data types.

Step 1: Gather connection properties and build a connection string

Download the CData JDBC Driver for XML installer, unzip the package, and run the JAR file to install the driver. Then gather the required connection properties.

Connecting to Local or Cloud-Stored (Box, Google Drive, Amazon S3, SharePoint) XML Files

CData Drivers let you work with XML files stored locally and stored in cloud storage services like Box, Amazon S3, Google Drive, or SharePoint, right where they are.

Setting connection properties for local files

Set the URI property to local folder path.

Setting connection properties for files stored in Amazon S3

To connect to XML file(s) within Amazon S3, set the URI property to the URI of the Bucket and Folder where the intended XML files exist. In addition, at least set these properties:

  • AWSAccessKey: AWS Access Key (username)
  • AWSSecretKey: AWS Secret Key

Setting connection properties for files stored in Box

To connect to XML file(s) within Box, set the URI property to the URI of the folder that includes the intended XML file(s). Use the OAuth authentication method to connect to Box.

Dropbox

To connect to XML file(s) within Dropbox, set the URI proprerty to the URI of the folder that includes the intended XML file(s). Use the OAuth authentication method to connect to Dropbox. Either User Account or Service Account can be used to authenticate.

SharePoint Online (SOAP)

To connect to XML file(s) within SharePoint with SOAP Schema, set the URI proprerty to the URI of the document library that includes the intended XML file. Set User, Password, and StorageBaseURL.

SharePoint Online REST

To connect to XML file(s) within SharePoint with REST Schema, set the URI proprerty to the URI of the document library that includes the intended XML file. StorageBaseURL is optional. If not set, the driver will use the root drive. OAuth is used to authenticate.

Google Drive

To connect to XML file(s) within Google Drive, set the URI property to the URI of the folder that includes the intended XML file(s). Use the OAuth authentication method to connect and set InitiateOAuth to GETANDREFRESH.

The property is the controlling property over how your data is represented into tables and toggles the following basic configurations.

  • Document (default): Model a top-level, document view of your XML data. The data provider returns nested elements as aggregates of data.
  • FlattenedDocuments: Implicitly join nested documents and their parents into a single table.
  • Relational: Return individual, related tables from hierarchical data. The tables contain a primary key and a foreign key that links to the parent document.

See the Modeling XML Data chapter for more information on configuring the relational representation. You will also find the sample data used in the following examples. The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

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 XML JDBC Driver. Double-click the JAR file or execute the jar file from the command line.

java -jar cdata.jdbc.xml.jar
๐Ÿ‘ Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

Fill in the connection properties (including the RTK) and copy the connection string to the clipboard.

Step 2: Create a project in IntelliJ

  1. In IntelliJ IDEA, click New Project.
  2. Select "Maven Archetype" from the Generators
  3. Name the project and select "maven.archetypes:maven-archetype-quickstart" Archetype.
  4. Click "Create" ๐Ÿ‘ Image

Install the CData JDBC Driver for XML 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 XML 20XX/lib/cdata.jdbc.xml.jar" -DgroupId="org.cdata.connectors" -DartifactId="cdata-xml-connector" -Dversion="23" -Dpackaging=jar

Add Dependencies

Within the Maven project's pom.xml file, add AWS and the CData JDBC Driver for XML] as dependencies (within the <dependencies> element) using the following XML.

  • AWS
    <dependency>
     <groupId>com.amazonaws</groupId>
     <artifactId>aws-lambda-java-core</artifactId>
     <version>1.2.2</version> <!--Replace with the actual version-->
    </dependency>
  • CData JDBC Driver for XML
    <dependency>
     <groupId>org.cdata.connectors</groupId>
     <artifactId>cdata-xml-connector</artifactId>
     <version>25</version> <!--Replace with the actual version-->
    </dependency>
  • Maven Shade Plugin to create a fat JAR
    <build>
     <plugins>
     <plugin>
     <groupId>org.apache.maven.plugins</groupId>
     <artifactId>maven-shade-plugin</artifactId>
     <version>3.4.1</version>
     <executions>
     <execution>
     <phase>package</phase>
     <goals>
     <goal>shade</goal>
     </goals>
     <configuration>
     <createDependencyReducedPom>false</createDependencyReducedPom>
     <transformers>
     <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
     <mainClass>com.example.CDataLambda</mainClass>
     <!-- Change to your actual Lambda handler class -->
     </transformer>
     </transformers>
     </configuration>
     </execution>
     </executions>
     </plugin>
     </plugins>
    </build>

Create an AWS Lambda Function

For this sample project, we create two source files: CDataLambda.java and CDataLambdaTest.java.

Lambda Function Definition

  1. 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:
    1. Constructs a SQL query using the input
    2. Registers the CData JDBC Driver for XML
    3. Establishes a connection to XML using JDBC
    4. Executes the SQL query on XML
    5. Prints the results to the console
    6. Returns an output message
  2. Use the complete Lambda class below, which includes the imports, class definition, and handleRequest method. Be sure to fill in your connection string values in the DriverManager.getConnection call.

    package com.example;
    
    import com.amazonaws.services.lambda.runtime.Context;
    import com.amazonaws.services.lambda.runtime.RequestHandler;
    
    import java.sql.Connection;
    import java.sql.DriverManager;
    import java.sql.ResultSet;
    import java.sql.ResultSetMetaData;
    import java.sql.SQLException;
    import java.sql.Statement;
    public class CDataLambda implements RequestHandler < Object, String > {
    
     @Override
     public String handleRequest(Object input, Context context) {
     String query = "SELECT * FROM " + input;
    
     String bucketName = "MY_AWS_BUCKET";
     try {
     Class.forName("cdata.jdbc.xml.XMLDriver");
     cdata.jdbc.xml.XMLDriver driver = new cdata.jdbc.xml.XMLDriver();
     DriverManager.registerDriver(driver);
     } catch (SQLException ex) {
     // Registering the driver failed
     throw new RuntimeException("Failed to register JDBC driver", ex);
     } catch (ClassNotFoundException e) {
     // The driver class was not found in the classpath
     throw new RuntimeException("JDBC Driver class not found", e);
    
     }
     Connection connection = null;
     try {
     connection = DriverManager.getConnection("jdbc:cdata:xml:RTK=52465...;URI=C:/people.xml;DataModel=Relational;");
     } 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!
    ");
     }
    
     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("
    ", "") : null);
     }
     System.out.print("
    ");
     }
     } catch (SQLException ex) {
     System.out.println("SQL Exception: " + ex.getMessage());
     } catch (Exception ex) {
     System.out.println("General exception: " + ex.getMessage());
     }
     return "v24 query: " + query + " complete";
     }
    }
    
    

Step 3: 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.

  1. In IntelliJ, use the mvn install command to build the SNAPSHOT JAR file.

    Note: The Maven Shade Plugin generates two JARs in the target folder. Always upload the larger -shaded.jar file to AWS Lambda, as it contains all required dependencies.

  2. Create a new function in AWS Lambda (or open an existing one).
  3. 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).
  4. Click "Upload from" -> ".zip file" and select your SNAPSHOT JAR file. ๐Ÿ‘ Uploading the SNAPSHOT JAR file.
  5. In the "Runtime settings" section, click "Edit" and set Handler to your "handleRequest" method (e.g. package.class::handleRequest) ๐Ÿ‘ Configuring the runtime handler.
  6. You can now test the function. Set the "Event JSON" field to a table name and click, click "Test" ๐Ÿ‘ Viewing the results.

Free Trial & More Information

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