Object-Relational Mapping (ORM) with Amazon Athena Data Entities in Java

You can use Hibernate to map object-oriented domain models to a traditional relational database. The tutorial below shows how to use the CData JDBC Driver for Amazon Athena to generate an ORM of your Amazon Athena repository with Hibernate.

Though Eclipse is the IDE of choice for this article, the CData JDBC Driver for Amazon Athena works in any product that supports the Java Runtime Environment. In the Knowledge Base you will find tutorials to connect to Amazon Athena data from IntelliJ IDEA and NetBeans.

Getting Started

---

Install Hibernate

Follow the steps below to install the Hibernate plug-in in Eclipse.

1. In Eclipse, navigate to Help -> Install New Software.
2. Enter "http://download.jboss.org/jbosstools/neon/stable/updates/" in the Work With box.
3. Enter "Hibernate" into the filter box.
4. Select Hibernate Tools.

Start A New Project

Follow the steps below to add the driver JARs in a new project.

1. Create a new project. Select Java Project as your project type and click Next. Enter a project name and click Finish.
2. Right-click the project and click Properties. Click Java Build Path and then open the Libraries tab.
3. Click Add External JARs to add the cdata.jdbc.amazonathena.jar library, located in the lib subfolder of the installation directory.

Add a Hibernate Configuration File

Follow the steps below to configure connection properties to Amazon Athena data.

1. Right-click on the new project and select New -> Hibernate -> Hibernate Configuration File (cfg.xml).
2. Select src as the parent folder and click Next.

3. Input the following values:

   • Hibernate version:: 5.2
   • Database dialect: Derby
   • Driver class: cdata.jdbc.amazonathena.AmazonAthenaDriver

   • Connection URL: A JDBC URL, starting with jdbc:amazonathena: and followed by a semicolon-separated list of connection properties.

     Authenticating to Amazon Athena

     To authorize Amazon Athena requests, provide the credentials for an administrator account or for an IAM user with custom permissions: Set to the access key Id. Set to the secret access key.

     Note: Though you can connect as the AWS account administrator, it is recommended to use IAM user credentials to access AWS services.

     Obtaining the Access Key

     To obtain the credentials for an IAM user, follow the steps below:

     1. Sign into the IAM console.
     2. In the navigation pane, select Users.
     3. To create or manage the access keys for a user, select the user and then select the Security Credentials tab.

     To obtain the credentials for your AWS root account, follow the steps below:

     1. Sign into the AWS Management console with the credentials for your root account.
     2. Select your account name or number and select My Security Credentials in the menu that is displayed.
     3. Click Continue to Security Credentials and expand the Access Keys section to manage or create root account access keys.

     Authenticating from an EC2 Instance

     If you are using the CData Data Provider for Amazon Athena 2018 from an EC2 Instance and have an IAM Role assigned to the instance, you can use the IAM Role to authenticate. To do so, set to true and leave and empty. The CData Data Provider for Amazon Athena 2018 will automatically obtain your IAM Role credentials and authenticate with them.

     Authenticating as an AWS Role

     In many situations it may be preferable to use an IAM role for authentication instead of the direct security credentials of an AWS root user. An AWS role may be used instead by specifying the . This will cause the CData Data Provider for Amazon Athena 2018 to attempt to retrieve credentials for the specified role. If you are connecting to AWS (instead of already being connected such as on an EC2 instance), you must additionally specify the and of an IAM user to assume the role for. Roles may not be used when specifying the and of an AWS root user.

     Authenticating with MFA

     For users and roles that require Multi-factor Authentication, specify the and connection properties. This will cause the CData Data Provider for Amazon Athena 2018 to submit the MFA credentials in a request to retrieve temporary authentication credentials. Note that the duration of the temporary credentials may be controlled via the (default 3600 seconds).

     Connecting to Amazon Athena

     In addition to the and properties, specify , and . Set to the region where your Amazon Athena data is hosted. Set to a folder in S3 where you would like to store the results of queries.

     If is not set in the connection, the data provider connects to the default database set in Amazon Athena.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Amazon Athena JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.amazonathena.jar
     

     Fill in the connection properties and copy the connection string to the clipboard.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     

     A typical JDBC URL is below:

     jdbc:amazonathena:AWSAccessKey='a123';AWSSecretKey='s123';AWSRegion='IRELAND';Database='sampledb';S3StagingDirectory='s3://bucket/staging/';

Connect Hibernate to Amazon Athena Data

Follow the steps below to select the configuration you created in the previous step.

1. Switch to the Hibernate Configurations perspective: Window -> Open Perspective -> Hibernate.
2. Right-click on the Hibernate Configurations panel and click Add Configuration.
3. Set the Hibernate version to 5.2.
4. Click the Browse button and select the project.
5. For the Configuration file field, click Setup -> Use Existing and select the location of the hibernate.cfg.xml file (inside src folder in this demo).
6. In the Classpath tab, if there is nothing under User Entries, click Add External JARS and add the driver jar once more. Click OK once the configuration is done.
7. Expand the Database node of the newly created Hibernate configurations file.

Reverse Engineer Amazon Athena Data

Follow the steps below to generate the reveng.xml configuration file. You will specify the tables you want to access as objects.

1. Switch back to the Package Explorer.
2. Right-click your project, select New -> Hibernate -> Hibernate Reverse Engineering File (reveng.xml). Click Next.
3. Select src as the parent folder and click Next.
4. In the Console configuration drop-down menu, select the Hibernate configuration file you created above and click Refresh.
5. Expand the node and choose the tables you want to reverse engineer. Click Finish when you are done.

Configure Hibernate to Run

Follow the steps below to generate plain old Java objects (POJO) for the Amazon Athena tables.

1. From the menu bar, click Run -> Hibernate Code Generation -> Hibernate Code Generation Configurations.
2. In the Console configuration drop-down menu, select the Hibernate configuration file you created in the previous section. Click Browse by Output directory and select src.
3. Enable the Reverse Engineer from JDBC Connection checkbox. Click the Setup button, click Use Existing, and select the location of the hibernate.reveng.xml file (inside src folder in this demo).
4. In the Exporters tab, check Domain code (.java) and Hibernate XML Mappings (hbm.xml).
5. Click Run.

One or more POJOs are created based on the reverse-engineering setting in the previous step.

Insert Mapping Tags

For each mapping you have generated, you will need to create a mapping tag in hibernate.cfg.xml to point Hibernate to your mapping resource. Open hibernate.cfg.xml and insert the mapping tags as so:

 
 
 cdata.amazonathena.AmazonAthenaDriver
 
 
 jdbc:amazonathena:AWSAccessKey='a123';AWSSecretKey='s123';AWSRegion='IRELAND';Database='sampledb';S3StagingDirectory='s3://bucket/staging/';
 
 
 org.hibernate.dialect.SQLServerDialect
 
 
 
 

Execute SQL

Using the entity you created from the last step, you can now search and modify Amazon Athena data:

import java.util.*;
import org.hibernate.Session;
import org.hibernate.cfg.Configuration;
import org.hibernate.query.Query;

public class App {
 public static void main(final String[] args) {
 Session session = new
 Configuration().configure().buildSessionFactory().openSession();
 String SELECT = "FROM Customers C WHERE CustomerId = :CustomerId";
 Query q = session.createQuery(SELECT, Customers.class);
 q.setParameter("CustomerId","12345");
 List<Customers> resultList = (List<Customers>) q.list();

 for(Customers s: resultList){
 System.out.println(s.getName());
 System.out.println(s.getTotalDue());
 }
 }
}