https://github.com/classmethod/athena-query

Athena-Query provide simple interface to get athena query results.
https://github.com/classmethod/athena-query

athena athena-client aws aws-athena aws-sdk-v3 nodejs

Last synced: 10 months ago
JSON representation

Athena-Query provide simple interface to get athena query results.

• Host: GitHub
• URL: https://github.com/classmethod/athena-query
• Owner: classmethod
• License: mit
• Created: 2022-11-30T00:05:59.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2025-04-08T14:02:02.000Z (11 months ago)
• Last Synced: 2025-04-08T15:21:45.473Z (11 months ago)
• Topics: athena, athena-client, aws, aws-athena, aws-sdk-v3, nodejs
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@classmethod/athena-query
• Size: 434 KB
• Stars: 9
• Watchers: 2
• Forks: 6
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Athena-Query

![Release](https://github.com/classmethod/athena-query/workflows/release/badge.svg)

![CI](https://github.com/classmethod/athena-query/workflows/CI/badge.svg)

[![npm version](https://img.shields.io/npm/v/@classmethod/athena-query.svg)](https://www.npmjs.com/@classmethod/athena-query)

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/classmethod/athena-query/blob/main/LICENSE)

**Athena-Query** provide simple interface to get athena query results.

Athena-Query was inspired and forked from [athena-express](https://github.com/ghdna/athena-express#readme).

> **Warning**

> Athena-Query support aws-sdk v3 only. So if you use aws-sdk v2, we recommend to use [athena-express](https://github.com/ghdna/athena-express#readme).

## Installation

```

npm install @classmethod/athena-query @aws-sdk/client-athena

```

```

yarn add @classmethod/athena-query @aws-sdk/client-athena

```

## Usage

### Basic Usage

Athena-Query provide `query()` method as [async generator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function*).

So we can use it with `for await () {}`,

```ts

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

import AthenaQuery from "@classmethod/athena-query";

const athena = new Athena({});

const athenaQuery = new AthenaQuery(athena);

for await (const item of athenaQuery.query("SELECT * FROM waf_logs;")) {

  console.log(item); // You can get all items across pagination.

}

```

And if you break loop out, Athena-Query don't call unnecessary pages of `get-query-result` api.

If you want to reduce the size of the queried data rather than the retrieved data, you can use the [LIMIT clause](https://docs.aws.amazon.com/athena/latest/ug/select.html#select-parameters).

### Options

When you initialize AthenaQuery class, you can pass options to specify the query target.

```ts

const athenaQuery = new AthenaQuery(athena, {

  db: "test-db",

  workgroup: "test-workgroup",

  catalog: "test-catalog",

  outputLocation: "s3://path/to/query/bucket/",

});

```

When you query to Athena, you can pass options for query.

```ts

const resultGen = athenaQuery.query(

  `

    SELECT * FROM waf_logs

    WHERE name = ? AND groupId = ? AND score > ?;

  `,

  {

    executionParameters: ["test", 123, 456n],

  },

);

```