@aws-sdk/client-athena

What is @aws-sdk/client-athena?

@aws-sdk/client-athena is a part of the AWS SDK for JavaScript, which allows developers to interact with Amazon Athena, a serverless interactive query service that makes it easy to analyze data in Amazon S3 using standard SQL.

What are @aws-sdk/client-athena's main functionalities?

StartQueryExecution

This feature allows you to start a new query execution in Amazon Athena. The code sample demonstrates how to initiate a query execution and log the Query Execution ID.

const { AthenaClient, StartQueryExecutionCommand } = require('@aws-sdk/client-athena');

const client = new AthenaClient({ region: 'us-west-2' });

const params = {
  QueryString: 'SELECT * FROM sample_table;',
  QueryExecutionContext: { Database: 'sample_database' },
  ResultConfiguration: { OutputLocation: 's3://your-output-bucket/' }
};

const run = async () => {
  try {
    const data = await client.send(new StartQueryExecutionCommand(params));
    console.log('Query Execution ID:', data.QueryExecutionId);
  } catch (err) {
    console.error(err);
  }
};

run();

GetQueryExecution

This feature allows you to get the status of a query execution. The code sample demonstrates how to retrieve and log the status of a specific query execution.

const { AthenaClient, GetQueryExecutionCommand } = require('@aws-sdk/client-athena');

const client = new AthenaClient({ region: 'us-west-2' });

const params = { QueryExecutionId: 'your-query-execution-id' };

const run = async () => {
  try {
    const data = await client.send(new GetQueryExecutionCommand(params));
    console.log('Query Execution Status:', data.QueryExecution.Status.State);
  } catch (err) {
    console.error(err);
  }
};

run();

GetQueryResults

This feature allows you to retrieve the results of a query execution. The code sample demonstrates how to fetch and log the results of a specific query execution.

const { AthenaClient, GetQueryResultsCommand } = require('@aws-sdk/client-athena');

const client = new AthenaClient({ region: 'us-west-2' });

const params = { QueryExecutionId: 'your-query-execution-id' };

const run = async () => {
  try {
    const data = await client.send(new GetQueryResultsCommand(params));
    console.log('Query Results:', data.ResultSet.Rows);
  } catch (err) {
    console.error(err);
  }
};

run();

Other packages similar to @aws-sdk/client-athena

aws-sdk

The 'aws-sdk' package is the older version of the AWS SDK for JavaScript. It provides a comprehensive set of tools for interacting with various AWS services, including Amazon Athena. However, it is less modular and more monolithic compared to the newer '@aws-sdk/client-athena' package.

README

@aws-sdk/client-athena

Description

AWS SDK for JavaScript Athena Client for Node.js, Browser and React Native.

Amazon Athena is an interactive query service that lets you use standard SQL to analyze data directly in Amazon S3. You can point Athena at your data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay only for the queries you run. Athena scales automatically—executing queries in parallel—so results are fast, even with large datasets and complex queries. For more information, see What is Amazon Athena in the Amazon Athena User Guide.

If you connect to Athena using the JDBC driver, use version 1.1.0 of the driver or later with the Amazon Athena API. Earlier version drivers do not support the API. For more information and to download the driver, see Accessing Amazon Athena with JDBC.

For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

Installing

To install the this package, simply type add or install @aws-sdk/client-athena using your favorite package manager:

• npm install @aws-sdk/client-athena
• yarn add @aws-sdk/client-athena
• pnpm add @aws-sdk/client-athena

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the AthenaClient and the commands you need, for example BatchGetNamedQueryCommand:

// ES5 example
const { AthenaClient, BatchGetNamedQueryCommand } = require("@aws-sdk/client-athena");

// ES6+ example
import { AthenaClient, BatchGetNamedQueryCommand } from "@aws-sdk/client-athena";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region).
• Initiate command with input parameters.
• Call send operation on client with command object as input.
• If you are using a custom http handler, you may call destroy() to close open connections.

// a client can be shared by different commands.
const client = new AthenaClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new BatchGetNamedQueryCommand(params);

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
  (data) => {
    // process data.
  },
  (error) => {
    // error handling.
  }
);

Promises can also be called using .catch() and .finally() as follows:

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
  // proccess err and data.
});

v2 compatible style

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-athena";
const client = new AWS.Athena({ region: "REGION" });

// async/await.
try {
  const data = await client.batchGetNamedQuery(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .batchGetNamedQuery(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.batchGetNamedQuery(params, (err, data) => {
  // proccess err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

• Visit Developer Guide or API Reference.
• Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
• Ask a question on StackOverflow and tag it with aws-sdk-js.
• Join the AWS JavaScript community on gitter.
• If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-athena package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Changelog

3.14.0 (2021-04-30)

Bug Fixes

• clients: typo in README difference -> different (#2314) (9ac1f40)
• middleware-user-agent-header: swap user agent headers for non-browser environments (#2313) (d8c1dc2)
• xml-builder: xml entity encoding for more characters (#2309) (96ff164)

Features

• clients: update clients as of 04/29/2021 (#2329) (48ab750)