sql/ooddl.lisp

   1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
   2 ;;;; *************************************************************************
   3 ;;;;
   4 ;;;; The CLSQL Object Oriented Data Definitional Language (OODDL)
   5 ;;;;
   6 ;;;; This file is part of CLSQL.
   7 ;;;;
   8 ;;;; CLSQL users are granted the rights to distribute and use this software
   9 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
  10 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
  11 ;;;; *************************************************************************
  12
  13
  14 (in-package #:clsql-sys)
  15
  16 (defclass standard-db-object ()
  17   ((view-database :initform nil :initarg :view-database :reader view-database
  18                   :db-kind :virtual))
  19   (:metaclass standard-db-class)
  20   (:documentation "Superclass for all CLSQL View Classes."))
  21
  22 (defparameter *default-string-length* 255
  23   "The length of a string which does not have a user-specified length.")
  24
  25 (defvar *db-auto-sync* nil
  26   "A non-nil value means that creating View Class instances or
  27   setting their slots automatically creates/updates the
  28   corresponding records in the underlying database.")
  29
  30 (defvar *db-deserializing* nil)
  31 (defvar *db-initializing* nil)
  32
  33 (defmethod slot-value-using-class ((class standard-db-class) instance slot-def)
  34   "When a slot is unbound but should contain a join object or a value from a
  35    normalized view-class, then retrieve and set those slots, so the value can
  36    be returned"
  37   (declare (optimize (speed 3)))
  38   (unless *db-deserializing*
  39     (let* ((slot-name (%svuc-slot-name slot-def))
  40            (slot-object (%svuc-slot-object slot-def class)))
  41       (unless (slot-boundp instance slot-name)
  42         (let ((*db-deserializing* t))
  43           (cond
  44             ((join-slot-p slot-def)
  45              (setf (slot-value instance slot-name)
  46                    (if (view-database instance)
  47                        (fault-join-slot class instance slot-object)
  48                        ;; TODO: you could in theory get a join object even if
  49                        ;; its joined-to object was not in the database
  50                        nil
  51                        )))
  52             ((not-direct-normalized-slot-p class slot-def)
  53              (if (view-database instance)
  54                  (update-fault-join-normalized-slot class instance slot-def)
  55                  (setf (slot-value instance slot-name) nil))))))))
  56   (call-next-method))
  57
  58 (defmethod (setf slot-value-using-class) (new-value (class standard-db-class)
  59                                           instance slot-def)
  60   "Handle auto syncing values to the database if *db-auto-sync* is t"
  61   (declare (ignore new-value))
  62   (let* ((slot-name (%svuc-slot-name slot-def))
  63          (slot-object (%svuc-slot-object slot-def class))
  64          (slot-kind (view-class-slot-db-kind slot-object)))
  65     (prog1
  66         (call-next-method)
  67       (when (and *db-auto-sync*
  68                  (not *db-initializing*)
  69                  (not *db-deserializing*)
  70                  (not (eql slot-kind :virtual)))
  71         (update-record-from-slot instance slot-name)))))
  72
  73 (defmethod initialize-instance ((object standard-db-object)
  74                                 &rest all-keys &key &allow-other-keys)
  75   (declare (ignore all-keys))
  76   (let ((*db-initializing* t))
  77     (call-next-method)
  78     (when (and *db-auto-sync*
  79                (not *db-deserializing*))
  80       (update-records-from-instance object))))
  81
  82 ;;
  83 ;; Build the database tables required to store the given view class
  84 ;;
  85
  86 (defun create-view-from-class (view-class-name
  87                                &key (database *default-database*)
  88                                (transactions t))
  89   "Creates a table as defined by the View Class VIEW-CLASS-NAME
  90 in DATABASE which defaults to *DEFAULT-DATABASE*."
  91   (let ((tclass (find-class view-class-name)))
  92     (if tclass
  93         (let ((*default-database* database)
  94               (pclass (car (class-direct-superclasses tclass))))
  95           (when (and (normalizedp tclass) (not (table-exists-p pclass)))
  96             (create-view-from-class (class-name pclass)
  97                                     :database database :transactions transactions))
  98           (%install-class tclass database :transactions transactions))
  99         (error "Class ~s not found." view-class-name)))
 100   (values))
 101
 102 (defmethod auto-increment-column-p (slotdef &optional (database clsql-sys:*default-database*))
 103   (declare (ignore database))
 104   (or (member :auto-increment (listify (view-class-slot-db-constraints slotdef)))
 105       (slot-value slotdef 'autoincrement-sequence)))
 106
 107 (defmethod %install-class ((self standard-db-class) database
 108                            &key (transactions t))
 109   (let ((schemadef '())
 110         (ordered-slots (slots-for-possibly-normalized-class self)))
 111     (dolist (slotdef ordered-slots)
 112       (let ((res (database-generate-column-definition self slotdef database)))
 113         (when res
 114           (push res schemadef))))
 115     (if (not schemadef)
 116         (unless (normalizedp self)
 117           (error "Class ~s has no :base slots" self))
 118         (progn
 119           (database-add-autoincrement-sequence self database)
 120           (create-table (sql-expression :table (database-identifier self database))
 121                         (nreverse schemadef)
 122                         :database database
 123                         :transactions transactions
 124                         :constraints (database-pkey-constraint self database))
 125           (push self (database-view-classes database)))))
 126   t)
 127
 128 (defmethod database-pkey-constraint ((class standard-db-class) database)
 129   ;; Keylist will always be a list of escaped-indentifier
 130   (let ((keylist (mapcar #'(lambda (x) (escaped-database-identifier x database))
 131                          (keyslots-for-class class)))
 132         (table (escaped (combine-database-identifiers
 133                          (list class 'PK)
 134                          database))))
 135     (when keylist
 136       (format nil "CONSTRAINT ~A PRIMARY KEY (~{~A~^,~})" table
 137               keylist))))
 138
 139 (defmethod database-generate-column-definition (class slotdef database)
 140   (declare (ignore class))
 141   (when (key-or-base-slot-p slotdef)
 142     (let ((cdef
 143            (list (sql-expression :attribute (database-identifier slotdef database))
 144                  (specified-type slotdef))))
 145       (setf cdef (append cdef (list (view-class-slot-db-type slotdef))))
 146       (let ((const (view-class-slot-db-constraints slotdef)))
 147         (when const
 148           (setq cdef (append cdef (listify const)))))
 149       cdef)))
 150
 151
 152 ;;
 153 ;; Drop the tables which store the given view class
 154 ;;
 155
 156 (defun drop-view-from-class (view-class-name &key (database *default-database*)
 157                              (owner nil))
 158   "Removes a table defined by the View Class VIEW-CLASS-NAME from
 159 DATABASE which defaults to *DEFAULT-DATABASE*."
 160   (let ((tclass (find-class view-class-name)))
 161     (if tclass
 162         (let ((*default-database* database))
 163           (%uninstall-class tclass :owner owner))
 164         (error "Class ~s not found." view-class-name)))
 165   (values))
 166
 167 (defun %uninstall-class (self &key
 168                          (database *default-database*)
 169                          (owner nil))
 170   (drop-table (sql-expression :table (database-identifier self database))
 171               :if-does-not-exist :ignore
 172               :database database
 173               :owner owner)
 174   (database-remove-autoincrement-sequence self database)
 175   (setf (database-view-classes database)
 176         (remove self (database-view-classes database))))
 177
 178
 179 ;;
 180 ;; List all known view classes
 181 ;;
 182
 183 (defun list-classes (&key (test #'identity)
 184                      (root-class (find-class 'standard-db-object))
 185                      (database *default-database*))
 186   "Returns a list of all the View Classes which are connected to
 187 DATABASE, which defaults to *DEFAULT-DATABASE*, and which descend
 188 from the class ROOT-CLASS and which satisfy the function TEST. By
 189 default ROOT-CLASS is STANDARD-DB-OBJECT and TEST is IDENTITY."
 190   (flet ((find-superclass (class)
 191            (member root-class (class-precedence-list class))))
 192     (let ((view-classes (and database (database-view-classes database))))
 193       (when view-classes
 194         (remove-if #'(lambda (c) (or (not (funcall test c))
 195                                      (not (find-superclass c))))
 196                    view-classes)))))
 197
 198 ;;
 199 ;; Define a new view class
 200 ;;
 201
 202 (defmacro def-view-class (class supers slots &rest cl-options)
 203   "Creates a View Class called CLASS whose slots SLOTS can map
 204 onto the attributes of a table in a database. If SUPERS is nil
 205 then the superclass of CLASS will be STANDARD-DB-OBJECT,
 206 otherwise SUPERS is a list of superclasses for CLASS which must
 207 include STANDARD-DB-OBJECT or a descendent of this class. The
 208 syntax of DEFCLASS is extended through the addition of a class
 209 option :base-table which defines the database table onto which
 210 the View Class maps and which defaults to CLASS. The DEFCLASS
 211 syntax is also extended through additional slot
 212 options. The :db-kind slot option specifies the kind of DB
 213 mapping which is performed for this slot and defaults to :base
 214 which indicates that the slot maps to an ordinary column of the
 215 database table. A :db-kind value of :key indicates that this slot
 216 is a special kind of :base slot which maps onto a column which is
 217 one of the unique keys for the database table, the value :join
 218 indicates this slot represents a join onto another View Class
 219 which contains View Class objects, and the value :virtual
 220 indicates a standard CLOS slot which does not map onto columns of
 221 the database table. If a slot is specified with :db-kind :join,
 222 the slot option :db-info contains a list which specifies the
 223 nature of the join. For slots of :db-kind :base or :key,
 224 the :type slot option has a special interpretation such that Lisp
 225 types, such as string, integer and float are automatically
 226 converted into appropriate SQL types for the column onto which
 227 the slot maps. This behaviour may be over-ridden using
 228 the :db-type slot option which is a string specifying the
 229 vendor-specific database type for this slot's column definition
 230 in the database. The :column slot option specifies the name of
 231 the SQL column which the slot maps onto, if :db-kind is
 232 not :virtual, and defaults to the slot name. The :void-value slot
 233 option specifies the value to store if the SQL value is NULL and
 234 defaults to NIL. The :db-constraints slot option is a string
 235 representing an SQL table constraint expression or a list of such
 236 strings."
 237   `(progn
 238      (defclass ,class ,supers ,slots
 239        ,@(if (find :metaclass `,cl-options :key #'car)
 240              `,cl-options
 241              (cons '(:metaclass clsql-sys::standard-db-class) `,cl-options)))
 242      (finalize-inheritance (find-class ',class))
 243      (find-class ',class)))
 244
 245 (defun keyslots-for-class (class)
 246   (slot-value class 'key-slots))