 |
VOOZH | about |
|
VOOZH | about |
This guide walks you through everything you need to get started with the CData JDBC driver for Amazon Athena. You'll learn how to install and license the driver, configure your first connection, and explore next steps for working with Amazon Athena data in your Java applications.
CData provides the easiest way to access and integrate live data from Amazon Athena. Customers use CData connectivity to:
Users frequently integrate Athena with analytics tools like Tableau, Power BI, and Excel for in-depth analytics from their preferred tools.
To learn more about unique Amazon Athena use cases with CData, check out our blog post: https://www.cdata.com/blog/amazon-athena-use-cases.
Once installed, you can add the JAR file to your Java project's classpath using your IDE or build tool.
You should have received your license key via email from the CData Orders Team. The alphanumeric license key should take the following format:
XXXX-XXXX-XXXX-XXXX-XXXXOn Windows, the primary licensing method is via license file. When you install the JDBC driver, a license file is automatically created and stored with the driver installation. The driver will automatically detect and use this license file when the JAR is loaded in your application.
If you need to manually activate or update your license:
Navigate to the JAR's installation directory and in the lib folder run the following command: java -jar cdata.jdbc.amazonathena.jar --license
Follow the prompts to enter your license key. This will create a license file in the installation directory that the driver will use for licensing validation.
For detailed license file configuration instructions, refer to the Licensing section under the Getting Started sub-page in the help documentation.
Can I use my license on multiple machines?
Yes, depending on your subscription tier. Check your order confirmation or contact your account representative for details. If you are unsure of who your account representative is, contact [email protected].
I lost my license key. How do I retrieve it?
Email [email protected] with your order number, and we'll resend your license key.
Can I transfer my license to a different machine?
Yes. When transferring the license to a different machine, you will need to submit a License Transfer Request on our site linked below:
https://www.cdata.com/lic/transfer/
After the License Transfer Request is submitted and successfully processed, an activation will be added to your Product Key and you will be able to activate the full license on the other machine. Once this process is finished, the license on the previous machine will be invalid.
When should I use RTK instead of the license file?
Use RTK when deploying to environments where the machine/node ID changes dynamically, such as containers, cloud instances, or when distributing your application to multiple machines.
For additional licensing questions, contact [email protected]. Viewing and upgrading your license can now be done through our self-service portal at portal.cdata.com.
Once your driver is installed and licensed, you're ready to configure a connection to Amazon Athena. JDBC connections are established using a connection URL (also called a connection string).
JDBC connection URLs for CData drivers follow this pattern:
jdbc:amazonathena:AWSAccessKey='a123';AWSSecretKey='s123';AWSRegion='IRELAND';Database='sampledb';S3StagingDirectory='s3://bucket/staging/';The JDBC driver includes a connection string designer tool that helps you build the correct JDBC URL with all required connection properties.
The Connection String Designer ensures correct syntax and shows all available connection properties for Amazon Athena.
When configuring the JDBC driver in IDEs (such as IntelliJ IDEA, Eclipse, or DBeaver) or other tools, you will need to specify the driver class name:
cdata.jdbc.amazonathena.AmazonAthenaDriverThe specific connection properties required depend on your data source.
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.
To obtain the credentials for an IAM user, follow the steps below:
To obtain the credentials for your AWS root account, follow the steps below:
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.
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.
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).
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.
For complete information on all available connection properties for Amazon Athena, refer to the Establishing a Connection section in the help documentation.
You can test your connection in several ways:
Click the Test Connection button after entering your properties. A successful test confirms your credentials and connection settings are correct.
If the application requires you to move the driver JAR to a specific location, do so now and ensure the JAR is included in your application's classpath. Also, ensure that the .lic file is also moved to the same location for licensing validation purposes.
Note: Many JDBC Connected tools, like DBeaver, do not actually send a live request to the provider when using their Test Connection functionality. It only does a surface test, which essentially just checks that the JAR file functions at a base level. When using a JDBC connected tool, the ConnectOnOpen property should be set to True to ensure a valid Test Connection.
If you are working with the JDBC driver in your IDE, you can execute a simple query to verify the connection:
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.Statement;
String url = "jdbc:amazonathena:AWSAccessKey='a123';AWSSecretKey='s123';AWSRegion='IRELAND';Database='sampledb';S3StagingDirectory='s3://bucket/staging/';
Connection conn = DriverManager.getConnection(url);
Statement stmt = conn.createStatement();
ResultSet rs = stmt.executeQuery("SELECT * FROM Customers LIMIT 1");
if (rs.next()) {
System.out.println("Connection successful!");
}
If you encounter connection errors:
Solution: Ensure the JDBC driver JAR (cdata.jdbc.amazonathena.jar) is properly added to your project's classpath. The configuration method varies by IDE and build tool. Refer to your development environment's documentation or contact [email protected] for assistance.
Solution: Verify that your credentials are correct and current. Use the Connection String Designer to test your credentials before adding them to your application. For specific authentication requirements for Amazon Athena, consult the Establishing a Connection section in the help documentation.
Solution: Ensure that your firewall allows outbound connections on the required ports. Contact [email protected] for specific port and firewall requirements for your data source.
Solution: Use the Connection String Designer to generate a properly formatted JDBC URL. The designer ensures correct syntax and property names.
For additional troubleshooting, contact [email protected] with your specific error message.
Now that you have installed, licensed, and configured the driver, here are some scenarios you can use to explore our JDBC Drivers:
If you need assistance at any point:
For questions not covered in this FAQ, contact [email protected].
Download a free trial of the Amazon Athena Driver to get started:
Download NowLearn more:
👁 Amazon Athena IconRapidly create and deploy powerful Java applications that integrate with Amazon Athena.
