Integrate with Amazon Athena Data in JReport Designer

The CData JDBC Driver for Amazon Athena data enables access to live data from dashboards and reports as if Amazon Athena were a relational database, allowing you to query Amazon Athena data using familiar SQL queries. This article shows how to connect to Amazon Athena data as a JDBC data source and create reports based on Amazon Athena data in JReport Designer.

Getting Started

---

Connect to Amazon Athena Data

1. Edit C:\JReport\Designer\bin\setenv.bat to add the location of the JAR file to the ADDCLASSPATH variable:

   ...
   set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\Program Files\CData\CData JDBC Driver for Amazon Athena 2016\lib\cdata.jdbc.amazonathena.jar;
   ...
   

2. Create a new data source by clicking File New Data Source.
3. In the resulting dialog, create a name for the data source (CData JDBC Driver for Amazon Athena), select JDBC, and click OK.
4. In the Get JDBC Connection Information dialog you will configure your connection to the JDBC driver:
   • Driver: Be sure that the Driver box is checked and fill in the name of the class for the driver:

     cdata.jdbc.amazonathena.AmazonAthenaDriver

   • URL: Enter the JDBC URL. This starts with jdbc:amazonathena: and is 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.)
     

     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.

     Below is a typical JDBC URL:

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

   • User: The username to authenticate with; typically left blank.
   • Password: The password to authenticate with; typically left blank.
   👁 Configuring the connection to the JDBC Driver (Salesforce is shown.)
   

5. In the Add Table dialog, select the tables you wish to include in your report (or in future reports using this data source) and click Add.

   👁 Adding Tables. (Salesforce is shown.)
   

   Click Done once the dialog has completed loading the tables.

6. In the Catalog Browser, you can create the queries that you will use to populate your reports. You can do this now, or after you create your report. In either case, expand () the data source (CData JDBC Driver for Amazon Athena), right-click on Queries, and select Add Query. 👁 Adding a query for data to be used in the report. (Salesforce is shown.)
   
7. In the Add Table/View/Query dialog, expand () the JDBC URL and Tables and select the table(s) you wish to use in the query and click OK. 👁 Selecting a table for the query. (Salesforce is shown.)
   
8. In the Query Editor dialog, you can select the columns you wish to include or simply click the SQL button and manually input your own query. For example:

   SELECT Name, TotalDue FROM Customers
   

   👁 Editing the query. (Salesforce is shown.)
   

   With the query built, click OK to close the Query Editor dialog. At this point you are ready to add Amazon Athena data to a new or existing report.

   NOTE: Now that the query is built, you can create a Business View based on the query. With a Business View, you can create Web reports or library components based on the query. For more information on this, refer to the JReport tutorials.

Add Amazon Athena Data to a Report

You are now ready to create a report with Amazon Athena data.

1. Create a new report (File New Page Report) or open the Chart Wizard for an existing report.
2. Select the Query (or create a new one; see above).
👁 Selecting the query to use. (Salesforce is shown.)

3. Assign a Category and Value for the chart from the columns in your Query and click Finish.
👁 Assigning columns to define the chart. (Salesforce is shown.)

4. Click the View tab for your report to see the chart.