VOOZH about

URL: https://www.cdata.com/kb/tech/athena-jdbc-mendix.rst

⇱ Build Apps with Live Amazon Athena Data Using the Low-Code Development Platform of Mendix


Build Apps with Live Amazon Athena Data Using the Low-Code Development Platform of Mendix

πŸ‘ Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
Connect Amazon Athena data with Mendix to build apps using the CData JDBC Driver for Amazon Athena.

Mendix, developed by Siemens, is a low-code platform used to rapidly develop, test, and deploy web and mobile applications, facilitating digital transformation and enhancing business agility. When paired with the CData JDBC Driver for Amazon Athena, you can use your Amazon Athena data to create various applications using Mendix Studio Pro.

With built-in optimized data processing, the CData JDBC driver offers unmatched performance for interacting with live Amazon Athena data. When you issue complex SQL queries to Amazon Athena, the driver pushes supported SQL operations, like filters and aggregations, directly to Amazon Athena and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Amazon Athena data using native data types.

This article shows how you can easily create an application that utilizes Amazon Athena data in Mendix by combining the JDBC interface provided by Mendix with the CData JDBC Driver for Amazon Athena.

About Amazon Athena Data Integration

CData provides the easiest way to access and integrate live data from Amazon Athena. Customers use CData connectivity to:

  • Authenticate securely using a variety of methods, including IAM credentials, access keys, and Instance Profiles, catering to diverse security needs and simplifying the authentication process.
  • Streamline their setup and quickly resolve issue with detailed error messaging.
  • Enhance performance and minimize strain on client resources with server-side query execution.

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.


Getting Started


Preparing the Mendix environment

In this section, we will explore how to develop an app using Mendix Studio Pro, as previously introduced, with Amazon Athena data. Be sure to install Mendix Studio Pro beforehand.

Install the CData JDBC Driver for Amazon Athena

First, install the CData JDBC Driver for Amazon Athena on the same machine as Mendix. The JDBC Driver will be installed in the following path:

C:\Program Files\CData\CData JDBC Driver for Amazon Athena 20xx\lib\cdata.jdbc.amazonathena.jar

Create an application

Now let's start creating the app. First, let's make an app that has the Database Connector available.

  1. Launch Mendix Studio Pro and click 'Create New App.' πŸ‘ Create a new app
  2. Select the 'Blank Web App' option. πŸ‘ Select the Blank Web App option
  3. Click 'Use this starting point' to proceed. πŸ‘ Use this starting point
  4. Create an app with a name of your choice. Also, note down the "Disk location" information, for future reference. πŸ‘ Name the app and note the disk location information
  5. You have now created a brand-new app. πŸ‘ The app is now created

Add the Database Connector to your application

Next, add the Database Connector module to the app you just created.

  1. On the top right, click on the Marketplace button.
  2. Search for Database Connector in the Marketplace search section and select it. πŸ‘ Search for the Database Connector from the marketplace
  3. Click on Download to download the latest Database Connector. πŸ‘ Download the latest Database Connector
  4. In the Import Module window, select the Action as Add as a new module. πŸ‘ Add a new module
    πŸ‘ Module is successfully imported
  5. If the Database Connector appears on the app screen, you are good to move on to the next steps. πŸ‘ Database connector is ready to be used

Adding the JDBC Driver to Mendix Studio Pro

To use the CData JDBC driver with this Database Connector, you must add the JDBC Driver JAR file to your project.

  1. In the Mendix project folder you noted earlier, there is a folder named 'userlib.' Place the two files, 'cdata.jdbc.amazonathena.jar' and 'cdata.jdbc.amazonathena.lic,' into that folder. πŸ‘ Place the JAR and LIC files in the userlib folder of Mendix
  2. You can now use the CData JDBC Driver with the Database Connector.

Create a Data Model

Now, let's create an app. We first need to define a data model to load data from the Database Connector and display it on the list screen. Let's create the data model before loading the data.

  1. Add an Entity to the 'Domain model' of MyFirstModule. πŸ‘ Add an entity
  2. Enter the entity name and field definitions. πŸ‘ Add the entity name and field definitions
  3. You can easily configure the data by checking the table definition information through the CData JDBC driver using a tool such as DBeaver. πŸ‘ Check and configure the data using any database administration tool
  4. Define the entities. πŸ‘ Define the entities

Create a constant for the JDBC URL

Next, create a JDBC URL constant to use with the Database Connector.

  1. Add 'Constant' to MyFirstModule. πŸ‘ Add a constant
  2. Add a name to the Constant in the Add Constant window. πŸ‘ Add a name to the constant
  3. Generate a JDBC URL for connecting to Amazon Athena, beginning with jdbc:amazonathena: followed by a series of semicolon-separated connection string 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/';
    
  4. Specify the connection string copied from the previous step in the Default value section and click on OK. πŸ‘ Provide the connection string

Create a microflow to retrieve Amazon Athena data

Let's create a microflow that retrieves data from the Database Connector based on the entity we created.

  1. Click 'Add microflow' from MyFirstModule. πŸ‘ Click on Add microflow
  2. Create a microflow with any name. πŸ‘ Create a microflow
  3. First, create an object for the entity you defined earlier. Then, add the 'Create Object' action to the microflow. πŸ‘ Create an object
  4. Click on the 'Select' button for Entity in the Create Object window. πŸ‘ Click on Select in create object window
  5. Select a previously defined Entity. πŸ‘ Select the defined entity
  6. Enter an arbitrary Object name and click OK. πŸ‘ Enter an object name
  7. Next, add an Execute Query action to the microflow to retrieve data from the Database Connector. πŸ‘ Add an execute query action
  8. Define each input in the Execute Query window. πŸ‘ Define each inputs for execute query
  9. In "jdbc url", specify the constant you defined beforehand. πŸ‘ Specify the constant defined before
  10. In SQL, write a query to retrieve data from Amazon Athena. πŸ‘ Write a query to retrieve the data
  11. You don't need a Username or Password this time, so set them to 'empty' and assign the object created in the previous flow as the Result object. Then, simply specify any name you prefer for the List in the List Name section. πŸ‘ Add any name to the list
  12. Finally, define the output of the microflow. πŸ‘ Define the output of the microflow
  13. Double-click the End Event to open it, select 'List' from the Type dropdown, and link it to the Entity you defined earlier. Then, set the output result of Execute Query as the Return value. πŸ‘ Link list to the entity
  14. This completes the microflow that retrieves data from Amazon Athena. πŸ‘ Microflow creation is complete

Create a list screen and link it to a microflow

Finally, let's create a screen that displays the results obtained from the microflow.

  1. Double-click 'Home_web' inside the Toolbox menu to open it. πŸ‘ Open Home_web from toolbox menu
  2. Drag and drop a Data grid template from the Data containers section into the list screen. πŸ‘ Drag and drop data grid template into the list screen
  3. Once you have placed the Data grid, double-click on it to display the Edit Data Grid settings screen. πŸ‘ Open edit data grid to configure it
  4. Navigate to the Data source tab and link the data source type with the Microflow.
  5. Select the microflow you just created. πŸ‘ Select the microflow
  6. Now click OK. πŸ‘ Approve the microflow configuration
  7. When you click OK, you'll be prompted to auto-detect columns. Simply click 'Yes' to proceed. πŸ‘ Click Yes for auto-detect columns
  8. Next, you'll be prompted to generate controllers for various Data grids. Since we won't be configuring the logic for each one this time, click 'No.' πŸ‘ Click No to controllers for data grids
  9. This will create a simple data grid screen as shown below. πŸ‘ Data grid screen is now created and ready to be used

Try it out

Now let's check if it works properly.

  1. Click the 'Publish' button to prepare the app you created. Once that's done, click 'View App' to open the app. πŸ‘ Publish the app created
  2. If you see a list of Amazon Athena data like the one below, you're all set! You've successfully created a Amazon Athena-linked app with low code, without needing to worry about Amazon Athena's API. πŸ‘ See the list of Amazon Athena data on the Mendix app screen

Get Started Today

Download a free 30-day trial of the CData JDBC Driver for Amazon Athena with Mendix, and effortlessly create an app that connects to Amazon Athena data.

Reach out to our Support Team if you have any questions.

Ready to get started?

Download a free trial of the Amazon Athena Driver to get started:

 Download Now

Learn more:

πŸ‘ Amazon Athena Icon
Amazon Athena JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Amazon Athena.