R/default_conn.R

In sqlhelper: Easier 'SQL' Integration

#' Return the default connection
#'
#' A convenience wrapper around `live_connection()` and `get_default_conn_name()`
#'
#' @return A database connection returned by `DBI::dbConnect()` or
#'   `pool::dbPool()`
#'
#' @examples
#' library(sqlhelper)
#'
#' connect(
#'     system.file(
#'         "examples/sqlhelper_db_conf.yml",
#'         package="sqlhelper"
#'         ),
#'     exclusive=TRUE
#'    )
#'
#' default_conn()
#' @export
default_conn <- function(){
  live_connection( get_default_conn_name() )
}