R/deprecated.R

Defines functions check_sqlite_connection chk_fail chk_deparse is_string rws_read_sqlite_table rws_read_sqlite rws_read_sqlite_meta rws_read_sqlite_init rws_read_sqlite_log rws_write_sqlite rws_close_connection rws_open_connection rws_query_sqlite

Documented in check_sqlite_connection rws_close_connection rws_open_connection rws_query_sqlite rws_read_sqlite rws_read_sqlite_init rws_read_sqlite_log rws_read_sqlite_meta rws_read_sqlite_table rws_write_sqlite

#' @export
rws_query_sqlite <- function(query, meta = TRUE, conn) {
  deprecate_warn("0.2.0", "rws_query_sqlite()", "rws_query()")
  rws_query(query, meta = meta, conn = conn)
}

#' @export
rws_open_connection <- function(dbname = "", exists = NA) {
  deprecate_warn("0.2.0", "rws_open_connection()", "rws_connect()")
  rws_connect(dbname = dbname, exists = exists)
}

#' @export
rws_close_connection <- function(conn) {
  deprecate_warn("0.2.0", "rws_close_connection()", "rws_disconnect()")
  rws_disconnect(conn)
}

#' @export
rws_write_sqlite <- function(x, exists = TRUE, delete = FALSE,
                             replace = FALSE,
                             meta = TRUE,
                             log = TRUE,
                             commit = TRUE,
                             strict = TRUE,
                             x_name = substitute(x),
                             silent = getOption("rws.silent", FALSE),
                             conn,
                             ...) {
  deprecate_warn("0.2.0", "rws_write_sqlite()", "rws_write()")
  UseMethod("rws_write")
}

#' @export
rws_read_sqlite_log <- function(conn) {
  deprecate_warn("0.2.0", "rws_read_sqlite_log()", "rws_read_log()")
  rws_read_log(conn)
}

#' @export
rws_read_sqlite_init <- function(conn) {
  deprecate_warn("0.2.0", "rws_read_sqlite_init()", "rws_read_init()")
  rws_read_init(conn)
}

#' @export
rws_read_sqlite_meta <- function(conn) {
  deprecate_warn("0.2.0", "rws_read_sqlite_meta()", "rws_read_meta()")
  rws_read_meta(conn)
}

#' @export
rws_read_sqlite <- function(x, ...) {
  deprecate_warn("0.2.0", "rws_read_sqlite()", "rws_read()")
  UseMethod("rws_read")
}

#' @export
rws_read_sqlite_table <- function(x, meta = TRUE, conn) {
  deprecate_warn("0.2.0", "rws_read_sqlite_table()", "rws_read_table()")
  rws_read_table(x, meta = meta, conn = conn)
}

is_string <- function(x) (is.character(x) || is.factor(x)) && length(x) == 1 && !is.na(x)

chk_deparse <- function(x) {
  if (!is.character(x)) {
    x <- deparse(x)
  }
  if (vld_true(is.na(x))) {
    x <- "NA"
  }
  if (!is_string(x)) {
    err(substitute(x), " must be a string")
  }
  x
}

chk_fail <- function(..., error) {
  if (missing(error) || vld_true(error)) {
    err(...)
  }
  wrn(...)
}

#' @describeIn chk_sqlite_conn Check SQLite Connection
#' @param error A flag specifying whether to through an error if the check fails.
#'
#' @export
check_sqlite_connection <- function(x, connected = NA, x_name = substitute(x), error = TRUE) {
  deprecate_warn("0.2.0", "check_sqlite_connection()", "chk_sqlite_conn()")

  x_name <- chk_deparse(x_name)
  chk_lgl(connected)
  chk_flag(error)
  chk_s4_class(x, "SQLiteConnection", x_name = x_name)
  if (vld_true(connected) && !dbIsValid(x)) {
    chk_fail(x_name, " must be connected", error = error)
  } else if (vld_false(connected) && dbIsValid(x)) {
    chk_fail(x_name, " must be disconnected", error = error)
  }
  invisible(x)
}
poissonconsulting/readwritesqlite documentation built on Oct. 17, 2022, 7:20 p.m.