R/default.R

Defines functions mariadb_default mariadbDefault mariadbHasDefault

Documented in mariadbDefault mariadbHasDefault

#' Check if default database is available.
#'
#' RMariaDB examples and tests connect to a database defined by the
#' `rs-dbi` group in `~/.my.cnf`. This function checks if that
#' database is available, and if not, displays an informative message.
#' `mariadbDefault()` works similarly but throws a testthat skip condition
#' on failure, making it suitable for use in tests.
#'
#' @export
#' @examples
#' if (mariadbHasDefault()) {
#'   db <- dbConnect(RMariaDB::MariaDB(), dbname = "test")
#'   dbListTables(db)
#'   dbDisconnect(db)
#' }
mariadbHasDefault <- function() {
  tryCatch(
    {
      mariadb_default()
      TRUE
    },
    error = function(...) {
      message(
        "Could not initialise default MariaDB database. If MariaDB is running\n",
        "check that you have a ~/.my.cnf file that contains a [rs-dbi] section\n",
        "describing how to connect to a test database."
      )
      FALSE
    })
}

#' @export
#' @rdname mariadbHasDefault
mariadbDefault <- function() {
  tryCatch(
    {
      mariadb_default()
    },
    error = function(...) {
      testthat::skip("Test database not available")
    })
}

mariadb_default <- function(...) {
  dbConnect(MariaDB(), dbname = "test", ...)
}

Try the RMariaDB package in your browser

Any scripts or data that you put into this service are public.

RMariaDB documentation built on Dec. 20, 2021, 9:06 a.m.