Ready to get started?

Learn more about the CData JDBC Driver for Amazon Athena or download a free trial:

Download Now

Connect to Amazon Athena Data in Jaspersoft Studio

Execute SQL to remote Amazon Athena data in Jaspersoft Studio.

This article shows how to connect to Amazon Athena from Jaspersoft Studio as a standard JDBC data source with the CData JDBC Driver for Amazon Athena. You will use the standard Jaspersoft wizards to build SQL queries to Amazon Athena. The queries are executed directly to the Amazon Athena APIs, enabling real-time connectivity to Amazon Athena data.

Connect to Amazon Athena Data as a JDBC Data Source

To create a JDBC data source in Jaspersoft Studio, create a data adapter:

  1. In the Repository Explorer view, right-click the Data Adapters node and click Create Data Adapter.
  2. Select Database JDBC Connection.
  3. Enter a user-friendly name for the driver.
  4. On the Driver Classpath tab, click Add. In the resulting dialog, navigate to the lib subfolder of the installation directory. Select the driver JAR.
  5. On the Database Location tab, enter the class name of the JDBC driver: cdata.jdbc.amazonathena.AmazonAthenaDriver.
  6. 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 AccessKey to the access key Id. Set SecretKey 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 UseEC2Roles to true and leave AccessKey and SecretKey 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 RoleARN. 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 AccessKey and SecretKey of an IAM user to assume the role for. Roles may not be used when specifying the AccessKey and SecretKey of an AWS root user.

    Authenticating with MFA

    For users and roles that require Multi-factor Authentication, specify the MFASerialNumber and MFAToken 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 TemporaryTokenDuration (default 3600 seconds).

    Connecting to Amazon Athena

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

    If Database 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.

    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 for Amazon Athena:

    jdbc:amazonathena:AccessKey='a123';SecretKey='s123';Region='IRELAND';Database='sampledb';S3StagingDirectory='s3://bucket/staging/';

Create Reports with Amazon Athena Data

Follow the steps below to build an SQL query to Amazon Athena, the basis of a simple report:

  1. Click File -> New Jasper Report. Select a template, select the parent project, and specify the report file.
  2. In the Data Adapter menu, select the data adapter you created in the previous section.
  3. In the Diagram tab, drag tables into the box and click the columns you want. Or, enter a custom query on the Texts tab. For example: SELECT Name, TotalDue FROM Customers
  4. Select the fields you want to include in the dataset. This example uses all fields.
  5. Skip the Group By step and finish the wizard.

In the Preview tab, you can see the report as it would look with the current Amazon Athena data.

Create a Chart

The following sections show how to create a chart tied to its own SQL query. When retrieving the data from the remote data source, more restrictive queries, written for specific report objects, can result in faster performance.

Create a DataSet

Follow the steps below to create a new dataset to populate the chart:

  1. In the report editing area, click the Design tab.
  2. In the Outline view, right-click the root node for the report and click Create Dataset.
  3. Enter a name for the dataset and click the option to create a new dataset from a connection or data source.
  4. In the Data Adapter menu, select the data adapter you created in the first section.
  5. Enter a query such as the following:

    SELECT Name, TotalDue FROM Customers
  6. Select the fields you want in the dataset. This example uses Name and TotalDue.
  7. Skip the step to group by fields and finish the wizard.

Configure the Chart

After adding the dataset, follow the steps below to map column values to the chart axes in the chart wizard:

  1. Click the Summary node in the Outline view. In the Properties view, set the height to 400 pixels. The summary band is printed at the end of the report.
  2. Drag a chart from the Palette onto the summary. The chart wizard is displayed.
  3. Select the chart type. This example uses a bar chart.
  4. In the Dataset menu, select the dataset you created for the chart.
  5. In the Dataset tab, select the option to use the same JDBC connection used to fill the master report.
  6. Specify the chart's series: Click the button next to the Series menu and click Add. In the Expression Editor that is displayed, double-click the Name column to set the expression to $F{Name}.
  7. Specify the y-axis values: In the chart wizard, click the button next to the Value box. In the Expression Editor, double-click TotalDue to set the expression to $F{TotalDue}.

  8. Specify the labels for the series elements: In the chart wizard, click the button next to the Label box. In the Expression Editor, double-click the Name column to set the expression to $F{Name}. If needed, convert the column type to string, as in the following expression: $F{Name}.toString()
  9. Expand the chart to fill the summary section: right-click the chart and click Size to Container -> Fit Both.

Running the Report

You can now generate reports on Amazon Athena data just as you would any other JDBC data source. Jaspersoft Studio periodically refreshes the data across report runs.