dbConnect-AthenaDriver-method: AthenaJDBC

In hrbrmstr/metis: Access and Query Amazon Athena via DBI/JDBC

Description

Connect to Athenadb

Usage

## S4 method for signature 'AthenaDriver'
dbConnect(drv, Schema = "default",
  AwsRegion = "us-east-1",
  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, ...)

Arguments

drv	driver
Schema	The name of the database schema to use when a schema is not explicitly specified in a query. You can still issue queries on other schemas by explicitly specifying the schema in the query.
AwsRegion	AWS region the Athena tables are in
AwsCredentialsProviderClass	JDBC auth provider; You can add a lengrh1 character vecrtor named parameter 'AwsCredentialsProviderArguments' to the 'dbConnect()' call to use alternate auth providers. Use a comma-separated list of String arguments.
S3OutputLocation	A write-able bucket on S3 that you have permissions for
MaxErrorRetry, ConnectTimeout, SocketTimeout	technical connection info that you should only muck with if you know what you're doing.
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.
fetch_size	Athena results fetch size
...	passed on to the driver. See Details.

Details

Mandatory JDBC connection parameters are also named function parameters. You can use '...' to supply additional/optional parameters.

Higlighted Extra Driver Configuration Options

These are take from the second item in References. See that resource for more information.

- 'BinaryColumnLength': <int> The maximum data length for 'BINARY' columns. Default '32767L' - 'ComplexTypeColumnLength': <int> The maximum data length for 'ARRAY', 'MAP', and 'STRUCT' columns. Default '65535L' - 'StringColumnLength': <int> The maximum data length for 'STRING' columns. Default '255L'

References

[Connect with JDBC](https://docs.aws.amazon.com/athena/latest/ug/connect-with-jdbc.html); [Simba Athena JDBC Driver with SQL Connector Installation and Configuration Guide](https://s3.amazonaws.com/athena-downloads/drivers/JDBC/SimbaAthenaJDBC_2.0.6/docs/Simba+Athena+JDBC+Driver+Install+and+Configuration+Guide.pdf)

hrbrmstr/metis documentation built on May 23, 2019, 8:37 a.m.