@aws-sdk/client-athena
Advanced tools
AWS SDK for JavaScript Athena Client for Node.js, Browser and React Native
@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.
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();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.
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.
To install this package, simply type add or install @aws-sdk/client-athena using your favorite package manager:
npm install @aws-sdk/client-athenayarn add @aws-sdk/client-athenapnpm add @aws-sdk/client-athenaThe 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 ListDataCatalogsCommand:
// ES5 example
const { AthenaClient, ListDataCatalogsCommand } = require("@aws-sdk/client-athena");
// ES6+ example
import { AthenaClient, ListDataCatalogsCommand } from "@aws-sdk/client-athena";
To send a request, you:
send operation on client with command object as input.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 ListDataCatalogsCommand(params);
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.
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.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
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.listDataCatalogs(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listDataCatalogs(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listDataCatalogs(params, (err, data) => {
// process err and data.
});
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;
* }
*/
}
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.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
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.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
FAQs
AWS SDK for JavaScript Athena Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-athena receives a total of 145,877 weekly downloads. As such, @aws-sdk/client-athena popularity was classified as popular.
We found that @aws-sdk/client-athena demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.