~hrbrmstr/sergeant

f4c1bdc4e2aa60063b9b22fef5034737cc5c9624 — hrbrmstr 2 years ago 7584021
Added roxygen comments to help group functions by API family to help clarify what does what (ref #22)
M R/custom.r => R/custom.r +1 -0
@@ 73,6 73,7 @@
#' as well.
#'
#' @md
#' @family Drill REST `dplyr` API
#' @name drill_custom_functions
NULL


M R/dbi.r => R/dbi.r +13 -0
@@ 3,6 3,7 @@ s_head <- purrr::safely(httr::HEAD)
#' Driver for Drill database.
#'
#' @keywords internal
#' @family Drill REST DBI API
#' @export
setClass(
  "DrillDriver",


@@ 14,6 15,7 @@ setClass(
#' @rdname DrilDriver-class
#' @param drv driver
#' @param ... Extra optional parameters
#' @family Drill REST DBI API
#' @export
setMethod(
  "dbUnloadDriver",


@@ 27,6 29,7 @@ setMethod("show", "DrillDriver", function(object) {

#' Drill
#'
#' @family Drill REST DBI API
#' @export
Drill <- function() {
  new("DrillDriver")


@@ 58,6 61,7 @@ setClass(
#' @param ssl use ssl?
#' @param username,password credentials
#' @param ... Extra optional parameters
#' @family Drill REST DBI API
#' @export
setMethod(
  "dbConnect",


@@ 122,6 126,7 @@ cmake_server <- function(conn) {
#' @param conn connection
#' @param statement SQL statement
#' @param ... passed on to methods
#' @family Drill REST DBI API
#' @aliases dbSendQuery,DrillConnection,character-method
setMethod(
  "dbSendQuery",


@@ 138,6 143,7 @@ setMethod(
#' Clear
#'
#' @rdname DrillResult-class
#' @family Drill REST DBI API
#' @export
setMethod(
  "dbClearResult",


@@ 149,6 155,7 @@ setMethod(
#'
#' @rdname DrillResult-class
#' @param .progress show data transfer progress?
#' @family Drill REST DBI API
#' @export
setMethod(
  "dbFetch",


@@ 200,6 207,7 @@ setMethod(
#' @param dbObj A \code{\linkS4class{DrillDriver}} object
#' @param obj Any R object
#' @param ... Extra optional parameters
#' @family Drill REST DBI API
#' @export
setMethod(
  "dbDataType",


@@ 218,6 226,7 @@ setMethod(
#' Completed
#'
#' @rdname DrillResult-class
#' @family Drill REST DBI API
#' @export
setMethod(
  "dbHasCompleted",


@@ 226,6 235,7 @@ setMethod(
)

#' @rdname DrillConnection-class
#' @family Drill REST DBI API
#' @export
setMethod(
  'dbIsValid',


@@ 237,6 247,7 @@ setMethod(
)

#' @rdname DrillConnection-class
#' @family Drill REST DBI API
#' @export
setMethod(
  'dbListFields',


@@ 248,6 259,7 @@ setMethod(
)

#' @rdname DrillResult-class
#' @family Drill REST DBI API
#' @export
setMethod(
  'dbListFields',


@@ 268,6 280,7 @@ setMethod(
#' Statement
#'
#' @rdname DrillResult-class
#' @family Drill REST DBI API
#' @export
setMethod(
  'dbGetStatement',

M R/dplyr.r => R/dplyr.r +3 -0
@@ 9,6 9,7 @@
#' @param host Drill host (will pick up the value from \code{DRILL_HOST} env var)
#' @param port Drill port (will pick up the value from \code{DRILL_PORT} env var)
#' @param ssl use ssl?
#' @family Drill REST `dplyr` API
#' @param username,password if not `NULL` the credentials for the Drill service.
#' @note This is a DBI wrapper around the Drill REST API.
#' @export


@@ 78,6 79,7 @@ src_drill <- function(host  = Sys.getenv("DRILL_HOST", "localhost"),
#'
#' @rdname src_tbls
#' @param x x
#' @family Drill REST `dplyr` API
#' @export
src_tbls.src_drill <- function(x) {
  tmp <- dbGetQuery(x$con, "SHOW DATABASES")


@@ 115,6 117,7 @@ copy_to.src_drill <- function(dest, df, name, overwrite, ...) {
#' @rdname src_drill
#' @param src A Drill "src" created with \code{src_drill()}
#' @param from A Drill view or table specification
#' @family Drill REST `dplyr` API
#' @param ... Extra parameters
#' @export
tbl.src_drill <- function(src, from, ...) {

M R/jdbc.r => R/jdbc.r +7 -0
@@ 38,6 38,7 @@ setClass(
#' you, but you can specify the full JDBC connection string
#'
#' @md
#' @family Drill JDBC API
#' @param drv what you get back from [DrillJDBC()]
#' @param url your Drill connection strinfg
#' @param user,password username & password (leave as-is for no-auth)


@@ 98,6 99,7 @@ setMethod(
#' @param dbObj A \code{\linkS4class{DrillJDBCDriver}} object
#' @param obj Any R object
#' @param ... Extra optional parameters
#' @family Drill JDBC API
#' @export
setMethod(
  "dbDataType",


@@ 116,6 118,7 @@ setMethod(

#' Drill's JDBC driver main class loader
#'
#' @family Drill JDBC API
#' @export
DrillJDBC <- function() {



@@ 161,6 164,7 @@ DrillJDBC <- function() {
#' @param schema an optional schema name to append to the JDBC connection string
#' @param use_zk are you connecting to a ZooKeeper instance (default: \code{TRUE}) or
#'               connecting to an individual DrillBit.
#' @family Drill JDBC API
#' @return a JDBC connection object
#' @references \url{https://drill.apache.org/docs/using-the-jdbc-driver/#using-the-jdbc-url-for-a-random-drillbit-connection}
#' @export


@@ 207,6 211,7 @@ drill_jdbc <- function(nodes = "localhost:2181", cluster_id = NULL,
}

#' @rdname drill_jdbc
#' @family Drill JDBC API
#' @export
src_drill_jdbc <- function(nodes = "localhost:2181", cluster_id = NULL,
                           schema = NULL, use_zk = TRUE) {


@@ 220,6 225,7 @@ src_drill_jdbc <- function(nodes = "localhost:2181", cluster_id = NULL,
#' @param src A Drill "src" created with \code{src_drill()}
#' @param from A Drill view or table specification
#' @param ... Extra parameters
#' @family Drill JDBC API
#' @export
tbl.src_drill_jdbc <- function(src, from, ...) {
  tbl_sql("drill_jdbc", src=src, from=from, ...)


@@ 409,6 415,7 @@ sql_translate_env.DrillJDBCConnection <- function(con) {
#' "SHOW DATABASES"
#'
#' @rdname drill_jdbc_internals
#' @family Drill JDBC API
#' @keywords internal
#' @param x x
#' @export

M R/query.r => R/query.r +1 -0
@@ 15,6 15,7 @@
#' @param .progress if \code{TRUE} (default if in an interactive session) then ask
#'                  \code{httr::POST} to display a progress bar
#' @references \href{https://drill.apache.org/docs/}{Drill documentation}
#' @family Dill direct REST API Interface
#' @export
#' @examples \dontrun{
#' drill_connection() %>%

M R/schemas.R => R/schemas.R +3 -0
@@ 2,6 2,7 @@
#'
#' @param drill_con drill server connection object setup by \code{drill_connection()}
#' @references \href{https://drill.apache.org/docs/}{Drill documentation}
#' @family Dill direct REST API Interface
#' @export
drill_show_schemas <- function(drill_con) {
  drill_query(drill_con, "SHOW SCHEMAS")


@@ 13,6 14,7 @@ drill_show_schemas <- function(drill_con) {
#' @param schema_name A unique name for a Drill schema. A schema in Drill is a configured
#'                   storage plugin, such as hive, or a storage plugin and workspace.
#' @references \href{https://drill.apache.org/docs/}{Drill documentation}
#' @family Dill direct REST API Interface
#' @export
drill_use <- function(drill_con, schema_name) {
  query <- sprintf("USE `%s`", schema_name)


@@ 27,6 29,7 @@ drill_use <- function(drill_con, schema_name) {
#' @param schema_spec properly quoted "filesystem.directory_name" reference path
#' @export
#' @references \href{https://drill.apache.org/docs/}{Drill documentation}
#' @family Dill direct REST API Interface
#' @examples \dontrun{
#' drill_connection() %>% drill_show_files("dfs.tmp")
#' }

M R/sergeant.r => R/sergeant.r +15 -1
@@ 10,6 10,7 @@ s_head <- purrr::safely(httr::HEAD)
#' @note If `user`/`password` are set this function will make a `POST` to the REST
#'       interface immediately to prime the cookie-jar with the session id.
#' @export
#' @family Dill direct REST API Interface
#' @examples
#' dc <- drill_connection()
drill_connection <- function(host=Sys.getenv("DRILL_HOST", "localhost"),


@@ 33,12 34,13 @@ drill_connection <- function(host=Sys.getenv("DRILL_HOST", "localhost"),

}

#' Test whether Drill HTTP REST API server is up
#' Test whether Drill HTTP Dill direct REST API Interface server is up
#'
#' This is a very simple test (performs \code{HEAD /} request on the Drill server/cluster)
#'
#' @param drill_con drill server connection object setup by \code{drill_connection()}
#' @export
#' @family Dill direct REST API Interface
#' @examples \dontrun{
#' drill_connection() %>% drill_active()
#' }


@@ 52,6 54,7 @@ drill_active <- function(drill_con) {
#' @note The output of this is in a "viewer" window
#' @param drill_con drill server connection object setup by \code{drill_connection()}
#' @export
#' @family Dill direct REST API Interface
#' @examples \dontrun{
#' drill_connection() %>% drill_status()
#' }


@@ 68,6 71,7 @@ drill_status <- function(drill_con) {
#'
#' @param drill_con drill server connection object setup by \code{drill_connection()}
#' @export
#' @family Dill direct REST API Interface
#' @examples \dontrun{
#' drill_connection() %>% drill_metrics()
#' }


@@ 84,6 88,7 @@ drill_metrics <- function(drill_con) {
#' @note The output of this is in a "viewer" window
#' @param drill_con drill server connection object setup by \code{drill_connection()}
#' @export
#' @family Dill direct REST API Interface
#' @examples \dontrun{
#' drill_connection() %>% drill_threads()
#' }


@@ 101,6 106,7 @@ drill_threads <- function(drill_con) {
#' @param drill_con drill server connection object setup by \code{drill_connection()}
#' @export
#' @references \href{https://drill.apache.org/docs/}{Drill documentation}
#' @family Dill direct REST API Interface
#' @examples \dontrun{
#' drill_connection() %>% drill_profiles()
#' }


@@ 117,6 123,7 @@ drill_profiles <- function(drill_con) {
#' @param drill_con drill server connection object setup by \code{drill_connection()}
#' @param query_id UUID of the query in standard UUID format that Drill assigns to each query
#' @references \href{https://drill.apache.org/docs/}{Drill documentation}
#' @family Dill direct REST API Interface
#' @export
drill_profile <- function(drill_con, query_id) {
  drill_server <- make_server(drill_con)


@@ 131,6 138,7 @@ drill_profile <- function(drill_con, query_id) {
#' @param drill_con drill server connection object setup by \code{drill_connection()}
#' @param query_id the UUID of the query in standard UUID format that Drill assigns to each query.
#' @references \href{https://drill.apache.org/docs/}{Drill documentation}
#' @family Dill direct REST API Interface
#' @export
drill_cancel <- function(drill_con, query_id) {
  drill_server <- make_server(drill_con)


@@ 146,6 154,7 @@ drill_cancel <- function(drill_con, query_id) {
#' @param plugin the assigned name in the storage plugin definition.
#' @references \href{https://drill.apache.org/docs/}{Drill documentation}
#' @export
#' @family Dill direct REST API Interface
#' @examples \dontrun{
#' drill_connection() %>% drill_storage()
#'


@@ 194,6 203,7 @@ drill_storage <- function(drill_con, plugin=NULL) {
#' @param name name of the storage plugin configuration to create/update/remove
#' @param config a `list` or raw character, valid JSON of a complete storage
#'        spec
#' @family Dill direct REST API Interface
#' @export
drill_mod_storage <- function(drill_con, name, config) {



@@ 214,6 224,7 @@ drill_mod_storage <- function(drill_con, name, config) {

#' @md
#' @rdname drill_storage
#' @family Dill direct REST API Interface
#' @export
drill_rm_storage <- function(drill_con, name) {



@@ 236,6 247,7 @@ drill_rm_storage <- function(drill_con, name) {
#' @param drill_con drill server connection object setup by \code{drill_connection()}
#' @param pattern pattern to filter results by
#' @export
#' @family Dill direct REST API Interface
#' @references \href{https://drill.apache.org/docs/}{Drill documentation}
#' @examples \dontrun{
#' drill_connection() %>% drill_options()


@@ 255,6 267,7 @@ drill_options <- function(drill_con, pattern=NULL) {
#'
#' @param drill_con drill server connection object setup by \code{drill_connection()}
#' @export
#' @family Dill direct REST API Interface
#' @references \href{https://drill.apache.org/docs/}{Drill documentation}
#' @examples \dontrun{
#' drill_connection() %>% drill_stats()


@@ 271,6 284,7 @@ drill_stats <- function(drill_con) {
#'
#' @param drill_con drill server connection object setup by \code{drill_connection()}
#' @export
#' @family Dill direct REST API Interface
#' @references \href{https://drill.apache.org/docs/}{Drill documentation}
#' @examples \dontrun{
#' drill_connection() %>% drill_version()

M R/set.R => R/set.R +3 -0
@@ 12,6 12,7 @@
#' @return a \code{tbl} (invisibly) with the \code{ALTER} queries sent and results, including errors.
#' @references \href{https://drill.apache.org/docs/}{Drill documentation}
#' @export
#' @family Dill direct REST API Interface
#' @examples \dontrun{
#' drill_connection() %>%
#'   drill_set(exec.errors.verbose=TRUE, store.format="parquet", web.logs.max_lines=20000)


@@ 54,6 55,7 @@ drill_set <- function(drill_con, ..., type=c("session", "system")) {
#' @param drill_con drill server connection object setup by \code{drill_connection()}
#' @param ... bare name of system options to reset
#' @param all if \code{TRUE}, all parameters are reset (\code{...} is ignored)
#' @family Dill direct REST API Interface
#' @references \href{https://drill.apache.org/docs/}{Drill documentation}
#' @export
#' @examples \dontrun{


@@ 96,6 98,7 @@ drill_system_reset <- function(drill_con, ..., all=FALSE) {
#' @param drill_con drill server connection object setup by \code{drill_connection()}
#' @param ... bare name of system options to reset
#' @references \href{https://drill.apache.org/docs/}{Drill documentation}
#' @family Dill direct REST API Interface
#' @export
#' @examples \dontrun{
#' drill_connection() %>% drill_settings_reset(exec.errors.verbose)

M man/DrilDriver-class.Rd => man/DrilDriver-class.Rd +7 -0
@@ 15,3 15,10 @@
\description{
Unload driver
}
\seealso{
Other Drill REST DBI API: \code{\link{DrillConnection-class}},
  \code{\link{DrillDriver-class}},
  \code{\link{DrillResult-class}}, \code{\link{Drill}},
  \code{\link{dbDataType,DrillConnection-method}}
}
\concept{Drill REST DBI API}

M man/Drill.Rd => man/Drill.Rd +14 -0
@@ 29,3 29,17 @@ Drill

Connect to Drill
}
\seealso{
Other Drill REST DBI API: \code{\link{DrillConnection-class}},
  \code{\link{DrillDriver-class}},
  \code{\link{DrillResult-class}},
  \code{\link{dbDataType,DrillConnection-method}},
  \code{\link{dbUnloadDriver,DrillDriver-method}}

Other Drill REST DBI API: \code{\link{DrillConnection-class}},
  \code{\link{DrillDriver-class}},
  \code{\link{DrillResult-class}},
  \code{\link{dbDataType,DrillConnection-method}},
  \code{\link{dbUnloadDriver,DrillDriver-method}}
}
\concept{Drill REST DBI API}

M man/DrillConnection-class.Rd => man/DrillConnection-class.Rd +17 -0
@@ 27,4 27,21 @@ Drill connection class.

Send a query to Drill
}
\seealso{
Other Drill REST DBI API: \code{\link{DrillDriver-class}},
  \code{\link{DrillResult-class}}, \code{\link{Drill}},
  \code{\link{dbDataType,DrillConnection-method}},
  \code{\link{dbUnloadDriver,DrillDriver-method}}

Other Drill REST DBI API: \code{\link{DrillDriver-class}},
  \code{\link{DrillResult-class}}, \code{\link{Drill}},
  \code{\link{dbDataType,DrillConnection-method}},
  \code{\link{dbUnloadDriver,DrillDriver-method}}

Other Drill REST DBI API: \code{\link{DrillDriver-class}},
  \code{\link{DrillResult-class}}, \code{\link{Drill}},
  \code{\link{dbDataType,DrillConnection-method}},
  \code{\link{dbUnloadDriver,DrillDriver-method}}
}
\concept{Drill REST DBI API}
\keyword{internal}

M man/DrillDriver-class.Rd => man/DrillDriver-class.Rd +7 -0
@@ 7,4 7,11 @@
\description{
Driver for Drill database.
}
\seealso{
Other Drill REST DBI API: \code{\link{DrillConnection-class}},
  \code{\link{DrillResult-class}}, \code{\link{Drill}},
  \code{\link{dbDataType,DrillConnection-method}},
  \code{\link{dbUnloadDriver,DrillDriver-method}}
}
\concept{Drill REST DBI API}
\keyword{internal}

M man/DrillJDBC.Rd => man/DrillJDBC.Rd +7 -0
@@ 9,3 9,10 @@ DrillJDBC()
\description{
Drill's JDBC driver main class loader
}
\seealso{
Other Drill JDBC API: \code{\link{dbConnect,DrillJDBCDriver-method}},
  \code{\link{dbDataType,DrillJDBCConnection-method}},
  \code{\link{db_data_type.DrillJDBCConnection}},
  \code{\link{drill_jdbc}}
}
\concept{Drill JDBC API}

M man/DrillResult-class.Rd => man/DrillResult-class.Rd +27 -0
@@ 34,4 34,31 @@ Completed

Statement
}
\seealso{
Other Drill REST DBI API: \code{\link{DrillConnection-class}},
  \code{\link{DrillDriver-class}}, \code{\link{Drill}},
  \code{\link{dbDataType,DrillConnection-method}},
  \code{\link{dbUnloadDriver,DrillDriver-method}}

Other Drill REST DBI API: \code{\link{DrillConnection-class}},
  \code{\link{DrillDriver-class}}, \code{\link{Drill}},
  \code{\link{dbDataType,DrillConnection-method}},
  \code{\link{dbUnloadDriver,DrillDriver-method}}

Other Drill REST DBI API: \code{\link{DrillConnection-class}},
  \code{\link{DrillDriver-class}}, \code{\link{Drill}},
  \code{\link{dbDataType,DrillConnection-method}},
  \code{\link{dbUnloadDriver,DrillDriver-method}}

Other Drill REST DBI API: \code{\link{DrillConnection-class}},
  \code{\link{DrillDriver-class}}, \code{\link{Drill}},
  \code{\link{dbDataType,DrillConnection-method}},
  \code{\link{dbUnloadDriver,DrillDriver-method}}

Other Drill REST DBI API: \code{\link{DrillConnection-class}},
  \code{\link{DrillDriver-class}}, \code{\link{Drill}},
  \code{\link{dbDataType,DrillConnection-method}},
  \code{\link{dbUnloadDriver,DrillDriver-method}}
}
\concept{Drill REST DBI API}
\keyword{internal}

M man/dbConnect-DrillJDBCDriver-method.Rd => man/dbConnect-DrillJDBCDriver-method.Rd +7 -0
@@ 22,3 22,10 @@
You should really use \code{\link[=drill_jdbc]{drill_jdbc()}} as it handles some cruft for
you, but you can specify the full JDBC connection string
}
\seealso{
Other Drill JDBC API: \code{\link{DrillJDBC}},
  \code{\link{dbDataType,DrillJDBCConnection-method}},
  \code{\link{db_data_type.DrillJDBCConnection}},
  \code{\link{drill_jdbc}}
}
\concept{Drill JDBC API}

M man/dbDataType-DrillConnection-method.Rd => man/dbDataType-DrillConnection-method.Rd +7 -0
@@ 17,3 17,10 @@
\description{
Drill dbDataType
}
\seealso{
Other Drill REST DBI API: \code{\link{DrillConnection-class}},
  \code{\link{DrillDriver-class}},
  \code{\link{DrillResult-class}}, \code{\link{Drill}},
  \code{\link{dbUnloadDriver,DrillDriver-method}}
}
\concept{Drill REST DBI API}

M man/dbDataType-DrillJDBCConnection-method.Rd => man/dbDataType-DrillJDBCConnection-method.Rd +7 -0
@@ 17,3 17,10 @@
\description{
Drill JDBC dbDataType
}
\seealso{
Other Drill JDBC API: \code{\link{DrillJDBC}},
  \code{\link{dbConnect,DrillJDBCDriver-method}},
  \code{\link{db_data_type.DrillJDBCConnection}},
  \code{\link{drill_jdbc}}
}
\concept{Drill JDBC API}

M man/drill_active.Rd => man/drill_active.Rd +17 -1
@@ 2,7 2,7 @@
% Please edit documentation in R/sergeant.r
\name{drill_active}
\alias{drill_active}
\title{Test whether Drill HTTP REST API server is up}
\title{Test whether Drill HTTP Dill direct REST API Interface server is up}
\usage{
drill_active(drill_con)
}


@@ 17,3 17,19 @@ This is a very simple test (performs \code{HEAD /} request on the Drill server/c
drill_connection() \%>\% drill_active()
}
}
\seealso{
Other Dill direct REST API Interface: \code{\link{drill_cancel}},
  \code{\link{drill_connection}},
  \code{\link{drill_metrics}}, \code{\link{drill_options}},
  \code{\link{drill_profiles}},
  \code{\link{drill_profile}}, \code{\link{drill_query}},
  \code{\link{drill_settings_reset}},
  \code{\link{drill_set}}, \code{\link{drill_show_files}},
  \code{\link{drill_show_schemas}},
  \code{\link{drill_stats}}, \code{\link{drill_status}},
  \code{\link{drill_storage}},
  \code{\link{drill_system_reset}},
  \code{\link{drill_threads}}, \code{\link{drill_use}},
  \code{\link{drill_version}}
}
\concept{Dill direct REST API Interface}

M man/drill_cancel.Rd => man/drill_cancel.Rd +16 -0
@@ 17,3 17,19 @@ Cancel the query that has the given queryid
\references{
\href{https://drill.apache.org/docs/}{Drill documentation}
}
\seealso{
Other Dill direct REST API Interface: \code{\link{drill_active}},
  \code{\link{drill_connection}},
  \code{\link{drill_metrics}}, \code{\link{drill_options}},
  \code{\link{drill_profiles}},
  \code{\link{drill_profile}}, \code{\link{drill_query}},
  \code{\link{drill_settings_reset}},
  \code{\link{drill_set}}, \code{\link{drill_show_files}},
  \code{\link{drill_show_schemas}},
  \code{\link{drill_stats}}, \code{\link{drill_status}},
  \code{\link{drill_storage}},
  \code{\link{drill_system_reset}},
  \code{\link{drill_threads}}, \code{\link{drill_use}},
  \code{\link{drill_version}}
}
\concept{Dill direct REST API Interface}

M man/drill_connection.Rd => man/drill_connection.Rd +16 -0
@@ 28,3 28,19 @@ interface immediately to prime the cookie-jar with the session id.
\examples{
dc <- drill_connection()
}
\seealso{
Other Dill direct REST API Interface: \code{\link{drill_active}},
  \code{\link{drill_cancel}}, \code{\link{drill_metrics}},
  \code{\link{drill_options}},
  \code{\link{drill_profiles}},
  \code{\link{drill_profile}}, \code{\link{drill_query}},
  \code{\link{drill_settings_reset}},
  \code{\link{drill_set}}, \code{\link{drill_show_files}},
  \code{\link{drill_show_schemas}},
  \code{\link{drill_stats}}, \code{\link{drill_status}},
  \code{\link{drill_storage}},
  \code{\link{drill_system_reset}},
  \code{\link{drill_threads}}, \code{\link{drill_use}},
  \code{\link{drill_version}}
}
\concept{Dill direct REST API Interface}

M man/drill_custom_functions.Rd => man/drill_custom_functions.Rd +5 -0
@@ 78,3 78,8 @@ You can get a compact list of these with:

as well.
}
\seealso{
Other Drill REST `dplyr` API: \code{\link{src_drill}},
  \code{\link{src_tbls.src_drill}}
}
\concept{Drill REST `dplyr` API}

M man/drill_jdbc.Rd => man/drill_jdbc.Rd +17 -0
@@ 60,3 60,20 @@ con <- drill_jdbc("localhost:31010", use_zk=FALSE)
\references{
\url{https://drill.apache.org/docs/using-the-jdbc-driver/#using-the-jdbc-url-for-a-random-drillbit-connection}
}
\seealso{
Other Drill JDBC API: \code{\link{DrillJDBC}},
  \code{\link{dbConnect,DrillJDBCDriver-method}},
  \code{\link{dbDataType,DrillJDBCConnection-method}},
  \code{\link{db_data_type.DrillJDBCConnection}}

Other Drill JDBC API: \code{\link{DrillJDBC}},
  \code{\link{dbConnect,DrillJDBCDriver-method}},
  \code{\link{dbDataType,DrillJDBCConnection-method}},
  \code{\link{db_data_type.DrillJDBCConnection}}

Other Drill JDBC API: \code{\link{DrillJDBC}},
  \code{\link{dbConnect,DrillJDBCDriver-method}},
  \code{\link{dbDataType,DrillJDBCConnection-method}},
  \code{\link{db_data_type.DrillJDBCConnection}}
}
\concept{Drill JDBC API}

M man/drill_jdbc_internals.Rd => man/drill_jdbc_internals.Rd +7 -0
@@ 30,4 30,11 @@
\description{
"SHOW DATABASES"
}
\seealso{
Other Drill JDBC API: \code{\link{DrillJDBC}},
  \code{\link{dbConnect,DrillJDBCDriver-method}},
  \code{\link{dbDataType,DrillJDBCConnection-method}},
  \code{\link{drill_jdbc}}
}
\concept{Drill JDBC API}
\keyword{internal}

M man/drill_metrics.Rd => man/drill_metrics.Rd +17 -0
@@ 17,3 17,20 @@ Get the current memory metrics
drill_connection() \%>\% drill_metrics()
}
}
\seealso{
Other Dill direct REST API Interface: \code{\link{drill_active}},
  \code{\link{drill_cancel}},
  \code{\link{drill_connection}},
  \code{\link{drill_options}},
  \code{\link{drill_profiles}},
  \code{\link{drill_profile}}, \code{\link{drill_query}},
  \code{\link{drill_settings_reset}},
  \code{\link{drill_set}}, \code{\link{drill_show_files}},
  \code{\link{drill_show_schemas}},
  \code{\link{drill_stats}}, \code{\link{drill_status}},
  \code{\link{drill_storage}},
  \code{\link{drill_system_reset}},
  \code{\link{drill_threads}}, \code{\link{drill_use}},
  \code{\link{drill_version}}
}
\concept{Dill direct REST API Interface}

M man/drill_options.Rd => man/drill_options.Rd +17 -0
@@ 22,3 22,20 @@ drill_connection() \%>\% drill_options()
\references{
\href{https://drill.apache.org/docs/}{Drill documentation}
}
\seealso{
Other Dill direct REST API Interface: \code{\link{drill_active}},
  \code{\link{drill_cancel}},
  \code{\link{drill_connection}},
  \code{\link{drill_metrics}},
  \code{\link{drill_profiles}},
  \code{\link{drill_profile}}, \code{\link{drill_query}},
  \code{\link{drill_settings_reset}},
  \code{\link{drill_set}}, \code{\link{drill_show_files}},
  \code{\link{drill_show_schemas}},
  \code{\link{drill_stats}}, \code{\link{drill_status}},
  \code{\link{drill_storage}},
  \code{\link{drill_system_reset}},
  \code{\link{drill_threads}}, \code{\link{drill_use}},
  \code{\link{drill_version}}
}
\concept{Dill direct REST API Interface}

M man/drill_profile.Rd => man/drill_profile.Rd +16 -0
@@ 17,3 17,19 @@ Get the profile of the query that has the given queryid
\references{
\href{https://drill.apache.org/docs/}{Drill documentation}
}
\seealso{
Other Dill direct REST API Interface: \code{\link{drill_active}},
  \code{\link{drill_cancel}},
  \code{\link{drill_connection}},
  \code{\link{drill_metrics}}, \code{\link{drill_options}},
  \code{\link{drill_profiles}}, \code{\link{drill_query}},
  \code{\link{drill_settings_reset}},
  \code{\link{drill_set}}, \code{\link{drill_show_files}},
  \code{\link{drill_show_schemas}},
  \code{\link{drill_stats}}, \code{\link{drill_status}},
  \code{\link{drill_storage}},
  \code{\link{drill_system_reset}},
  \code{\link{drill_threads}}, \code{\link{drill_use}},
  \code{\link{drill_version}}
}
\concept{Dill direct REST API Interface}

M man/drill_profiles.Rd => man/drill_profiles.Rd +16 -0
@@ 20,3 20,19 @@ drill_connection() \%>\% drill_profiles()
\references{
\href{https://drill.apache.org/docs/}{Drill documentation}
}
\seealso{
Other Dill direct REST API Interface: \code{\link{drill_active}},
  \code{\link{drill_cancel}},
  \code{\link{drill_connection}},
  \code{\link{drill_metrics}}, \code{\link{drill_options}},
  \code{\link{drill_profile}}, \code{\link{drill_query}},
  \code{\link{drill_settings_reset}},
  \code{\link{drill_set}}, \code{\link{drill_show_files}},
  \code{\link{drill_show_schemas}},
  \code{\link{drill_stats}}, \code{\link{drill_status}},
  \code{\link{drill_storage}},
  \code{\link{drill_system_reset}},
  \code{\link{drill_threads}}, \code{\link{drill_use}},
  \code{\link{drill_version}}
}
\concept{Dill direct REST API Interface}

M man/drill_query.Rd => man/drill_query.Rd +17 -0
@@ 35,3 35,20 @@ drill_connection() \%>\%
\references{
\href{https://drill.apache.org/docs/}{Drill documentation}
}
\seealso{
Other Dill direct REST API Interface: \code{\link{drill_active}},
  \code{\link{drill_cancel}},
  \code{\link{drill_connection}},
  \code{\link{drill_metrics}}, \code{\link{drill_options}},
  \code{\link{drill_profiles}},
  \code{\link{drill_profile}},
  \code{\link{drill_settings_reset}},
  \code{\link{drill_set}}, \code{\link{drill_show_files}},
  \code{\link{drill_show_schemas}},
  \code{\link{drill_stats}}, \code{\link{drill_status}},
  \code{\link{drill_storage}},
  \code{\link{drill_system_reset}},
  \code{\link{drill_threads}}, \code{\link{drill_use}},
  \code{\link{drill_version}}
}
\concept{Dill direct REST API Interface}

M man/drill_set.Rd => man/drill_set.Rd +17 -0
@@ 33,3 33,20 @@ drill_connection() \%>\%
\references{
\href{https://drill.apache.org/docs/}{Drill documentation}
}
\seealso{
Other Dill direct REST API Interface: \code{\link{drill_active}},
  \code{\link{drill_cancel}},
  \code{\link{drill_connection}},
  \code{\link{drill_metrics}}, \code{\link{drill_options}},
  \code{\link{drill_profiles}},
  \code{\link{drill_profile}}, \code{\link{drill_query}},
  \code{\link{drill_settings_reset}},
  \code{\link{drill_show_files}},
  \code{\link{drill_show_schemas}},
  \code{\link{drill_stats}}, \code{\link{drill_status}},
  \code{\link{drill_storage}},
  \code{\link{drill_system_reset}},
  \code{\link{drill_threads}}, \code{\link{drill_use}},
  \code{\link{drill_version}}
}
\concept{Dill direct REST API Interface}

M man/drill_settings_reset.Rd => man/drill_settings_reset.Rd +16 -0
@@ 22,3 22,19 @@ drill_connection() \%>\% drill_settings_reset(exec.errors.verbose)
\references{
\href{https://drill.apache.org/docs/}{Drill documentation}
}
\seealso{
Other Dill direct REST API Interface: \code{\link{drill_active}},
  \code{\link{drill_cancel}},
  \code{\link{drill_connection}},
  \code{\link{drill_metrics}}, \code{\link{drill_options}},
  \code{\link{drill_profiles}},
  \code{\link{drill_profile}}, \code{\link{drill_query}},
  \code{\link{drill_set}}, \code{\link{drill_show_files}},
  \code{\link{drill_show_schemas}},
  \code{\link{drill_stats}}, \code{\link{drill_status}},
  \code{\link{drill_storage}},
  \code{\link{drill_system_reset}},
  \code{\link{drill_threads}}, \code{\link{drill_use}},
  \code{\link{drill_version}}
}
\concept{Dill direct REST API Interface}

M man/drill_show_files.Rd => man/drill_show_files.Rd +17 -0
@@ 22,3 22,20 @@ drill_connection() \%>\% drill_show_files("dfs.tmp")
\references{
\href{https://drill.apache.org/docs/}{Drill documentation}
}
\seealso{
Other Dill direct REST API Interface: \code{\link{drill_active}},
  \code{\link{drill_cancel}},
  \code{\link{drill_connection}},
  \code{\link{drill_metrics}}, \code{\link{drill_options}},
  \code{\link{drill_profiles}},
  \code{\link{drill_profile}}, \code{\link{drill_query}},
  \code{\link{drill_settings_reset}},
  \code{\link{drill_set}},
  \code{\link{drill_show_schemas}},
  \code{\link{drill_stats}}, \code{\link{drill_status}},
  \code{\link{drill_storage}},
  \code{\link{drill_system_reset}},
  \code{\link{drill_threads}}, \code{\link{drill_use}},
  \code{\link{drill_version}}
}
\concept{Dill direct REST API Interface}

M man/drill_show_schemas.Rd => man/drill_show_schemas.Rd +16 -0
@@ 15,3 15,19 @@ Returns a list of available schemas.
\references{
\href{https://drill.apache.org/docs/}{Drill documentation}
}
\seealso{
Other Dill direct REST API Interface: \code{\link{drill_active}},
  \code{\link{drill_cancel}},
  \code{\link{drill_connection}},
  \code{\link{drill_metrics}}, \code{\link{drill_options}},
  \code{\link{drill_profiles}},
  \code{\link{drill_profile}}, \code{\link{drill_query}},
  \code{\link{drill_settings_reset}},
  \code{\link{drill_set}}, \code{\link{drill_show_files}},
  \code{\link{drill_stats}}, \code{\link{drill_status}},
  \code{\link{drill_storage}},
  \code{\link{drill_system_reset}},
  \code{\link{drill_threads}}, \code{\link{drill_use}},
  \code{\link{drill_version}}
}
\concept{Dill direct REST API Interface}

M man/drill_stats.Rd => man/drill_stats.Rd +16 -0
@@ 20,3 20,19 @@ drill_connection() \%>\% drill_stats()
\references{
\href{https://drill.apache.org/docs/}{Drill documentation}
}
\seealso{
Other Dill direct REST API Interface: \code{\link{drill_active}},
  \code{\link{drill_cancel}},
  \code{\link{drill_connection}},
  \code{\link{drill_metrics}}, \code{\link{drill_options}},
  \code{\link{drill_profiles}},
  \code{\link{drill_profile}}, \code{\link{drill_query}},
  \code{\link{drill_settings_reset}},
  \code{\link{drill_set}}, \code{\link{drill_show_files}},
  \code{\link{drill_show_schemas}},
  \code{\link{drill_status}}, \code{\link{drill_storage}},
  \code{\link{drill_system_reset}},
  \code{\link{drill_threads}}, \code{\link{drill_use}},
  \code{\link{drill_version}}
}
\concept{Dill direct REST API Interface}

M man/drill_status.Rd => man/drill_status.Rd +16 -0
@@ 20,3 20,19 @@ The output of this is in a "viewer" window
drill_connection() \%>\% drill_status()
}
}
\seealso{
Other Dill direct REST API Interface: \code{\link{drill_active}},
  \code{\link{drill_cancel}},
  \code{\link{drill_connection}},
  \code{\link{drill_metrics}}, \code{\link{drill_options}},
  \code{\link{drill_profiles}},
  \code{\link{drill_profile}}, \code{\link{drill_query}},
  \code{\link{drill_settings_reset}},
  \code{\link{drill_set}}, \code{\link{drill_show_files}},
  \code{\link{drill_show_schemas}},
  \code{\link{drill_stats}}, \code{\link{drill_storage}},
  \code{\link{drill_system_reset}},
  \code{\link{drill_threads}}, \code{\link{drill_use}},
  \code{\link{drill_version}}
}
\concept{Dill direct REST API Interface}

M man/drill_storage.Rd => man/drill_storage.Rd +44 -0
@@ 55,3 55,47 @@ drill_connection() \%>\%
\references{
\href{https://drill.apache.org/docs/}{Drill documentation}
}
\seealso{
Other Dill direct REST API Interface: \code{\link{drill_active}},
  \code{\link{drill_cancel}},
  \code{\link{drill_connection}},
  \code{\link{drill_metrics}}, \code{\link{drill_options}},
  \code{\link{drill_profiles}},
  \code{\link{drill_profile}}, \code{\link{drill_query}},
  \code{\link{drill_settings_reset}},
  \code{\link{drill_set}}, \code{\link{drill_show_files}},
  \code{\link{drill_show_schemas}},
  \code{\link{drill_stats}}, \code{\link{drill_status}},
  \code{\link{drill_system_reset}},
  \code{\link{drill_threads}}, \code{\link{drill_use}},
  \code{\link{drill_version}}

Other Dill direct REST API Interface: \code{\link{drill_active}},
  \code{\link{drill_cancel}},
  \code{\link{drill_connection}},
  \code{\link{drill_metrics}}, \code{\link{drill_options}},
  \code{\link{drill_profiles}},
  \code{\link{drill_profile}}, \code{\link{drill_query}},
  \code{\link{drill_settings_reset}},
  \code{\link{drill_set}}, \code{\link{drill_show_files}},
  \code{\link{drill_show_schemas}},
  \code{\link{drill_stats}}, \code{\link{drill_status}},
  \code{\link{drill_system_reset}},
  \code{\link{drill_threads}}, \code{\link{drill_use}},
  \code{\link{drill_version}}

Other Dill direct REST API Interface: \code{\link{drill_active}},
  \code{\link{drill_cancel}},
  \code{\link{drill_connection}},
  \code{\link{drill_metrics}}, \code{\link{drill_options}},
  \code{\link{drill_profiles}},
  \code{\link{drill_profile}}, \code{\link{drill_query}},
  \code{\link{drill_settings_reset}},
  \code{\link{drill_set}}, \code{\link{drill_show_files}},
  \code{\link{drill_show_schemas}},
  \code{\link{drill_stats}}, \code{\link{drill_status}},
  \code{\link{drill_system_reset}},
  \code{\link{drill_threads}}, \code{\link{drill_use}},
  \code{\link{drill_version}}
}
\concept{Dill direct REST API Interface}

M man/drill_system_reset.Rd => man/drill_system_reset.Rd +15 -0
@@ 24,3 24,18 @@ drill_connection() \%>\% drill_system_reset(all=TRUE)
\references{
\href{https://drill.apache.org/docs/}{Drill documentation}
}
\seealso{
Other Dill direct REST API Interface: \code{\link{drill_active}},
  \code{\link{drill_cancel}},
  \code{\link{drill_connection}},
  \code{\link{drill_metrics}}, \code{\link{drill_options}},
  \code{\link{drill_profiles}},
  \code{\link{drill_profile}}, \code{\link{drill_query}},
  \code{\link{drill_settings_reset}},
  \code{\link{drill_set}}, \code{\link{drill_show_files}},
  \code{\link{drill_show_schemas}},
  \code{\link{drill_stats}}, \code{\link{drill_status}},
  \code{\link{drill_storage}}, \code{\link{drill_threads}},
  \code{\link{drill_use}}, \code{\link{drill_version}}
}
\concept{Dill direct REST API Interface}

M man/drill_threads.Rd => man/drill_threads.Rd +16 -0
@@ 20,3 20,19 @@ The output of this is in a "viewer" window
drill_connection() \%>\% drill_threads()
}
}
\seealso{
Other Dill direct REST API Interface: \code{\link{drill_active}},
  \code{\link{drill_cancel}},
  \code{\link{drill_connection}},
  \code{\link{drill_metrics}}, \code{\link{drill_options}},
  \code{\link{drill_profiles}},
  \code{\link{drill_profile}}, \code{\link{drill_query}},
  \code{\link{drill_settings_reset}},
  \code{\link{drill_set}}, \code{\link{drill_show_files}},
  \code{\link{drill_show_schemas}},
  \code{\link{drill_stats}}, \code{\link{drill_status}},
  \code{\link{drill_storage}},
  \code{\link{drill_system_reset}},
  \code{\link{drill_use}}, \code{\link{drill_version}}
}
\concept{Dill direct REST API Interface}

M man/drill_use.Rd => man/drill_use.Rd +16 -0
@@ 18,3 18,19 @@ Change to a particular schema.
\references{
\href{https://drill.apache.org/docs/}{Drill documentation}
}
\seealso{
Other Dill direct REST API Interface: \code{\link{drill_active}},
  \code{\link{drill_cancel}},
  \code{\link{drill_connection}},
  \code{\link{drill_metrics}}, \code{\link{drill_options}},
  \code{\link{drill_profiles}},
  \code{\link{drill_profile}}, \code{\link{drill_query}},
  \code{\link{drill_settings_reset}},
  \code{\link{drill_set}}, \code{\link{drill_show_files}},
  \code{\link{drill_show_schemas}},
  \code{\link{drill_stats}}, \code{\link{drill_status}},
  \code{\link{drill_storage}},
  \code{\link{drill_system_reset}},
  \code{\link{drill_threads}}, \code{\link{drill_version}}
}
\concept{Dill direct REST API Interface}

M man/drill_version.Rd => man/drill_version.Rd +16 -0
@@ 20,3 20,19 @@ drill_connection() \%>\% drill_version()
\references{
\href{https://drill.apache.org/docs/}{Drill documentation}
}
\seealso{
Other Dill direct REST API Interface: \code{\link{drill_active}},
  \code{\link{drill_cancel}},
  \code{\link{drill_connection}},
  \code{\link{drill_metrics}}, \code{\link{drill_options}},
  \code{\link{drill_profiles}},
  \code{\link{drill_profile}}, \code{\link{drill_query}},
  \code{\link{drill_settings_reset}},
  \code{\link{drill_set}}, \code{\link{drill_show_files}},
  \code{\link{drill_show_schemas}},
  \code{\link{drill_stats}}, \code{\link{drill_status}},
  \code{\link{drill_storage}},
  \code{\link{drill_system_reset}},
  \code{\link{drill_threads}}, \code{\link{drill_use}}
}
\concept{Dill direct REST API Interface}

M man/src_drill.Rd => man/src_drill.Rd +8 -0
@@ 82,3 82,11 @@ select(emp, full_name) \%>\%
## # ... with more rows, and 3 more variables: rpd <chr>, rnd <dbl>, first_three <chr>
}
}
\seealso{
Other Drill REST `dplyr` API: \code{\link{drill_custom_functions}},
  \code{\link{src_tbls.src_drill}}

Other Drill REST `dplyr` API: \code{\link{drill_custom_functions}},
  \code{\link{src_tbls.src_drill}}
}
\concept{Drill REST `dplyr` API}

M man/src_tbls.Rd => man/src_tbls.Rd +5 -0
@@ 33,4 33,9 @@
\description{
"SHOW DATABASES"
}
\seealso{
Other Drill REST `dplyr` API: \code{\link{drill_custom_functions}},
  \code{\link{src_drill}}
}
\concept{Drill REST `dplyr` API}
\keyword{internal}