Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guardian/athena-cli
Presto-like CLI tool for AWS Athena
https://github.com/guardian/athena-cli
misc
Last synced: 3 months ago
JSON representation
Presto-like CLI tool for AWS Athena
- Host: GitHub
- URL: https://github.com/guardian/athena-cli
- Owner: guardian
- License: apache-2.0
- Archived: true
- Created: 2017-07-20T21:42:32.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-10-11T08:31:36.000Z (about 2 years ago)
- Last Synced: 2024-06-28T08:33:15.359Z (5 months ago)
- Topics: misc
- Language: Python
- Homepage:
- Size: 65.4 KB
- Stars: 85
- Watchers: 14
- Forks: 15
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Athena CLI
==========
[](https://travis-ci.org/guardian/athena-cli)
Presto-like CLI tool for [AWS Athena](https://aws.amazon.com/athena/). The alternative is using the
AWS CLI [Athena sub-commands](http://docs.aws.amazon.com/cli/latest/reference/athena/).
[](https://asciinema.org/a/132545)
Requirements
------------
A recent version of the `aws` CLI must be available on the PATH.
Installation
------------
To install using `pip` run:
$ pip install athena-cli
Or, clone the GitHub repo and run:
$ python setup.py install
Configuration
-------------
Only required configuration is AWS credentials.
Usage
-----
```
$ athena --help
usage: athena [--debug] [--execute ] [--output-format ] [--schema ]
[--profile ] [--region ] [--s3-bucket ]
[--server-side-encryption] [--version]
Athena interactive console
optional arguments:
-h, --help show this help message and exit
--debug enable debug mode
--execute STATEMENT execute statement in batch mode
--output-format FORMAT
output format for batch mode [ALIGNED, VERTICAL, CSV,
TSV, CSV_HEADER, TSV_HEADER, NULL]
--schema SCHEMA, --database SCHEMA, --db SCHEMA
default schema
--profile PROFILE AWS profile
--region REGION AWS region
--s3-bucket BUCKET, --bucket BUCKET
AWS S3 bucket for query results
--server-side-encryption, --encryption
Use server-side-encryption for query results
--version show version info and exit
```
```
athena> help
Supported commands:
QUIT
SELECT
ALTER DATABASE
ALTER TABLE
CREATE DATABASE
CREATE TABLE
DESCRIBE
DROP DATABASE
DROP TABLE
MSCK REPAIR TABLE
SHOW COLUMNS FROM
SHOW CREATE TABLE
SHOW DATABASES [LIKE ]
SHOW PARTITIONS
SHOW TABLES [IN ] []
SHOW TBLPROPERTIES
USE [.]
VALUES row [, ...]
```
See http://docs.aws.amazon.com/athena/latest/ug/language-reference.html
Example
-------
```
athena> use sampledb;
athena:sampledb> show tables;
tab_name
------------
elb_logs
(1 rows)
Query deb156b5-293e-472d-8897-5ee195b06b11, SUCCEEDED
https://eu-west-1.console.aws.amazon.com/athena/home?force®ion=eu-west-1#query/history/deb156b5-293e-472d-8897-5ee195b06b11
Time: 0:00:00, CPU Time: 474ms total, Data Scanned: 0.00B, Cost: $0.00
```
Troubleshooting
---------------
Use the `--debug` option when launching the `athena` CLI to get AWS debug output:
```shell
$ athena --debug
2017-07-21 10:10:45,477 botocore.credentials [DEBUG] Looking for credentials via: env
2017-07-21 10:10:45,478 botocore.credentials [DEBUG] Looking for credentials via: assume-role
2017-07-21 10:10:45,478 botocore.credentials [DEBUG] Looking for credentials via: shared-credentials-file
2017-07-21 10:10:45,479 botocore.credentials [INFO] Found credentials in shared credentials file: ~/.aws/credentials
...
```
Turn on debug at the `athena>` prompt by typing:
```
athena> set debug true
debug - was: False
now: True
```
The below error means the version of `aws` CLI is not recent enough. Upgrade
to version 1.10.18 or higher:
```
Command 'aws sts get-caller-identity --output text --query 'Account' --profile default' returned non-zero exit status 2
```
Command history is written to `~/.athena_history`.
References
----------
* AWS Athena: https://aws.amazon.com/athena/
* AWS SDK for Python: https://boto3.readthedocs.io/en/latest/reference/services/athena.html
* PrestoDB: https://prestodb.io/docs/current/
License
-------
Athena CLI
Copyright 2017-2018 Guardian News & Media
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.