Amazon Athena Reporting in OBIEE with the Amazon Athena JDBC Driver

The CData JDBC Driver for Amazon Athena is a standard database driver that can integrate real-time access to Amazon Athena data into your Java-based reporting server. This article shows how to deploy the driver to Oracle Business Intelligence Enterprise Edition (OBIEE) and create reports on Amazon Athena data that reflect any changes.

Getting Started

---

Deploy the JDBC Driver

Follow the steps below to add the JDBC driver to WebLogic's classpath.

For WebLogic 12.2.1, simply place the driver JAR and .lic file into DOMAIN_HOME\lib; for example, ORACLE_HOME\user_projects\domains\MY_DOMAIN\lib. These files will be added to the server classpath at startup.

You can also manually add the driver to the classpath: This is required for earlier versions. Prepend the following to PRE_CLASSPATH in setDomainEnv.cmd (Windows) or setDomainEnv.sh (Unix). This script is located in the bin subfolder of the folder for that domain. For example: ORACLE_HOME\user_projects\domains\MY_DOMAIN\bin.

set PRE_CLASSPATH=your-installation-directory\lib\cdata.jdbc.amazonathena.jar;%PRE_CLASSPATH%

Restart all servers; for example, run the stop and start commands in DOMAIN_HOME\bitools\bin.

Create a JDBC Data Source for Amazon Athena

After deploying the JDBC driver, you can create a JDBC data source from BI Publisher.

1. Log into BI Publisher, at the URL http://localhost:9502/analytics, for example, and click Administration -> Manage BI Publisher.
2. Click JDBC Connection -> Add Data Source.
3. Enter the following information:
   • Data Source Name: Enter the name that users will create connections to in their reports.
   • Driver Type: Select Other.
   • Database DriverClass: Enter the driver class, cdata.jdbc.amazonathena.AmazonAthenaDriver.
   • Connection String: Enter the JDBC URL.

     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.)
     

     When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

     A typical JDBC URL is below:

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

   • Username: Enter the username.
   • Password: Enter the password.
4. In the Security section, select the allowed user roles. 👁 The required settings for a JDBC data source. (Salesforce is shown.)
   

Create Real-Time Amazon Athena Reports

You can now create reports and analyses based on real-time Amazon Athena data. Follow the steps below to use the standard report wizard to create an interactive report that reflects any changes to Amazon Athena data.

1. On the global header, click New -> Data Model.
2. On the Diagram tab, select SQL query in the menu.
3. Enter a name for the query and in the Data Source menu select the Amazon Athena JDBC data source you created.
4. Select standard SQL and enter a query like the following:

   SELECT Name, TotalDue FROM Customers

   👁 The SQL query to be used to create the data set for the report's data model. (Salesforce is shown.)
   
5. Click View Data to generate the sample data to be used as you build your report.
6. Select the number of rows to include in the sample data, click View, and then click Save As Sample Data.
7. Click Create Report -> Use Data Model.
8. Select Guide Me and on the Select Layout page select the report objects you want to include. In this example we select Chart and Table.
9. Drop a numeric column like TotalDue onto the Drop Value Here box on the y-axis. Drop a dimension column like Name onto the Drop Label Here box on the x-axis. 👁 The dimensions and measures for a chart. (Salesforce is shown.)
   
10. Click Refresh to pick up any changes to the Amazon Athena data. 👁 An interactive, refresh-on-demand report. (Salesforce is shown.)