R/sergeant-caffeinated-package.R

In hrbrmstr/sergeant-caffeinated: RJDBC Interface for Apache Drill

#' Tools to Transform and Query Data with 'Apache' 'Drill'
#'
#' Drill is an innovative low-latency distributed query engine designed to enable data
#' exploration and analytics on both relational and non-relational datastores, scaling to
#' petabytes of data. Users can query the data using standard SQL and BI tools without
#' having to create and manage schemas. Some of the key features are:
#'
#' \itemize{
#'   \item{Schema-free JSON document model similar to MongoDB and Elasticsearch}
#'   \item{Industry-standard APIs: ANSI SQL, ODBC/JDBC, RESTful APIs}
#'   \item{Extremely user and developer friendly}
#'   \item{Pluggable architecture enables connectivity to multiple datastores}
#' }
#'
#' Drill includes a distributed execution environment, purpose built for large-scale data
#' processing. At the core of Drill is the "Drillbit" service which is responsible for
#' accepting requests from the client, processing the queries, and returning results to
#' the client.
#'
#' You can install and run a drillbit service on one node or on many nodes to form a
#' distributed cluster environment. When a drillbit runs on each data node in a cluster,
#' Drill can maximize data locality during query execution without moving data over the
#' network or between nodes. Drill uses ZooKeeper to maintain cluster membership and health
#' check information.
#'
#' An RDBC interface with a thin set of 'dbplyr` helper functions is provided.
#'
#' @name sergeant.caffeinated
#' @references \href{https://drill.apache.org/docs/}{Drill documentation}
#' @docType package
#' @author Bob Rudis (bob@@rud.is)
#' @import dbplyr DBI
#' @importFrom rJava J .jinit .jnew is.jnull .jaddClassPath .jfindClass .jcheck .jnull .jpackage
#' @importFrom dplyr sql_translate_env
#' @importFrom utils globalVariables
#' @importFrom methods setClass setGeneric setMethod callNextMethod new initialize show
#' @importClassesFrom RJDBC JDBCDriver JDBCConnection JDBCResult
NULL

#' sergeant exported operators
#'
#' The following functions are imported and then re-exported
#' from the sergeant package to enable use of the magrittr
#' pipe operator with no additional library calls
#'
#' @name sergeant-caffeinated-exports
NULL

#' @name %>%
#' @export
#' @rdname sergeant-caffeinated-exports
NULL