Executes a statement to return the data description language (DDL) of the Athena table.
dbShow(conn, name, ...)
# S4 method for AthenaConnection
dbShow(conn, name, ...)
A DBIConnection object, as returned by
dbConnect()
.
The table name, passed on to dbQuoteIdentifier()
. Options are:
a character string with the unquoted DBMS table name,
e.g. "table_name"
,
a call to Id()
with components to the fully qualified table name,
e.g. Id(schema = "my_schema", table = "table_name")
a call to SQL()
with the quoted and fully qualified table name
given verbatim, e.g. SQL('"my_schema"."table_name"')
Other parameters passed on to methods.
dbShow()
returns SQL
characters of the Athena table DDL.
if (FALSE) {
# Note:
# - Require AWS Account to run below example.
# - Different connection methods can be used please see `noctua::dbConnect` documnentation
library(DBI)
# Demo connection to Athena using profile name
con <- dbConnect(noctua::athena())
# write iris table to Athena
dbWriteTable(con, "iris",
iris,
partition = c("timestamp" = format(Sys.Date(), "%Y%m%d")),
s3.location = "s3://path/to/store/athena/table/"
)
# return table ddl
noctua::dbShow(con, "iris")
# disconnect from Athena
dbDisconnect(con)
}