Getting Started

Dyfan Jones

The noctua package aims to make it easier to work with data stored in AWS Athena. noctua package attempts to provide three levels of interacting with AWS Athena:

Installing noctua:

As noctua utilising the R AWS SDK paws the installation of noctua is pretty straight forward:

# cran version

# Dev version

Docker Example:

To help with users wishing to run noctua in a docker, a simple docker file has been created here. To set up the docker please refer to link. For demo purposes we will use the example docker and run it locally:

# build docker image
docker build . -t noctua

# start container with aws credentials passed from local
docker run \
      -e AWS_ACCESS_KEY_ID="$(aws configure get aws_access_key_id)" \
      -e AWS_SECRET_ACCESS_KEY="$(aws configure get aws_secret_access_key)" \
      -e AWS_SESSION_TOKEN="$(aws configure get aws_session_token)" \
      -e AWS_DEFAULT_REGION="$(aws configure get region)" \
      -it noctua

NOTE: readr isn’t required for noctua, however it has been included in the docker file to improve performance when querying AWS Athena.


Low - Level API: