3.1165.0 • Published 3m ago

@aws-sdk/client-athena

Licence

Apache-2.0

Version

3.1165.0

Deps

Size

1.2 MB

Vulns

Weekly

Stars

3.7K

Summary Dependency Versions

@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.

Installing

To install this package, use the CLI of 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 ListDataCatalogsCommand:

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

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

Usage

To send a request:

Instantiate a client with configuration (e.g. credentials, region).
- See docs/CLIENTS for configuration details.
- See @aws-sdk/config for additional options.
Instantiate a command with input parameters.
Call the send operation on the client, providing the command object as input.

const client = new AthenaClient({ region: "REGION" });

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

Async/await

We recommend using the 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.
}

Promises

You can also use Promise chaining.

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

Aggregated client

The aggregated client class is exported from the same package, but without the "Client" suffix.

Athena extends AthenaClient and additionally supports all operations, waiters, and paginators as methods. This style may be familiar to you from the AWS SDK for JavaScript v2.

If you are bundling the AWS SDK, we recommend using only the bare-bones client (AthenaClient). More details are in the blog post on modular packages in AWS SDK for JavaScript.

import { Athena } from "@aws-sdk/client-athena";

const client = new 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 (not recommended).
client.listDataCatalogs(params, (err, data) => {
  // process 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 GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

Visit the 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.

BatchGetPreparedStatement