1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
6 ;;;; The CLSQL Object Oriented Data Manipulation Language (OODML).
8 ;;;; This file is part of CLSQL.
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 ;;;; *************************************************************************
15 (in-package #:clsql-sys)
18 (defun key-qualifier-for-instance (obj &key (database *default-database*))
19 (let ((tb (view-table (class-of obj))))
22 (sql-expression :attribute
23 (view-class-slot-column k)
27 (slot-value obj (slot-definition-name k))
29 (let* ((keys (keyslots-for-class (class-of obj)))
30 (keyxprs (mapcar #'qfk (reverse keys))))
32 ((= (length keyxprs) 0) nil)
33 ((= (length keyxprs) 1) (car keyxprs))
34 ((> (length keyxprs) 1) (apply #'sql-operation 'and keyxprs)))))))
37 ;; Function used by 'generate-selection-list'
40 (defun generate-attribute-reference (vclass slotdef)
42 ((eq (view-class-slot-db-kind slotdef) :base)
43 (sql-expression :attribute (view-class-slot-column slotdef)
44 :table (view-table vclass)))
45 ((eq (view-class-slot-db-kind slotdef) :key)
46 (sql-expression :attribute (view-class-slot-column slotdef)
47 :table (view-table vclass)))
51 ;; Function used by 'find-all'
54 (defun generate-selection-list (vclass)
56 (dolist (slotdef (ordered-class-slots vclass))
57 (let ((res (generate-attribute-reference vclass slotdef)))
59 (push (cons slotdef res) sels))))
62 (error "No slots of type :base in view-class ~A" (class-name vclass)))))
66 (defun generate-retrieval-joins-list (vclass retrieval-method)
67 "Returns list of immediate join slots for a class."
68 (let ((join-slotdefs nil))
69 (dolist (slotdef (ordered-class-slots vclass) join-slotdefs)
70 (when (and (eq :join (view-class-slot-db-kind slotdef))
71 (eq retrieval-method (gethash :retrieval (view-class-slot-db-info slotdef))))
72 (push slotdef join-slotdefs)))))
74 (defun generate-immediate-joins-selection-list (vclass)
75 "Returns list of immediate join slots for a class."
77 (dolist (joined-slot (generate-retrieval-joins-list vclass :immediate) sels)
78 (let* ((join-class-name (gethash :join-class (view-class-slot-db-info joined-slot)))
79 (join-class (when join-class-name (find-class join-class-name))))
80 (dolist (slotdef (ordered-class-slots join-class))
81 (let ((res (generate-attribute-reference join-class slotdef)))
83 (push (cons slotdef res) sels))))))
87 ;; Called by 'get-slot-values-from-view'
90 (defmethod update-slot-from-db ((instance standard-db-object) slotdef value)
91 (declare (optimize (speed 3) #+cmu (extensions:inhibit-warnings 3)))
92 (let* ((slot-reader (view-class-slot-db-reader slotdef))
93 (slot-name (slot-definition-name slotdef))
94 (slot-type (specified-type slotdef)))
95 (cond ((and value (null slot-reader))
96 (setf (slot-value instance slot-name)
97 (read-sql-value value (delistify slot-type)
98 (view-database instance)
99 (database-underlying-type
100 (view-database instance)))))
102 (update-slot-with-null instance slot-name slotdef))
103 ((typep slot-reader 'string)
104 (setf (slot-value instance slot-name)
105 (format nil slot-reader value)))
106 ((typep slot-reader 'function)
107 (setf (slot-value instance slot-name)
108 (apply slot-reader (list value))))
110 (error "Slot reader is of an unusual type.")))))
112 (defmethod key-value-from-db (slotdef value database)
113 (declare (optimize (speed 3) #+cmu (extensions:inhibit-warnings 3)))
114 (let ((slot-reader (view-class-slot-db-reader slotdef))
115 (slot-type (specified-type slotdef)))
116 (cond ((and value (null slot-reader))
117 (read-sql-value value (delistify slot-type) database
118 (database-underlying-type database)))
121 ((typep slot-reader 'string)
122 (format nil slot-reader value))
123 ((typep slot-reader 'function)
124 (apply slot-reader (list value)))
126 (error "Slot reader is of an unusual type.")))))
128 (defun db-value-from-slot (slotdef val database)
129 (let ((dbwriter (view-class-slot-db-writer slotdef))
130 (dbtype (specified-type slotdef)))
132 (string (format nil dbwriter val))
133 (function (apply dbwriter (list val)))
135 (database-output-sql-as-type
139 val database (database-underlying-type database))))))
141 (defun check-slot-type (slotdef val)
142 (let* ((slot-type (specified-type slotdef))
143 (basetype (if (listp slot-type) (car slot-type) slot-type)))
144 (when (and slot-type val)
145 (unless (typep val basetype)
146 (error 'sql-user-error
148 (format nil "Invalid value ~A in slot ~A, not of type ~A."
149 val (slot-definition-name slotdef) slot-type))))))
152 ;; Called by find-all
155 (defmethod get-slot-values-from-view (obj slotdeflist values)
156 (flet ((update-slot (slot-def values)
157 (update-slot-from-db obj slot-def values)))
158 (mapc #'update-slot slotdeflist values)
161 (defmethod update-record-from-slot ((obj standard-db-object) slot &key
162 (database *default-database*))
163 (let* ((database (or (view-database obj) database))
164 (vct (view-table (class-of obj)))
165 (sd (slotdef-for-slot-with-class slot (class-of obj))))
166 (check-slot-type sd (slot-value obj slot))
167 (let* ((att (view-class-slot-column sd))
168 (val (db-value-from-slot sd (slot-value obj slot) database)))
169 (cond ((and vct sd (view-database obj))
170 (update-records (sql-expression :table vct)
171 :attributes (list (sql-expression :attribute att))
173 :where (key-qualifier-for-instance
174 obj :database database)
176 ((and vct sd (not (view-database obj)))
177 (insert-records :into (sql-expression :table vct)
178 :attributes (list (sql-expression :attribute att))
181 (setf (slot-value obj 'view-database) database))
183 (error "Unable to update record.")))))
186 (defmethod update-record-from-slots ((obj standard-db-object) slots &key
187 (database *default-database*))
188 (let* ((database (or (view-database obj) database))
189 (vct (view-table (class-of obj)))
190 (sds (slotdefs-for-slots-with-class slots (class-of obj)))
191 (avps (mapcar #'(lambda (s)
192 (let ((val (slot-value
193 obj (slot-definition-name s))))
194 (check-slot-type s val)
195 (list (sql-expression
196 :attribute (view-class-slot-column s))
197 (db-value-from-slot s val database))))
199 (cond ((and avps (view-database obj))
200 (update-records (sql-expression :table vct)
202 :where (key-qualifier-for-instance
203 obj :database database)
205 ((and avps (not (view-database obj)))
206 (insert-records :into (sql-expression :table vct)
209 (setf (slot-value obj 'view-database) database))
211 (error "Unable to update records"))))
214 (defmethod update-records-from-instance ((obj standard-db-object)
215 &key (database *default-database*))
216 (let ((database (or (view-database obj) database)))
217 (labels ((slot-storedp (slot)
218 (and (member (view-class-slot-db-kind slot) '(:base :key))
219 (slot-boundp obj (slot-definition-name slot))))
220 (slot-value-list (slot)
221 (let ((value (slot-value obj (slot-definition-name slot))))
222 (check-slot-type slot value)
223 (list (sql-expression :attribute (view-class-slot-column slot))
224 (db-value-from-slot slot value database)))))
225 (let* ((view-class (class-of obj))
226 (view-class-table (view-table view-class))
227 (slots (remove-if-not #'slot-storedp
228 (ordered-class-slots view-class)))
229 (record-values (mapcar #'slot-value-list slots)))
230 (unless record-values
231 (error "No settable slots."))
232 (if (view-database obj)
233 (update-records (sql-expression :table view-class-table)
234 :av-pairs record-values
235 :where (key-qualifier-for-instance
236 obj :database database)
239 (insert-records :into (sql-expression :table view-class-table)
240 :av-pairs record-values
242 (setf (slot-value obj 'view-database) database))))))
245 (defmethod delete-instance-records ((instance standard-db-object))
246 (let ((vt (sql-expression :table (view-table (class-of instance))))
247 (vd (view-database instance)))
249 (let ((qualifier (key-qualifier-for-instance instance :database vd)))
250 (delete-records :from vt :where qualifier :database vd)
251 (setf (slot-value instance 'view-database) nil)
253 (signal-no-database-error vd))))
255 (defmethod update-instance-from-records ((instance standard-db-object)
256 &key (database *default-database*))
257 (let* ((view-class (find-class (class-name (class-of instance))))
258 (view-table (sql-expression :table (view-table view-class)))
259 (vd (or (view-database instance) database))
260 (view-qual (key-qualifier-for-instance instance :database vd))
261 (sels (generate-selection-list view-class))
262 (res (apply #'select (append (mapcar #'cdr sels)
263 (list :from view-table
265 (list :result-types nil)))))
267 (get-slot-values-from-view instance (mapcar #'car sels) (car res)))))
269 (defmethod update-slot-from-record ((instance standard-db-object)
270 slot &key (database *default-database*))
271 (let* ((view-class (find-class (class-name (class-of instance))))
272 (view-table (sql-expression :table (view-table view-class)))
273 (vd (or (view-database instance) database))
274 (view-qual (key-qualifier-for-instance instance :database vd))
275 (slot-def (slotdef-for-slot-with-class slot view-class))
276 (att-ref (generate-attribute-reference view-class slot-def))
277 (res (select att-ref :from view-table :where view-qual
280 (get-slot-values-from-view instance (list slot-def) (car res)))))
283 (defmethod update-slot-with-null ((object standard-db-object)
286 (setf (slot-value object slotname) (slot-value slotdef 'void-value)))
288 (defvar +no-slot-value+ '+no-slot-value+)
290 (defsql sql-slot-value (:symbol "slot-value") (classname slot &optional (value +no-slot-value+) (database *default-database*))
291 (let* ((class (find-class classname))
292 (sld (slotdef-for-slot-with-class slot class)))
294 (if (eq value +no-slot-value+)
295 (sql-expression :attribute (view-class-slot-column sld)
296 :table (view-table class))
301 (error "Unknown slot ~A for class ~A" slot classname))))
303 (defsql sql-view-class (:symbol "view-class") (classname &optional (database *default-database*))
304 (declare (ignore database))
305 (let* ((class (find-class classname)))
306 (unless (view-table class)
307 (error "No view-table for class ~A" classname))
308 (sql-expression :table (view-table class))))
311 (defmethod database-get-type-specifier (type args database db-type)
312 (declare (ignore type args database db-type))
313 (format nil "VARCHAR(~D)" *default-string-length*))
315 (defmethod database-get-type-specifier ((type (eql 'integer)) args database db-type)
316 (declare (ignore database db-type))
318 (format nil "INT(~A)" (car args))
322 "An 8-bit integer, this width may vary by SQL implementation."
325 (defmethod database-get-type-specifier ((type (eql 'tinyint)) args database db-type)
326 (declare (ignore args database db-type))
330 "An integer smaller than a 32-bit integer. this width may vary by SQL implementation."
333 (defmethod database-get-type-specifier ((type (eql 'smallint)) args database db-type)
334 (declare (ignore args database db-type))
337 (deftype mediumint ()
338 "An integer smaller than a 32-bit integer, but may be larger than a smallint. This width may vary by SQL implementation."
341 (defmethod database-get-type-specifier ((type (eql 'mediumint)) args database db-type)
342 (declare (ignore args database db-type))
346 "An integer larger than a 32-bit integer, this width may vary by SQL implementation."
349 (defmethod database-get-type-specifier ((type (eql 'bigint)) args database db-type)
350 (declare (ignore args database db-type))
353 (deftype varchar (&optional size)
354 "A variable length string for the SQL varchar type."
355 (declare (ignore size))
358 (defmethod database-get-type-specifier ((type (eql 'varchar)) args
360 (declare (ignore database db-type))
362 (format nil "VARCHAR(~A)" (car args))
363 (format nil "VARCHAR(~D)" *default-string-length*)))
365 (defmethod database-get-type-specifier ((type (eql 'string)) args database db-type)
366 (declare (ignore database db-type))
368 (format nil "CHAR(~A)" (car args))
369 (format nil "VARCHAR(~D)" *default-string-length*)))
371 (deftype universal-time ()
372 "A positive integer as returned by GET-UNIVERSAL-TIME."
375 (defmethod database-get-type-specifier ((type (eql 'universal-time)) args database db-type)
376 (declare (ignore args database db-type))
379 (defmethod database-get-type-specifier ((type (eql 'wall-time)) args database db-type)
380 (declare (ignore args database db-type))
383 (defmethod database-get-type-specifier ((type (eql 'duration)) args database db-type)
384 (declare (ignore database args db-type))
387 (defmethod database-get-type-specifier ((type (eql 'money)) args database db-type)
388 (declare (ignore database args db-type))
392 (deftype char (&optional len)
393 "A lisp type for the SQL CHAR type."
396 (defmethod database-get-type-specifier ((type (eql 'float)) args database db-type)
397 (declare (ignore database db-type))
399 (format nil "FLOAT(~A)" (car args))
402 (defmethod database-get-type-specifier ((type (eql 'long-float)) args database db-type)
403 (declare (ignore database db-type))
405 (format nil "FLOAT(~A)" (car args))
408 (deftype generalized-boolean ()
409 "A type which outputs a SQL boolean value, though any lisp type can be stored in the slot."
412 (defmethod database-get-type-specifier ((type (eql 'boolean)) args database db-type)
413 (declare (ignore args database db-type))
416 (defmethod database-get-type-specifier ((type (eql 'generalized-boolean)) args database db-type)
417 (declare (ignore args database db-type))
420 (defmethod database-get-type-specifier ((type (eql 'number)) args database db-type)
421 (declare (ignore database db-type))
423 ((and (consp args) (= (length args) 2))
424 (format nil "NUMBER(~D,~D)" (first args) (second args)))
425 ((and (consp args) (= (length args) 1))
426 (format nil "NUMBER(~D)" (first args)))
430 (defmethod database-get-type-specifier ((type (eql 'char)) args database db-type)
431 (declare (ignore database db-type))
433 (format nil "CHAR(~D)" (first args))
437 (defmethod database-output-sql-as-type (type val database db-type)
438 (declare (ignore type database db-type))
441 (defmethod database-output-sql-as-type ((type (eql 'list)) val database db-type)
442 (declare (ignore database db-type))
443 (progv '(*print-circle* *print-array*) '(t t)
444 (let ((escaped (prin1-to-string val)))
445 (substitute-char-string
446 escaped #\Null " "))))
448 (defmethod database-output-sql-as-type ((type (eql 'symbol)) val database db-type)
449 (declare (ignore database db-type))
452 (package-name (symbol-package val))
457 (defmethod database-output-sql-as-type ((type (eql 'keyword)) val database db-type)
458 (declare (ignore database db-type))
463 (defmethod database-output-sql-as-type ((type (eql 'vector)) val database db-type)
464 (declare (ignore database db-type))
465 (progv '(*print-circle* *print-array*) '(t t)
466 (prin1-to-string val)))
468 (defmethod database-output-sql-as-type ((type (eql 'array)) val database db-type)
469 (declare (ignore database db-type))
470 (progv '(*print-circle* *print-array*) '(t t)
471 (prin1-to-string val)))
473 (defmethod database-output-sql-as-type ((type (eql 'boolean)) val database db-type)
474 (declare (ignore database db-type))
477 (defmethod database-output-sql-as-type ((type (eql 'generalized-boolean)) val database db-type)
478 (declare (ignore database db-type))
481 (defmethod database-output-sql-as-type ((type (eql 'string)) val database db-type)
482 (declare (ignore database db-type))
485 (defmethod database-output-sql-as-type ((type (eql 'char)) val database db-type)
486 (declare (ignore database db-type))
488 (character (write-to-string val))
491 (defmethod database-output-sql-as-type ((type (eql 'float)) val database db-type)
492 (declare (ignore database db-type))
493 (let ((*read-default-float-format* (type-of val)))
494 (format nil "~F" val)))
496 (defmethod read-sql-value (val type database db-type)
497 (declare (ignore type database db-type))
498 (read-from-string val))
500 (defmethod read-sql-value (val (type (eql 'string)) database db-type)
501 (declare (ignore database db-type))
504 (defmethod read-sql-value (val (type (eql 'varchar)) database db-type)
505 (declare (ignore database db-type))
508 (defmethod read-sql-value (val (type (eql 'char)) database db-type)
509 (declare (ignore database db-type))
512 (defmethod read-sql-value (val (type (eql 'keyword)) database db-type)
513 (declare (ignore database db-type))
514 (when (< 0 (length val))
515 (intern (symbol-name-default-case val)
516 (find-package '#:keyword))))
518 (defmethod read-sql-value (val (type (eql 'symbol)) database db-type)
519 (declare (ignore database db-type))
520 (when (< 0 (length val))
521 (unless (string= val (symbol-name-default-case "NIL"))
522 (read-from-string val))))
524 (defmethod read-sql-value (val (type (eql 'integer)) database db-type)
525 (declare (ignore database db-type))
528 (unless (string-equal "NIL" val)
529 (parse-integer val)))
532 (defmethod read-sql-value (val (type (eql 'smallint)) database db-type)
533 (declare (ignore database db-type))
536 (unless (string-equal "NIL" val)
537 (parse-integer val)))
540 (defmethod read-sql-value (val (type (eql 'bigint)) database db-type)
541 (declare (ignore database db-type))
544 (unless (string-equal "NIL" val)
545 (parse-integer val)))
548 (defmethod read-sql-value (val (type (eql 'float)) database db-type)
549 (declare (ignore database db-type))
550 ;; writing 1.0 writes 1, so we we *really* want a float, must do (float ...)
553 (float (read-from-string val)))
557 (defmethod read-sql-value (val (type (eql 'boolean)) database db-type)
558 (declare (ignore database db-type))
561 (defmethod read-sql-value (val (type (eql 'generalized-boolean)) database db-type)
562 (declare (ignore database db-type))
565 (defmethod read-sql-value (val (type (eql 'number)) database db-type)
566 (declare (ignore database db-type))
569 (unless (string-equal "NIL" val)
570 (read-from-string val)))
573 (defmethod read-sql-value (val (type (eql 'universal-time)) database db-type)
574 (declare (ignore database db-type))
575 (unless (eq 'NULL val)
581 (defmethod read-sql-value (val (type (eql 'wall-time)) database db-type)
582 (declare (ignore database db-type))
583 (unless (eq 'NULL val)
584 (parse-timestring val)))
586 (defmethod read-sql-value (val (type (eql 'duration)) database db-type)
587 (declare (ignore database db-type))
588 (unless (or (eq 'NULL val)
590 (parse-timestring val)))
592 ;; ------------------------------------------------------------
593 ;; Logic for 'faulting in' :join slots
595 ;; this works, but is inefficient requiring (+ 1 n-rows)
598 (defun fault-join-target-slot (class object slot-def)
599 (let* ((res (fault-join-slot-raw class object slot-def))
600 (dbi (view-class-slot-db-info slot-def))
601 (target-name (gethash :target-slot dbi))
602 (target-class (find-class target-name)))
604 (mapcar (lambda (obj)
610 (find target-name (class-slots (class-of obj))
611 :key #'slot-definition-name)))
614 #+ignore ;; this doesn't work when attempting to call slot-value
615 (mapcar (lambda (obj)
616 (cons obj (slot-value obj ts))) res))))
618 (defun fault-join-target-slot (class object slot-def)
619 (let* ((dbi (view-class-slot-db-info slot-def))
620 (ts (gethash :target-slot dbi))
621 (jc (gethash :join-class dbi))
622 (ts-view-table (view-table (find-class ts)))
623 (jc-view-table (view-table (find-class jc)))
624 (tdbi (view-class-slot-db-info
625 (find ts (class-slots (find-class jc))
626 :key #'slot-definition-name)))
627 (retrieval (gethash :retrieval tdbi))
628 (jq (join-qualifier class object slot-def))
629 (key (slot-value object (gethash :home-key dbi))))
635 :inner-join (sql-expression :table jc-view-table)
639 :attribute (gethash :foreign-key tdbi)
640 :table ts-view-table)
642 :attribute (gethash :home-key tdbi)
643 :table jc-view-table))
645 :result-types :auto)))
646 (mapcar #'(lambda (i)
647 (let* ((instance (car i))
648 (jcc (make-instance jc :view-database (view-database instance))))
649 (setf (slot-value jcc (gethash :foreign-key dbi))
651 (setf (slot-value jcc (gethash :home-key tdbi))
652 (slot-value instance (gethash :foreign-key tdbi)))
653 (list instance jcc)))
656 ;; just fill in minimal slots
659 (let ((instance (make-instance ts :view-database (view-database object)))
660 (jcc (make-instance jc :view-database (view-database object)))
662 (setf (slot-value instance (gethash :home-key tdbi)) fk)
663 (setf (slot-value jcc (gethash :foreign-key dbi))
665 (setf (slot-value jcc (gethash :home-key tdbi))
667 (list instance jcc)))
668 (select (sql-expression :attribute (gethash :foreign-key tdbi) :table jc-view-table)
669 :from (sql-expression :table jc-view-table)
675 (defvar *default-update-objects-max-len* nil
676 "The default value to use for the MAX-LEN keyword argument to
677 UPDATE-OBJECT-JOINS.")
679 (defun update-objects-joins (objects &key (slots t) (force-p t)
681 *default-update-objects-max-len*))
682 "Updates from the records of the appropriate database tables
683 the join slots specified by SLOTS in the supplied list of View
684 Class instances OBJECTS. SLOTS is t by default which means that
685 all join slots with :retrieval :immediate are updated. CLASS-NAME
686 is used to specify the View Class of all instance in OBJECTS and
687 default to nil which means that the class of the first instance
688 in OBJECTS is used. FORCE-P is t by default which means that all
689 join slots are updated whereas a value of nil means that only
690 unbound join slots are updated. MAX-LEN defaults to
691 *DEFAULT-UPDATE-OBJECTS-MAX-LEN* and when non-nil specifies that
692 UPDATE-OBJECT-JOINS may issue multiple database queries with a
693 maximum of MAX-LEN instances updated in each query."
694 (assert (or (null max-len) (plusp max-len)))
697 (setq class-name (class-name (class-of (first objects)))))
698 (let* ((class (find-class class-name))
699 (class-slots (ordered-class-slots class))
702 (generate-retrieval-joins-list class :deferred)
704 (mapcar #'(lambda (name)
705 (let ((slotdef (find name class-slots :key #'slot-definition-name)))
707 (warn "Unable to find slot named ~S in class ~S." name class))
710 (dolist (slotdef slotdefs)
711 (let* ((dbi (view-class-slot-db-info slotdef))
712 (slotdef-name (slot-definition-name slotdef))
713 (foreign-key (gethash :foreign-key dbi))
714 (home-key (gethash :home-key dbi))
718 (mapcar #'(lambda (o) (slot-value o home-key)) objects)
721 #'(lambda (o) (if (slot-boundp o slotdef-name)
723 (slot-value o home-key)))
725 (n-object-keys (length object-keys))
726 (query-len (or max-len n-object-keys)))
728 (do ((i 0 (+ i query-len)))
729 ((>= i n-object-keys))
730 (let* ((keys (if max-len
731 (subseq object-keys i (min (+ i query-len) n-object-keys))
733 (results (find-all (list (gethash :join-class dbi))
734 :where (make-instance 'sql-relational-exp
736 :sub-expressions (list (sql-expression :attribute foreign-key)
741 (dolist (object objects)
742 (when (or force-p (not (slot-boundp object slotdef-name)))
743 (let ((res (remove-if-not #'(lambda (obj)
744 (equal obj (slot-value
752 (setf (slot-value object slotdef-name)
753 (if (gethash :set dbi) res (car res)))))))))))))
756 (defun fault-join-slot-raw (class object slot-def)
757 (let* ((dbi (view-class-slot-db-info slot-def))
758 (jc (gethash :join-class dbi)))
759 (let ((jq (join-qualifier class object slot-def)))
761 (select jc :where jq :flatp t :result-types nil
762 :database (view-database object))))))
764 (defun fault-join-slot (class object slot-def)
765 (let* ((dbi (view-class-slot-db-info slot-def))
766 (ts (gethash :target-slot dbi)))
767 (if (and ts (gethash :set dbi))
768 (fault-join-target-slot class object slot-def)
769 (let ((res (fault-join-slot-raw class object slot-def)))
772 ((and ts (not (gethash :set dbi)))
773 (mapcar (lambda (obj) (slot-value obj ts)) res))
774 ((and (not ts) (not (gethash :set dbi)))
776 ((and (not ts) (gethash :set dbi))
779 (defun join-qualifier (class object slot-def)
780 (declare (ignore class))
781 (let* ((dbi (view-class-slot-db-info slot-def))
782 (jc (find-class (gethash :join-class dbi)))
783 ;;(ts (gethash :target-slot dbi))
784 ;;(tsdef (if ts (slotdef-for-slot-with-class ts jc)))
785 (foreign-keys (gethash :foreign-key dbi))
786 (home-keys (gethash :home-key dbi)))
787 (when (every #'(lambda (slt)
788 (and (slot-boundp object slt)
789 (not (null (slot-value object slt)))))
790 (if (listp home-keys) home-keys (list home-keys)))
792 (mapcar #'(lambda (hk fk)
793 (let ((fksd (slotdef-for-slot-with-class fk jc)))
799 (view-class-slot-column fksd)
800 :table (view-table jc)))
804 (slot-value object hk))
807 (if (listp home-keys)
810 (if (listp foreign-keys)
812 (list foreign-keys)))))
814 (if (> (length jc) 1)
818 ;; FIXME: add retrieval immediate for efficiency
819 ;; For example, for (select 'employee-address) in test suite =>
820 ;; select addr.*,ea_join.* FROM addr,ea_join WHERE ea_join.aaddressid=addr.addressid\g
822 (defun build-objects (vals sclasses immediate-join-classes sels immediate-joins database refresh flatp instances)
823 "Used by find-all to build objects."
824 (labels ((build-object (vals vclass jclasses selects immediate-selects instance)
825 (let* ((db-vals (butlast vals (- (list-length vals)
826 (list-length selects))))
827 (obj (if instance instance (make-instance (class-name vclass) :view-database database)))
828 (join-vals (subseq vals (list-length selects)))
829 (joins (mapcar #'(lambda (c) (when c (make-instance c :view-database database)))
832 ;;(format t "joins: ~S~%db-vals: ~S~%join-values: ~S~%selects: ~S~%immediate-selects: ~S~%"
833 ;;joins db-vals join-vals selects immediate-selects)
835 ;; use refresh keyword here
836 (setf obj (get-slot-values-from-view obj (mapcar #'car selects) db-vals))
838 ;; find all immediate-select slots and join-vals for this object
839 (let* ((slots (class-slots (class-of jo)))
840 (pos-list (remove-if #'null
843 (position s immediate-selects
847 (get-slot-values-from-view jo
849 (mapcar #'(lambda (pos)
850 (nth pos immediate-selects))
852 (mapcar #'(lambda (pos) (nth pos join-vals))
857 (let ((slot (find (class-name (class-of jc)) (class-slots vclass)
858 :key #'(lambda (slot)
859 (when (and (eq :join (view-class-slot-db-kind slot))
860 (eq (slot-definition-name slot)
861 (gethash :join-class (view-class-slot-db-info slot))))
862 (slot-definition-name slot))))))
864 (setf (slot-value obj (slot-definition-name slot)) jc))))
866 (when refresh (instance-refreshed obj))
869 (mapcar #'(lambda (sclass jclass sel immediate-join instance)
871 (build-object vals sclass jclass sel immediate-join instance)
872 (setf vals (nthcdr (+ (list-length sel) (list-length immediate-join))
874 sclasses immediate-join-classes sels immediate-joins instances)))
875 (if (and flatp (= (length sclasses) 1))
879 (defun find-all (view-classes
881 &key all set-operation distinct from where group-by having
882 order-by offset limit refresh flatp result-types
884 (database *default-database*)
886 "Called by SELECT to generate object query results when the
887 View Classes VIEW-CLASSES are passed as arguments to SELECT."
888 (declare (ignore all set-operation group-by having offset limit inner-join on)
889 (optimize (debug 3) (speed 1)))
890 (flet ((ref-equal (ref1 ref2)
891 (string= (sql-output ref1 database)
892 (sql-output ref2 database)))
893 (table-sql-expr (table)
894 (sql-expression :table (view-table table)))
895 (tables-equal (table-a table-b)
896 (when (and table-a table-b)
897 (string= (string (slot-value table-a 'name))
898 (string (slot-value table-b 'name))))))
902 (remf args :additional-fields)
903 (remf args :result-types)
904 (remf args :instances)
905 (let* ((*db-deserializing* t)
906 (sclasses (mapcar #'find-class view-classes))
907 (immediate-join-slots
908 (mapcar #'(lambda (c) (generate-retrieval-joins-list c :immediate)) sclasses))
909 (immediate-join-classes
910 (mapcar #'(lambda (jcs)
911 (mapcar #'(lambda (slotdef)
912 (find-class (gethash :join-class (view-class-slot-db-info slotdef))))
914 immediate-join-slots))
915 (immediate-join-sels (mapcar #'generate-immediate-joins-selection-list sclasses))
916 (sels (mapcar #'generate-selection-list sclasses))
917 (fullsels (apply #'append (mapcar #'append sels immediate-join-sels)))
918 (sel-tables (collect-table-refs where))
919 (tables (remove-if #'null
921 (append (mapcar #'table-sql-expr sclasses)
922 (mapcan #'(lambda (jc-list)
924 #'(lambda (jc) (when jc (table-sql-expr jc)))
926 immediate-join-classes)
928 :test #'tables-equal)))
929 (order-by-slots (mapcar #'(lambda (ob) (if (atom ob) ob (car ob)))
934 ;;(format t "sclasses: ~W~%ijc: ~W~%tables: ~W~%" sclasses immediate-join-classes tables)
936 (dolist (ob order-by-slots)
937 (when (and ob (not (member ob (mapcar #'cdr fullsels)
940 (append fullsels (mapcar #'(lambda (att) (cons nil att))
942 (dolist (ob (listify distinct))
943 (when (and (typep ob 'sql-ident)
944 (not (member ob (mapcar #'cdr fullsels)
947 (append fullsels (mapcar #'(lambda (att) (cons nil att))
949 (mapcar #'(lambda (vclass jclasses jslots)
952 #'(lambda (jclass jslot)
953 (let ((dbi (view-class-slot-db-info jslot)))
956 (list (sql-operation '==
958 :attribute (gethash :foreign-key dbi)
959 :table (view-table jclass))
961 :attribute (gethash :home-key dbi)
962 :table (view-table vclass))))
963 (when join-where (listify join-where))))))
965 sclasses immediate-join-classes immediate-join-slots)
967 (setq where (listify where)))
969 ((and where join-where)
970 (setq where (list (apply #'sql-and where join-where))))
971 ((and (null where) (> (length join-where) 1))
972 (setq where (list (apply #'sql-and join-where)))))
974 (let* ((rows (apply #'select
975 (append (mapcar #'cdr fullsels)
977 (list (append (when from (listify from))
979 (list :result-types result-types)
983 (instances-to-add (- (length rows) (length instances)))
984 (perhaps-extended-instances
985 (if (plusp instances-to-add)
986 (append instances (do ((i 0 (1+ i))
988 ((= i instances-to-add) res)
989 (push (make-list (length sclasses) :initial-element nil) res)))
992 #'(lambda (row instance)
993 (build-objects row sclasses immediate-join-classes sels
994 immediate-join-sels database refresh flatp
995 (if (and flatp (atom instance))
998 rows perhaps-extended-instances)))
1001 (defmethod instance-refreshed ((instance standard-db-object)))
1003 (defvar *default-caching* t
1004 "Controls whether SELECT caches objects by default. The CommonSQL
1005 specification states caching is on by default.")
1007 (defun select (&rest select-all-args)
1008 "Executes a query on DATABASE, which has a default value of
1009 *DEFAULT-DATABASE*, specified by the SQL expressions supplied
1010 using the remaining arguments in SELECT-ALL-ARGS. The SELECT
1011 argument can be used to generate queries in both functional and
1012 object oriented contexts.
1014 In the functional case, the required arguments specify the
1015 columns selected by the query and may be symbolic SQL expressions
1016 or strings representing attribute identifiers. Type modified
1017 identifiers indicate that the values selected from the specified
1018 column are converted to the specified lisp type. The keyword
1019 arguments ALL, DISTINCT, FROM, GROUP-by, HAVING, ORDER-BY,
1020 SET-OPERATION and WHERE are used to specify, using the symbolic
1021 SQL syntax, the corresponding components of the SQL query
1022 generated by the call to SELECT. RESULT-TYPES is a list of
1023 symbols which specifies the lisp type for each field returned by
1024 the query. If RESULT-TYPES is nil all results are returned as
1025 strings whereas the default value of :auto means that the lisp
1026 types are automatically computed for each field. FIELD-NAMES is t
1027 by default which means that the second value returned is a list
1028 of strings representing the columns selected by the query. If
1029 FIELD-NAMES is nil, the list of column names is not returned as a
1032 In the object oriented case, the required arguments to SELECT are
1033 symbols denoting View Classes which specify the database tables
1034 to query. In this case, SELECT returns a list of View Class
1035 instances whose slots are set from the attribute values of the
1036 records in the specified table. Slot-value is a legal operator
1037 which can be employed as part of the symbolic SQL syntax used in
1038 the WHERE keyword argument to SELECT. REFRESH is nil by default
1039 which means that the View Class instances returned are retrieved
1040 from a cache if an equivalent call to SELECT has previously been
1041 issued. If REFRESH is true, the View Class instances returned are
1042 updated as necessary from the database and the generic function
1043 INSTANCE-REFRESHED is called to perform any necessary operations
1044 on the updated instances.
1046 In both object oriented and functional contexts, FLATP has a
1047 default value of nil which means that the results are returned as
1048 a list of lists. If FLATP is t and only one result is returned
1049 for each record selected in the query, the results are returned
1050 as elements of a list."
1052 (flet ((select-objects (target-args)
1054 (every #'(lambda (arg)
1056 (find-class arg nil)))
1058 (multiple-value-bind (target-args qualifier-args)
1059 (query-get-selections select-all-args)
1060 (unless (or *default-database* (getf qualifier-args :database))
1061 (signal-no-database-error nil))
1064 ((select-objects target-args)
1065 (let ((caching (getf qualifier-args :caching *default-caching*))
1066 (result-types (getf qualifier-args :result-types :auto))
1067 (refresh (getf qualifier-args :refresh nil))
1068 (database (or (getf qualifier-args :database) *default-database*))
1069 (order-by (getf qualifier-args :order-by)))
1070 (remf qualifier-args :caching)
1071 (remf qualifier-args :refresh)
1072 (remf qualifier-args :result-types)
1074 ;; Add explicity table name to order-by if not specified and only
1075 ;; one selected table. This is required so FIND-ALL won't duplicate
1077 (when (and order-by (= 1 (length target-args)))
1078 (let ((table-name (view-table (find-class (car target-args))))
1079 (order-by-list (copy-seq (listify order-by))))
1081 (loop for i from 0 below (length order-by-list)
1082 do (etypecase (nth i order-by-list)
1083 (sql-ident-attribute
1084 (unless (slot-value (nth i order-by-list) 'qualifier)
1085 (setf (slot-value (nth i order-by-list) 'qualifier) table-name)))
1087 (unless (slot-value (car (nth i order-by-list)) 'qualifier)
1088 (setf (slot-value (car (nth i order-by-list)) 'qualifier) table-name)))))
1089 (setf (getf qualifier-args :order-by) order-by-list)))
1093 (apply #'find-all target-args
1094 (append qualifier-args
1095 (list :result-types result-types :refresh refresh))))
1097 (let ((cached (records-cache-results target-args qualifier-args database)))
1099 ((and cached (not refresh))
1101 ((and cached refresh)
1102 (let ((results (apply #'find-all (append (list target-args) qualifier-args `(:instances ,cached :result-types :auto :refresh ,refresh)))))
1103 (setf (records-cache-results target-args qualifier-args database) results)
1106 (let ((results (apply #'find-all target-args (append qualifier-args
1107 `(:result-types :auto :refresh ,refresh)))))
1108 (setf (records-cache-results target-args qualifier-args database) results)
1111 (let* ((expr (apply #'make-query select-all-args))
1113 (mapcar #'(lambda (attrib)
1114 (if (typep attrib 'sql-ident-attribute)
1115 (let ((type (slot-value attrib 'type)))
1120 (slot-value expr 'selections))))
1121 (destructuring-bind (&key (flatp nil)
1122 (result-types :auto)
1124 (database *default-database*)
1127 (query expr :flatp flatp
1129 ;; specifying a type for an attribute overrides result-types
1130 (if (some #'(lambda (x) (not (eq t x))) specified-types)
1133 :field-names field-names
1134 :database database))))))))
1136 (defun compute-records-cache-key (targets qualifiers)
1138 (do ((args *select-arguments* (cdr args))
1140 ((null args) results)
1141 (let* ((arg (car args))
1142 (value (getf qualifiers arg)))
1146 (cons (cons (sql (car value)) (cdr value)))
1147 (%sql-expression (sql value))
1151 (defun records-cache-results (targets qualifiers database)
1152 (when (record-caches database)
1153 (gethash (compute-records-cache-key targets qualifiers) (record-caches database))))
1155 (defun (setf records-cache-results) (results targets qualifiers database)
1156 (unless (record-caches database)
1157 (setf (record-caches database)
1158 (make-hash-table :test 'equal
1159 #+allegro :values #+allegro :weak
1160 #+clisp :weak #+clisp :value
1161 #+lispworks :weak-kind #+lispworks :value)))
1162 (setf (gethash (compute-records-cache-key targets qualifiers)
1163 (record-caches database)) results)
1168 ;;; Serialization functions
1170 (defun write-instance-to-stream (obj stream)
1171 "Writes an instance to a stream where it can be later be read.
1172 NOTE: an error will occur if a slot holds a value which can not be written readably."
1173 (let* ((class (class-of obj))
1175 (dolist (slot (ordered-class-slots (class-of obj)))
1176 (let ((name (slot-definition-name slot)))
1177 (when (and (not (eq 'view-database name))
1178 (slot-boundp obj name))
1179 (push (cons name (slot-value obj name)) alist))))
1180 (setq alist (reverse alist))
1181 (write (cons (class-name class) alist) :stream stream :readably t))
1184 (defun read-instance-from-stream (stream)
1185 (let ((raw (read stream nil nil)))
1187 (let ((obj (make-instance (car raw))))
1188 (dolist (pair (cdr raw))
1189 (setf (slot-value obj (car pair)) (cdr pair)))