R/chk.R

Defines functions chk_sqlite_conn

Documented in chk_sqlite_conn

#' Check SQLite Connection
#'
#' @inheritParams chk::chk_true
#' @param connected A logical scalar specifying whether x should be connected.
#' @return `NULL`, invisibly. Called for the side effect of throwing an error
#'   if the condition is not met.
#'
#' @description
#'
#' `chk_sqlite_conn`
#' checks if a SQLite connection.
#'
#' @export
#'
#' @examples
#' conn <- rws_connect()
#' chk_sqlite_conn(conn)
#' rws_disconnect(conn)
#' try(chk_sqlite_conn(conn, connected = TRUE))
chk_sqlite_conn <- function(x, connected = NA, x_name = NULL) {
  if (vld_sqlite_conn(x, connected)) {
    return(invisible())
  }
  if (is.null(x_name)) x_name <- deparse_backtick_chk(substitute(x))
  # pass x_name when implemented in chkor_vld()
  chkor_vld(vld_s4_class(x, "SQLiteConnection"),
            vld_s3_class(x, "Pool"))
  if (vld_true(connected)) abort_chk(x_name, " must be connected.")
  abort_chk(x_name, " must be disconnected.")
}
poissonconsulting/dbWriteSQLite documentation built on Oct. 20, 2022, 11:06 p.m.