R/transaction.R

In rstats-db/RMySQL: Database Interface and 'MySQL' Driver for R

#' @include connection.R
NULL

#' DBMS Transaction Management
#'
#' Commits or roll backs the current transaction in an MySQL connection.
#' Note that in MySQL DDL statements (e.g. \code{CREATE TABLE}) can not
#' be rolled back.
#'
#' @param conn a \code{MySQLConnection} object, as produced by
#'  \code{\link{dbConnect}}.
#' @param ... Unused.
#' @examples
#' if (mysqlHasDefault()) {
#' con <- dbConnect(RMySQL::MySQL(), dbname = "test")
#' df <- data.frame(id = 1:5)
#'
#' dbWriteTable(con, "df", df)
#' dbBegin(con)
#' dbGetQuery(con, "UPDATE df SET id = id * 10")
#' dbGetQuery(con, "SELECT id FROM df")
#' dbRollback(con)
#'
#' dbGetQuery(con, "SELECT id FROM df")
#'
#' dbRemoveTable(con, "df")
#' dbDisconnect(con)
#' }
#' @name transactions
NULL

#' @export
#' @rdname transactions
setMethod("dbCommit", "MySQLConnection", function(conn, ...) {
  dbGetQuery(conn, "COMMIT")
  TRUE
})

#' @export
#' @rdname transactions
setMethod("dbBegin", "MySQLConnection", function(conn, ...) {
  dbGetQuery(conn, "START TRANSACTION")
  TRUE
})

#' @export
#' @rdname transactions
setMethod("dbRollback", "MySQLConnection", function(conn, ...) {
  dbGetQuery(conn, "ROLLBACK")
  TRUE
})