Amazon Athena JDBC Driver Wrapper Supporting the 'metis' Package
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

88 lines
2.4 KiB

7 years ago
---
output: rmarkdown::github_document
editor_options:
chunk_output_type: console
7 years ago
---
5 years ago
```{r include=FALSE}
knitr::opts_chunk$set(
echo = TRUE,
message = FALSE,
warning = FALSE,
fig.retina = 2
)
Sys.setenv(
AWS_S3_STAGING_DIR = "s3://aws-athena-query-results-569593279821-us-east-1"
)
options(width=120)
```
6 years ago
5 years ago
[![Travis-CI Build Status](https://travis-ci.org/hrbrmstr/metis-jars.svg?branch=master)](https://travis-ci.org/hrbrmstr/metis-jars)
[![Coverage Status](https://codecov.io/gh/hrbrmstr/metis-jars/branch/master/graph/badge.svg)](https://codecov.io/gh/hrbrmstr/metis-jars)
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/metis-jars)](https://cran.r-project.org/package=metis.jars)
5 years ago
# metis.jars
7 years ago
5 years ago
Amazon Athena JDBC Driver Wrapper Supporting the 'metis' Package
7 years ago
6 years ago
## Description
5 years ago
Contents of the Amazon Athena JDBC Driver
<https://docs.aws.amazon.com/athena/latest/ug/connect-with-jdbc.html>
provided to support functions in the 'metis' package. Version number
reflects the version number of the included 'JAR' file.
7 years ago
5 years ago
## IMPORTANT
5 years ago
Until a release of 'rJava' newer than '0.9.10' is on CRAN signals sent
from interrupting Athena JDBC calls crash the R interpreter. You therefore
need to set the `-Xrs` option to avoid signals being passed on to the JVM
owner. That has to be done _before_ `rJava` is loaded so you either need
to remember to put it at the top of all scripts _or_ stick this
in your local `~/.Rprofile` and/or sitewide `Rprofile`:
5 years ago
```r
5 years ago
options(
"java.parameters" = c(getOption("java.parameters", default = NULL), "-Xrs")
)
5 years ago
```
6 years ago
## What's Inside The Tin?
7 years ago
The following functions are implemented:
5 years ago
- `athena_supported_types`: Retrieve the current supported type names in Athena
- `metis_jar_path()` : Retrieve the fully-qualified path to the included Athena JAR file
- `simba_driver_version`: Retrieve the version of the Simba Athena JDBC driver included with the package
6 years ago
## Installation
7 years ago
```{r eval=FALSE}
5 years ago
devtools::install_git("https://git.sr.ht/~hrbrmstr/metis-jars")
# OR
5 years ago
devtools::install_gitlab("hrbrmstr/metis-jars")
# OR
5 years ago
devtools::install_github("hrbrmstr/metis-jars")
7 years ago
```
6 years ago
## Usage
7 years ago
5 years ago
```{r}
5 years ago
library(metis.jars)
7 years ago
# current verison
5 years ago
packageVersion("metis.jars")
```
```{r}
5 years ago
simba_driver_version()
5 years ago
athena_supported_types()
5 years ago
metis_jar_path()
7 years ago
```
6 years ago
## Code of Conduct
Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.