R/adm_create_connection.R

In thomascrines/admStructuredData: Upload Excel Workbooks to SDR

#' Create ODBC connection to database
#'
#' \code{adm_create_connection} is an internal function to create and open an ODBC database connection.
#'
#' @param database \code{string}. The name of the database to connect to.
#' @param server \code{string}. The name of the server to connect to.
#'
#' @return \code{null}
#'
#' @examples
#'
#' \dontrun {
#' adm_create_connection(database = "DatabaseName", server = "ServerName")
#' }
#'
#' @keywords internal
#'
#' @noRd

adm_create_connection <- function(database, server) {

  tryCatch({

    odbc::dbConnect(odbc::odbc(),
                    Driver = "SQL Server",
                    Trusted_Connection = "True",
                    DATABASE = database,
                    SERVER = server)},

    error = function(cond) {

      stop(paste0("Failed to create connection to database: '", database, "' on server: '", server, "'\nOriginal error message: '", cond, "'"))

    })
}