Document toolboxDocument toolbox

Working with Athena Connection

Owned by Sarabjeet Kaur
Feb 08, 2024
2 min read

Applies to: Kyvos Enterprise  Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace

Kyvos Azure Marketplace   Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)

Kyvos supports Amazon Athena Service to run interactive ad hoc SQL queries against data on Amazon S3, without having to manage any infrastructure or cluster. Athena is an interactive query service that makes it easy to analyze data directly in Amazon S3 using standard SQL. Athena scales automatically, running queries in parallel, so results are fast, even with large datasets and complex queries.

Note

You can create multiple Athena connections for raw data querying. The connections are available on the Semantic model designer page, where you can select the connection to be used for a particular semantic model. 
See the Working with non-materialized or raw data semantic models section for more details. 

Prerequisites

The permissions required to run Athena queries include the following:  

  • Amazon S3 locations where the underlying data to query is stored. 

  • Metadata and resources that you store in the AWS Glue Data Catalog, such as databases and tables 

  • Athena API actions 

To set up or view the AthenaSQL connection, perform the following steps.

  1. From the Toolbox, click Setup, then Connections.

  2. From the Actions menu ( ⋮ ) click Add Connection.

  3. Enter a Name or select it from the Connection list.

  4. After you finish configuring the settings using the table shown below, click the Test button from the top left to validate the connection settings.

  5. If the connection is valid, click the Save button. 

Parameter/Field

Comments/Description

Parameter/Field

Comments/Description

Name

Enter a unique name for the connection.

Category

Select the SQL Engine option.

Provider 

Select the Athena option. 

Catalog

Enter the data source registered in Athena.

Workgroup

Enter the Athena Workgroup to be used for querying.

S3 Location Type

Select the type of S3 location from any of the following:

  • Kyvos defined: Kyvos will create an athena_query_output folder inside the configured Kyvos working directory. The content of this folder is purged after three days (by Kyvos). 

  • Workgroup defined: In this case, no S3 location parameter is provided to the Athena driver. Athena will fetch the location from workgroup settings for storing the result.

  • User defined: A user needs to provide an S3 location which will be used to dump the query. 

NOTE: For Workgroup defined and User defined options, Athena automatically deletes the query result after 45 days.

S3 Location

Provide the location of the S3 bucket to be used for reading data.
NOTE: This option is displayed only if you selected User defined option in S3 Location Type.

Authentication Type

By default, the IAM - Instance Profile Credentials option is selected.

URL

Type the URL in jdbc:awsathena://athena.<Region>.amazonaws.com:443 format.
For example, for Athena hosted in us-east-1 region, use the URL: jdbc:awsathena://athena.us-east-1.amazonaws.com:443

Use as source

By default, the checkbox is selected as this connection can only be used to read data (creating registered datasets) on which the semantic model will be created. 

Is Default SQL Engine

To enable the connection for raw data, select the checkbox to set this connection to run the default SQL engine. 

Properties

Click Properties to view or set properties.

 

Copyright Kyvos, Inc. All rights reserved.