diff --git a/.Rbuildignore b/.Rbuildignore index 1ca9af5..1333beb 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,3 +1,5 @@ +^Meta$ +^doc$ ^LICENSE\.md$ ^.*\.Rproj$ ^\.Rproj\.user$ diff --git a/.gitignore b/.gitignore index 393f133..ccbfdf2 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ +Meta +doc inst/doc .DS_Store .Rproj.user diff --git a/DESCRIPTION b/DESCRIPTION index 58c9f75..bf7bfd9 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -5,7 +5,9 @@ Version: 0.3.0 Date: 2019-02-14 Authors@R: c( person("Bob", "Rudis", email = "bob@rud.is", role = c("aut", "cre"), - comment = c(ORCID = "0000-0001-5670-2640")) + comment = c(ORCID = "0000-0001-5670-2640")), + person("Derek", "Abdine", comment = "Authentication driver update"), + person("Zachary", "Kurtz", email = "zdkurtz@gmail.com", role = "ctb") ) Maintainer: Bob Rudis Encoding: UTF-8 @@ -31,5 +33,5 @@ Imports: aws.signature RoxygenNote: 6.1.1 Remotes: - hrbrmstr/metis.jars + hrbrmstr/metis-jars VignetteBuilder: knitr diff --git a/R/jdbc.r b/R/jdbc.r index a87fc99..e527069 100644 --- a/R/jdbc.r +++ b/R/jdbc.r @@ -37,7 +37,7 @@ Athena <- function(identifier.quote = '`') { #' AthenaJDBC #' -#' Connect to Athena +#' Connect to Athenadb #' #' Mandatory JDBC connection parameters are also named function #' parameters. You can use `...` to supply additional/optional @@ -64,9 +64,9 @@ Athena <- function(identifier.quote = '`') { #' @param S3OutputLocation A write-able bucket on S3 that you have permissions for #' @param MaxErrorRetry,ConnectTimeout,SocketTimeout #' technical connection info that you should only muck with if you know what you're doing. -#' @param LogPath,LogPath The Athena JDBC driver can (shockingly) provide a decent bit -#' of data in logs. Set this to a temporary directory or something log4j can use. For -#' `LogPath` use the names ("INFO", "DEBUG", "WARN", "ERROR", "ALL", "OFF", "FATAL", "TRACE") or +#' @param LogLevel,LogPath The Athena JDBC driver can provide a decent bit +#' of data in logs. Set this to a temporary directory or something `log4j` can use. For +#' `LogPath` use the names ("`INFO`", "`DEBUG`", "`WARN`", "`ERROR`", "`ALL`", "`OFF`", "`FATAL`", "`TRACE`") or #' their corresponding integer values 0-6. #' @param fetch_size Athena results fetch size #' @param ... passed on to the driver. See Details. @@ -82,7 +82,10 @@ setMethod( drv, Schema = "default", AwsRegion = "us-east-1", - AwsCredentialsProviderClass = "com.simba.athena.amazonaws.auth.DefaultAWSCredentialsProviderChain", + AwsCredentialsProviderClass = paste0(c( + "com", "simba", "athena", "amazonaws","auth", + "DefaultAWSCredentialsProviderChain" + ), collapse = "."), S3OutputLocation = Sys.getenv("AWS_S3_STAGING_DIR", unset = ""), MaxErrorRetry = 10, ConnectTimeout = 10000, diff --git a/man/dbConnect-AthenaDriver-method.Rd b/man/dbConnect-AthenaDriver-method.Rd index 1589624..df5c4e2 100644 --- a/man/dbConnect-AthenaDriver-method.Rd +++ b/man/dbConnect-AthenaDriver-method.Rd @@ -7,8 +7,9 @@ \usage{ \S4method{dbConnect}{AthenaDriver}(drv, Schema = "default", AwsRegion = "us-east-1", - AwsCredentialsProviderClass = "com.simba.athena.amazonaws.auth.DefaultAWSCredentialsProviderChain", - S3OutputLocation = Sys.getenv("AWS_S3_STAGING_DIR", unset = ""), + AwsCredentialsProviderClass = paste0(c("com", "simba", "athena", + "amazonaws", "auth", "DefaultAWSCredentialsProviderChain"), collapse = + "."), S3OutputLocation = Sys.getenv("AWS_S3_STAGING_DIR", unset = ""), MaxErrorRetry = 10, ConnectTimeout = 10000, SocketTimeout = 10000, LogPath = "", LogLevel = 0, fetch_size = 1000L, ...) } @@ -30,9 +31,9 @@ comma-separated list of String arguments.} \item{MaxErrorRetry, ConnectTimeout, SocketTimeout}{technical connection info that you should only muck with if you know what you're doing.} -\item{LogPath, LogPath}{The Athena JDBC driver can (shockingly) provide a decent bit -of data in logs. Set this to a temporary directory or something log4j can use. For -`LogPath` use the names ("INFO", "DEBUG", "WARN", "ERROR", "ALL", "OFF", "FATAL", "TRACE") or +\item{LogLevel, LogPath}{The Athena JDBC driver can provide a decent bit +of data in logs. Set this to a temporary directory or something `log4j` can use. For +`LogPath` use the names ("`INFO`", "`DEBUG`", "`WARN`", "`ERROR`", "`ALL`", "`OFF`", "`FATAL`", "`TRACE`") or their corresponding integer values 0-6.} \item{fetch_size}{Athena results fetch size} @@ -40,7 +41,7 @@ their corresponding integer values 0-6.} \item{...}{passed on to the driver. See Details.} } \description{ -Connect to Athena +Connect to Athenadb } \details{ Mandatory JDBC connection parameters are also named function diff --git a/vignettes/athena-connection-parameters.Rmd b/vignettes/athena-connection-parameters.Rmd index 235b0c3..5b7ac8c 100644 --- a/vignettes/athena-connection-parameters.Rmd +++ b/vignettes/athena-connection-parameters.Rmd @@ -12,7 +12,7 @@ vignette: > ```{r setup, include = FALSE} knitr::opts_chunk$set( collapse = TRUE, - comment = "#>" + comment = "##" ) ```