grax-athena-connector
Service icon

GRAX_Athena_Connector

version 1.0.0 (Compatible with OutSystems 11)
Uploaded
 on 05 December 2024
 by 
0.0
 (0 ratings)
grax-athena-connector

GRAX_Athena_Connector

Documentation
1.0.0

This documentation provides a comprehensive overview of the GRAX Athena Connector Demo, its functionality, and how to use it.


Overview

The GRAX Athena Connector Demo allows users to seamlessly interact with their GRAX data using Amazon Athena queries. This demo highlights how to configure, query, and view responses effectively.


Features

  1. Configuration Management:
    • Easily input necessary credentials and settings for Athena.
    • Validate configuration details to establish a connection.
  2. Query Execution:
    • Write and execute SQL queries directly from the dashboard.
    • View real-time query results in the output panel.
  3. Error Handling:
    • Get feedback for invalid queries or incorrect configuration settings.
    • Debug issues with clear error messages.


App pages

1. Dashboard Page

This is the main interface for interacting with Athena.

  • Features:
    • Query Box: Enter SQL queries. Example: “SELECT * FROM object_table;”
    • Run Query Button: Execute the query against Athena.
    • Output Panel: Displays the results of the query if successful or an error message if the query fails.
  • Usage Flow:
    • After completing configuration on the Configurations Page, navigate to the Dashboard.
    • Input a valid SQL query.
    • Click the Run Query button to execute.


2. Configurations Page

This page is where you configure the connection to Athena.

  • Inputs Required:
    • Access Key ID: Your AWS Access Key ID.
    • Secret Access Key: Your AWS Secret Access Key.
    • Region: AWS region.
    • Workgroup: The Athena workgroup to use for queries.
    • Database: The database name to query.
    • Tables: A list of tables available for querying.
    • Output Location: The S3 bucket where query results will be stored (e.g., s3://your-bucket/query-results/).
  • Actions:
    • Save the configuration settings.
    • Validate the connection.


Setup Instructions

  1. Open the Configuration Page.
  2. Enter the following details:
  • Region
  • Access Key ID
  • Secret Access Key
  • Workgroup
  • Database
  • Tables
  • Output Location
  1. Save the settings and proceed to the Dashboard Page.
  2. Enter your SQL query in the input field and execute it.



How It Works

  1. The Configuration Page stores the connection details required for interacting with GRAX and Athena.
  2. The Dashboard Page serves as the querying interface where users input SQL queries.
  3. Queries are executed via Athena, and the output is displayed within the app for validation.



Troubleshooting

  1. Invalid Configuration Settings:
    • Double-check the Region formatting.
    • Ensure your AWS credentials have the necessary permissions.
  2. Query Errors:
    • Verify SQL syntax.
    • Confirm the database and table names are correct.
  3. Connection Issues:
    • Ensure the Output Location S3 bucket exists and is accessible.
    • Check internet connectivity and AWS service availability.