@aws-sdk/client-athena-browser

Description

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 using NPM, simply type the following into a terminal window:

npm install @aws-sdk/client-athena-browser

Getting Started

Import

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

//JavaScript
const { AthenaClient } = require("@aws-sdk/client-athena-browser/AthenaClient");
const {
  BatchGetNamedQueryCommand
} = require("@aws-sdk/client-athena-browser/commands/BatchGetNamedQueryCommand");

//TypeScript
import { AthenaClient } from "@aws-sdk/client-athena-browser/AthenaClient";
import { BatchGetNamedQueryCommand } from "@aws-sdk/client-athena-browser/commands/BatchGetNamedQueryCommand";

Usage

To send a request, you:

Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
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.

const athena = new AthenaClient({ region: "region" });
//clients can be shared by different commands
const params = {
  NamedQueryIds: [
    /**a list of string*/
  ]
};
const batchGetNamedQueryCommand = new BatchGetNamedQueryCommand(params);
athena
  .send(batchGetNamedQueryCommand)
  .then(data => {
    // do something
  })
  .catch(error => {
    // error handling
  });

In addition to using promises, there are 2 other ways to send a request:

// async/await
try {
  const data = await athena.send(batchGetNamedQueryCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
athena.send(batchGetNamedQueryCommand, (err, data) => {
  //do something
});

The SDK can also send requests using the simplified callback style from version 2 of the SDK.

import * as AWS from "@aws-sdk/@aws-sdk/client-athena-browser/Athena";
const athena = new AWS.Athena({ region: "region" });
athena.batchGetNamedQuery(params, (err, data) => {
  //do something
});

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 athena.send(batchGetNamedQueryCommand);
  // do something
} catch (error) {
  const metadata = error.$metadata;
  console.log(
    `requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.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 and have limited bandwidth to address them.

Ask a question on StackOverflow and tag it with aws-sdk-js
Come join the AWS JavaScript community on gitter
If it turns out that you may have found a bug, please open an issue

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-athena-browser' package is updated. To contribute to SDK you can checkout our code generator package.

License

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