sql/transaction.lisp

   1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
   2 ;;;; *************************************************************************
   3 ;;;;
   4 ;;;; $Id$
   5 ;;;;
   6 ;;;; Transaction support
   7 ;;;;
   8 ;;;; This file is part of CLSQL.
   9 ;;;;
  10 ;;;; CLSQL users are granted the rights to distribute and use this software
  11 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
  12 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
  13 ;;;; *************************************************************************
  14
  15 (in-package #:clsql-sys)
  16
  17 (defclass transaction ()
  18   ((commit-hooks :initform () :accessor commit-hooks)
  19    (rollback-hooks :initform () :accessor rollback-hooks)
  20    (status :initform nil :accessor transaction-status))) ; nil or :committed
  21
  22 (defun commit-transaction (database)
  23   (when (and (transaction database)
  24              (not (transaction-status (transaction database))))
  25     (setf (transaction-status (transaction database)) :committed)))
  26
  27 (defun add-transaction-commit-hook (database commit-hook)
  28   (when (transaction database)
  29     (push commit-hook (commit-hooks (transaction database)))))
  30
  31 (defun add-transaction-rollback-hook (database rollback-hook)
  32   (when (transaction database)
  33     (push rollback-hook (rollback-hooks (transaction database)))))
  34
  35 (defmethod database-start-transaction ((database database))
  36   (unless (transaction database)
  37     (setf (transaction database) (make-instance 'transaction)))
  38   (when (= (incf (transaction-level database) 1))
  39     (let ((transaction (transaction database)))
  40       (setf (commit-hooks transaction) nil
  41             (rollback-hooks transaction) nil
  42             (transaction-status transaction) nil)
  43       (execute-command "BEGIN" :database database))))
  44
  45 (defmethod database-commit-transaction ((database database))
  46     (if (> (transaction-level database) 0)
  47         (when (zerop (decf (transaction-level database)))
  48           (execute-command "COMMIT" :database database)
  49           (map nil #'funcall (commit-hooks (transaction database))))
  50         (warn 'clsql-simple-warning
  51               :format-control "Cannot commit transaction against ~A because there is no transaction in progress."
  52               :format-arguments (list database))))
  53
  54 (defmethod database-abort-transaction (database)
  55     (if (> (transaction-level database) 0)
  56         (when (zerop (decf (transaction-level database)))
  57           (unwind-protect
  58                (execute-command "ROLLBACK" :database database)
  59             (map nil #'funcall (rollback-hooks (transaction database)))))
  60         (warn 'clsql-simple-warning
  61               :format-control "Cannot abort transaction against ~A because there is no transaction in progress."
  62               :format-arguments (list database))))
  63
  64
  65 (defmacro with-transaction ((&key (database '*default-database*)) &rest body)
  66   "Starts a transaction in the database specified by DATABASE,
  67 which is *DEFAULT-DATABASE* by default, and executes BODY within
  68 that transaction. If BODY aborts or throws, DATABASE is rolled
  69 back and otherwise the transaction is committed."
  70   (let ((db (gensym "db-")))
  71     `(let ((,db ,database))
  72       (unwind-protect
  73            (progn
  74              (database-start-transaction ,db)
  75              ,@body
  76              (commit-transaction ,db))
  77         (if (eq (transaction-status (transaction ,db)) :committed)
  78             (database-commit-transaction ,db)
  79             (database-abort-transaction ,db))))))
  80
  81 (defun commit (&key (database *default-database*))
  82   "If DATABASE, which defaults to *DEFAULT-DATABASE*, is
  83 currently within the scope of a transaction, commits changes made
  84 since the transaction began."
  85   (database-commit-transaction database))
  86
  87 (defun rollback (&key (database *default-database*))
  88   "If DATABASE, which defaults to *DEFAULT-DATABASE*, is
  89 currently within the scope of a transaction, rolls back changes
  90 made since the transaction began."
  91   (database-abort-transaction database))
  92
  93 (defun start-transaction (&key (database *default-database*))
  94   "Starts a transaction block on DATABASE which defaults to
  95 *DEFAULT-DATABASE* and which continues until ROLLBACK or COMMIT
  96 are called."
  97   (unless (in-transaction-p :database database)
  98     (database-start-transaction database)))
  99
 100 (defun in-transaction-p (&key (database *default-database*))
 101   "A predicate to test whether DATABASE, which defaults to
 102 *DEFAULT-DATABASE*, is currently within the scope of a
 103 transaction."
 104   (and database (transaction database) (= (transaction-level database) 1)))