1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
6 ;;;; The CLSQL Object Oriented Data Definitional Language (OODDL)
7 ;;;; and Object Oriented Data Manipulation Language (OODML).
9 ;;;; This file is part of CLSQL.
11 ;;;; CLSQL users are granted the rights to distribute and use this software
12 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
13 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
14 ;;;; *************************************************************************
16 (in-package #:clsql-sys)
18 (defclass standard-db-object ()
19 ((view-database :initform nil :initarg :view-database :reader view-database
21 (:metaclass standard-db-class)
22 (:documentation "Superclass for all CLSQL View Classes."))
24 (defvar *db-auto-sync* nil
25 "A non-nil value means that creating View Class instances or
26 setting their slots automatically creates/updates the
27 corresponding records in the underlying database.")
29 (defvar *db-deserializing* nil)
30 (defvar *db-initializing* nil)
32 (defmethod slot-value-using-class ((class standard-db-class) instance slot-def)
33 (declare (optimize (speed 3)))
34 (unless *db-deserializing*
35 (let* ((slot-name (%svuc-slot-name slot-def))
36 (slot-object (%svuc-slot-object slot-def class))
37 (slot-kind (view-class-slot-db-kind slot-object)))
38 (when (and (eql slot-kind :join)
39 (not (slot-boundp instance slot-name)))
40 (let ((*db-deserializing* t))
41 (if (view-database instance)
42 (setf (slot-value instance slot-name)
43 (fault-join-slot class instance slot-object))
44 (setf (slot-value instance slot-name) nil))))))
47 (defmethod (setf slot-value-using-class) (new-value (class standard-db-class)
49 (declare (ignore new-value))
50 (let* ((slot-name (%svuc-slot-name slot-def))
51 (slot-object (%svuc-slot-object slot-def class))
52 (slot-kind (view-class-slot-db-kind slot-object)))
54 (when (and *db-auto-sync*
55 (not *db-initializing*)
56 (not *db-deserializing*)
57 (not (eql slot-kind :virtual)))
58 (update-record-from-slot instance slot-name))))
60 (defmethod initialize-instance ((object standard-db-object)
61 &rest all-keys &key &allow-other-keys)
62 (declare (ignore all-keys))
63 (let ((*db-initializing* t))
65 (when (and *db-auto-sync*
66 (not *db-deserializing*))
67 (update-records-from-instance object))))
70 ;; Build the database tables required to store the given view class
73 (defun create-view-from-class (view-class-name
74 &key (database *default-database*))
75 "Creates a view in DATABASE based on VIEW-CLASS-NAME which defines
76 the view. The argument DATABASE has a default value of
78 (let ((tclass (find-class view-class-name)))
80 (let ((*default-database* database))
81 (%install-class tclass database))
82 (error "Class ~s not found." view-class-name)))
85 (defmethod %install-class ((self standard-db-class) database &aux schemadef)
86 (dolist (slotdef (ordered-class-slots self))
87 (let ((res (database-generate-column-definition (class-name self)
90 (push res schemadef))))
92 (error "Class ~s has no :base slots" self))
93 (create-table (sql-expression :table (view-table self)) schemadef
95 :constraints (database-pkey-constraint self database))
96 (push self (database-view-classes database))
99 (defmethod database-pkey-constraint ((class standard-db-class) database)
100 (let ((keylist (mapcar #'view-class-slot-column (keyslots-for-class class))))
102 (convert-to-db-default-case
103 (format nil "CONSTRAINT ~APK PRIMARY KEY~A"
104 (database-output-sql (view-table class) database)
105 (database-output-sql keylist database))
108 (defmethod database-generate-column-definition (class slotdef database)
109 (declare (ignore database class))
110 (when (member (view-class-slot-db-kind slotdef) '(:base :key))
112 (list (sql-expression :attribute (view-class-slot-column slotdef))
113 (specified-type slotdef))))
114 (setf cdef (append cdef (list (view-class-slot-db-type slotdef))))
115 (let ((const (view-class-slot-db-constraints slotdef)))
117 (setq cdef (append cdef (list const)))))
122 ;; Drop the tables which store the given view class
125 (defun drop-view-from-class (view-class-name &key (database *default-database*))
126 "Deletes a view or base table from DATABASE based on VIEW-CLASS-NAME
127 which defines that view. The argument DATABASE has a default value of
129 (let ((tclass (find-class view-class-name)))
131 (let ((*default-database* database))
132 (%uninstall-class tclass))
133 (error "Class ~s not found." view-class-name)))
136 (defun %uninstall-class (self &key (database *default-database*))
137 (drop-table (sql-expression :table (view-table self))
138 :if-does-not-exist :ignore
140 (setf (database-view-classes database)
141 (remove self (database-view-classes database))))
145 ;; List all known view classes
148 (defun list-classes (&key (test #'identity)
149 (root-class (find-class 'standard-db-object))
150 (database *default-database*))
151 "The LIST-CLASSES function collects all the classes below
152 ROOT-CLASS, which defaults to standard-db-object, that are connected
153 to the supplied DATABASE and which satisfy the TEST function. The
154 default for the TEST argument is identity. By default, LIST-CLASSES
155 returns a list of all the classes connected to the default database,
157 (flet ((find-superclass (class)
158 (member root-class (class-precedence-list class))))
159 (let ((view-classes (and database (database-view-classes database))))
161 (remove-if #'(lambda (c) (or (not (funcall test c))
162 (not (find-superclass c))))
166 ;; Define a new view class
169 (defmacro def-view-class (class supers slots &rest cl-options)
170 "Extends the syntax of defclass to allow special slots to be mapped
171 onto the attributes of database views. The macro DEF-VIEW-CLASS
172 creates a class called CLASS which maps onto a database view. Such a
173 class is called a View Class. The macro DEF-VIEW-CLASS extends the
174 syntax of DEFCLASS to allow special base slots to be mapped onto the
175 attributes of database views (presently single tables). When a select
176 query that names a View Class is submitted, then the corresponding
177 database view is queried, and the slots in the resulting View Class
178 instances are filled with attribute values from the database. If
179 SUPERS is nil then STANDARD-DB-OBJECT automatically becomes the
180 superclass of the newly-defined View Class."
182 (defclass ,class ,supers ,slots
183 ,@(if (find :metaclass `,cl-options :key #'car)
185 (cons '(:metaclass clsql-sys::standard-db-class) `,cl-options)))
186 (finalize-inheritance (find-class ',class))
187 (find-class ',class)))
189 (defun keyslots-for-class (class)
190 (slot-value class 'key-slots))
192 (defun key-qualifier-for-instance (obj &key (database *default-database*))
193 (let ((tb (view-table (class-of obj))))
196 (sql-expression :attribute
197 (view-class-slot-column k)
201 (slot-value obj (slot-definition-name k))
203 (let* ((keys (keyslots-for-class (class-of obj)))
204 (keyxprs (mapcar #'qfk (reverse keys))))
206 ((= (length keyxprs) 0) nil)
207 ((= (length keyxprs) 1) (car keyxprs))
208 ((> (length keyxprs) 1) (apply #'sql-operation 'and keyxprs)))))))
211 ;; Function used by 'generate-selection-list'
214 (defun generate-attribute-reference (vclass slotdef)
216 ((eq (view-class-slot-db-kind slotdef) :base)
217 (sql-expression :attribute (view-class-slot-column slotdef)
218 :table (view-table vclass)))
219 ((eq (view-class-slot-db-kind slotdef) :key)
220 (sql-expression :attribute (view-class-slot-column slotdef)
221 :table (view-table vclass)))
225 ;; Function used by 'find-all'
228 (defun generate-selection-list (vclass)
230 (dolist (slotdef (ordered-class-slots vclass))
231 (let ((res (generate-attribute-reference vclass slotdef)))
233 (push (cons slotdef res) sels))))
236 (error "No slots of type :base in view-class ~A" (class-name vclass)))))
240 (defun generate-retrieval-joins-list (vclass retrieval-method)
241 "Returns list of immediate join slots for a class."
242 (let ((join-slotdefs nil))
243 (dolist (slotdef (ordered-class-slots vclass) join-slotdefs)
244 (when (and (eq :join (view-class-slot-db-kind slotdef))
245 (eq retrieval-method (gethash :retrieval (view-class-slot-db-info slotdef))))
246 (push slotdef join-slotdefs)))))
248 (defun generate-immediate-joins-selection-list (vclass)
249 "Returns list of immediate join slots for a class."
251 (dolist (joined-slot (generate-retrieval-joins-list vclass :immediate) sels)
252 (let* ((join-class-name (gethash :join-class (view-class-slot-db-info joined-slot)))
253 (join-class (when join-class-name (find-class join-class-name))))
254 (dolist (slotdef (ordered-class-slots join-class))
255 (let ((res (generate-attribute-reference join-class slotdef)))
257 (push (cons slotdef res) sels))))))
261 ;; Called by 'get-slot-values-from-view'
264 (defvar *update-context* nil)
266 (defmethod update-slot-from-db ((instance standard-db-object) slotdef value)
267 (declare (optimize (speed 3) #+cmu (extensions:inhibit-warnings 3)))
268 (let* ((slot-reader (view-class-slot-db-reader slotdef))
269 (slot-name (slot-definition-name slotdef))
270 (slot-type (specified-type slotdef))
271 (*update-context* (cons (type-of instance) slot-name)))
272 (cond ((and value (null slot-reader))
273 (setf (slot-value instance slot-name)
274 (read-sql-value value (delistify slot-type)
275 (view-database instance))))
277 (update-slot-with-null instance slot-name slotdef))
278 ((typep slot-reader 'string)
279 (setf (slot-value instance slot-name)
280 (format nil slot-reader value)))
281 ((typep slot-reader 'function)
282 (setf (slot-value instance slot-name)
283 (apply slot-reader (list value))))
285 (error "Slot reader is of an unusual type.")))))
287 (defmethod key-value-from-db (slotdef value database)
288 (declare (optimize (speed 3) #+cmu (extensions:inhibit-warnings 3)))
289 (let ((slot-reader (view-class-slot-db-reader slotdef))
290 (slot-type (specified-type slotdef)))
291 (cond ((and value (null slot-reader))
292 (read-sql-value value (delistify slot-type) database))
295 ((typep slot-reader 'string)
296 (format nil slot-reader value))
297 ((typep slot-reader 'function)
298 (apply slot-reader (list value)))
300 (error "Slot reader is of an unusual type.")))))
302 (defun db-value-from-slot (slotdef val database)
303 (let ((dbwriter (view-class-slot-db-writer slotdef))
304 (dbtype (specified-type slotdef)))
306 (string (format nil dbwriter val))
307 (function (apply dbwriter (list val)))
311 (database-output-sql-as-type (car dbtype) val database))
313 (database-output-sql-as-type dbtype val database)))))))
315 (defun check-slot-type (slotdef val)
316 (let* ((slot-type (specified-type slotdef))
317 (basetype (if (listp slot-type) (car slot-type) slot-type)))
318 (when (and slot-type val)
319 (unless (typep val basetype)
320 (error 'sql-user-error
322 (format nil "Invalid value ~A in slot ~A, not of type ~A."
323 val (slot-definition-name slotdef) slot-type))))))
326 ;; Called by find-all
329 (defmethod get-slot-values-from-view (obj slotdeflist values)
330 (flet ((update-slot (slot-def values)
331 (update-slot-from-db obj slot-def values)))
332 (mapc #'update-slot slotdeflist values)
335 (defmethod update-record-from-slot ((obj standard-db-object) slot &key
336 (database *default-database*))
337 (let* ((database (or (view-database obj) database))
338 (vct (view-table (class-of obj)))
339 (sd (slotdef-for-slot-with-class slot (class-of obj))))
340 (check-slot-type sd (slot-value obj slot))
341 (let* ((att (view-class-slot-column sd))
342 (val (db-value-from-slot sd (slot-value obj slot) database)))
343 (cond ((and vct sd (view-database obj))
344 (update-records (sql-expression :table vct)
345 :attributes (list (sql-expression :attribute att))
347 :where (key-qualifier-for-instance
348 obj :database database)
350 ((and vct sd (not (view-database obj)))
351 (insert-records :into (sql-expression :table vct)
352 :attributes (list (sql-expression :attribute att))
355 (setf (slot-value obj 'view-database) database))
357 (error "Unable to update record.")))))
360 (defmethod update-record-from-slots ((obj standard-db-object) slots &key
361 (database *default-database*))
362 (let* ((database (or (view-database obj) database))
363 (vct (view-table (class-of obj)))
364 (sds (slotdefs-for-slots-with-class slots (class-of obj)))
365 (avps (mapcar #'(lambda (s)
366 (let ((val (slot-value
367 obj (slot-definition-name s))))
368 (check-slot-type s val)
369 (list (sql-expression
370 :attribute (view-class-slot-column s))
371 (db-value-from-slot s val database))))
373 (cond ((and avps (view-database obj))
374 (update-records (sql-expression :table vct)
376 :where (key-qualifier-for-instance
377 obj :database database)
379 ((and avps (not (view-database obj)))
380 (insert-records :into (sql-expression :table vct)
383 (setf (slot-value obj 'view-database) database))
385 (error "Unable to update records"))))
388 (defmethod update-records-from-instance ((obj standard-db-object)
389 &key (database *default-database*))
390 (let ((database (or (view-database obj) database)))
391 (labels ((slot-storedp (slot)
392 (and (member (view-class-slot-db-kind slot) '(:base :key))
393 (slot-boundp obj (slot-definition-name slot))))
394 (slot-value-list (slot)
395 (let ((value (slot-value obj (slot-definition-name slot))))
396 (check-slot-type slot value)
397 (list (sql-expression :attribute (view-class-slot-column slot))
398 (db-value-from-slot slot value database)))))
399 (let* ((view-class (class-of obj))
400 (view-class-table (view-table view-class))
401 (slots (remove-if-not #'slot-storedp
402 (ordered-class-slots view-class)))
403 (record-values (mapcar #'slot-value-list slots)))
404 (unless record-values
405 (error "No settable slots."))
406 (if (view-database obj)
407 (update-records (sql-expression :table view-class-table)
408 :av-pairs record-values
409 :where (key-qualifier-for-instance
410 obj :database database)
413 (insert-records :into (sql-expression :table view-class-table)
414 :av-pairs record-values
416 (setf (slot-value obj 'view-database) database))))))
419 (defmethod delete-instance-records ((instance standard-db-object))
420 (let ((vt (sql-expression :table (view-table (class-of instance))))
421 (vd (view-database instance)))
423 (let ((qualifier (key-qualifier-for-instance instance :database vd)))
424 (delete-records :from vt :where qualifier :database vd)
425 (setf (slot-value instance 'view-database) nil))
426 (signal-no-database-error vd))))
428 (defmethod update-instance-from-records ((instance standard-db-object)
429 &key (database *default-database*))
430 (let* ((view-class (find-class (class-name (class-of instance))))
431 (view-table (sql-expression :table (view-table view-class)))
432 (vd (or (view-database instance) database))
433 (view-qual (key-qualifier-for-instance instance :database vd))
434 (sels (generate-selection-list view-class))
435 (res (apply #'select (append (mapcar #'cdr sels)
436 (list :from view-table
438 (list :result-types nil)))))
440 (get-slot-values-from-view instance (mapcar #'car sels) (car res)))))
442 (defmethod update-slot-from-record ((instance standard-db-object)
443 slot &key (database *default-database*))
444 (let* ((view-class (find-class (class-name (class-of instance))))
445 (view-table (sql-expression :table (view-table view-class)))
446 (vd (or (view-database instance) database))
447 (view-qual (key-qualifier-for-instance instance :database vd))
448 (slot-def (slotdef-for-slot-with-class slot view-class))
449 (att-ref (generate-attribute-reference view-class slot-def))
450 (res (select att-ref :from view-table :where view-qual
453 (get-slot-values-from-view instance (list slot-def) (car res)))))
456 (defmethod update-slot-with-null ((object standard-db-object)
459 (setf (slot-value object slotname) (slot-value slotdef 'void-value)))
461 (defvar +no-slot-value+ '+no-slot-value+)
463 (defsql sql-slot-value (:symbol "slot-value") (classname slot &optional (value +no-slot-value+) (database *default-database*))
464 (let* ((class (find-class classname))
465 (sld (slotdef-for-slot-with-class slot class)))
467 (if (eq value +no-slot-value+)
468 (sql-expression :attribute (view-class-slot-column sld)
469 :table (view-table class))
474 (error "Unknown slot ~A for class ~A" slot classname))))
476 (defsql sql-view-class (:symbol "view-class") (classname &optional (database *default-database*))
477 (declare (ignore database))
478 (let* ((class (find-class classname)))
479 (unless (view-table class)
480 (error "No view-table for class ~A" classname))
481 (sql-expression :table (view-table class))))
483 (defmethod database-get-type-specifier (type args database)
484 (declare (ignore type args))
485 (if (in (database-underlying-type database)
486 :postgresql :postgresql-socket)
490 (defmethod database-get-type-specifier ((type (eql 'integer)) args database)
491 (declare (ignore database))
494 (format nil "INT(~A)" (car args))
498 "An integer larger than a 32-bit integer, this width may vary by SQL implementation."
501 (defmethod database-get-type-specifier ((type (eql 'bigint)) args database)
502 (declare (ignore args database))
505 (defmethod database-get-type-specifier ((type (eql 'simple-base-string)) args
508 (format nil "VARCHAR(~A)" (car args))
509 (if (in (database-underlying-type database)
510 :postgresql :postgresql-socket)
514 (defmethod database-get-type-specifier ((type (eql 'simple-string)) args
517 (format nil "VARCHAR(~A)" (car args))
518 (if (in (database-underlying-type database)
519 :postgresql :postgresql-socket)
523 (defmethod database-get-type-specifier ((type (eql 'string)) args database)
525 (format nil "VARCHAR(~A)" (car args))
526 (if (in (database-underlying-type database)
527 :postgresql :postgresql-socket)
531 (deftype universal-time ()
532 "A positive integer as returned by GET-UNIVERSAL-TIME."
535 (defmethod database-get-type-specifier ((type (eql 'universal-time)) args database)
536 (declare (ignore args database))
539 (defmethod database-get-type-specifier ((type (eql 'wall-time)) args database)
540 (declare (ignore args))
541 (case (database-underlying-type database)
542 ((:postgresql :postgresql-socket)
543 "TIMESTAMP WITHOUT TIME ZONE")
548 (defmethod database-get-type-specifier ((type (eql 'duration)) args database)
549 (declare (ignore database args))
552 (defmethod database-get-type-specifier ((type (eql 'money)) args database)
553 (declare (ignore database args))
556 (deftype raw-string (&optional len)
557 "A string which is not trimmed when retrieved from the database"
560 (defmethod database-get-type-specifier ((type (eql 'raw-string)) args database)
561 (declare (ignore database))
563 (format nil "VARCHAR(~A)" (car args))
566 (defmethod database-get-type-specifier ((type (eql 'float)) args database)
567 (declare (ignore database))
569 (format nil "FLOAT(~A)" (car args))
572 (defmethod database-get-type-specifier ((type (eql 'long-float)) args database)
573 (declare (ignore database))
575 (format nil "FLOAT(~A)" (car args))
578 (defmethod database-get-type-specifier ((type (eql 'boolean)) args database)
579 (declare (ignore args database))
582 (defmethod database-output-sql-as-type (type val database)
583 (declare (ignore type database))
586 (defmethod database-output-sql-as-type ((type (eql 'list)) val database)
587 (declare (ignore database))
588 (progv '(*print-circle* *print-array*) '(t t)
589 (let ((escaped (prin1-to-string val)))
590 (substitute-char-string
591 escaped #\Null " "))))
593 (defmethod database-output-sql-as-type ((type (eql 'symbol)) val database)
594 (declare (ignore database))
599 (package-name (symbol-package val))
604 (defmethod database-output-sql-as-type ((type (eql 'keyword)) val database)
605 (declare (ignore database))
610 (defmethod database-output-sql-as-type ((type (eql 'vector)) val database)
611 (declare (ignore database))
612 (progv '(*print-circle* *print-array*) '(t t)
613 (prin1-to-string val)))
615 (defmethod database-output-sql-as-type ((type (eql 'array)) val database)
616 (declare (ignore database))
617 (progv '(*print-circle* *print-array*) '(t t)
618 (prin1-to-string val)))
620 (defmethod database-output-sql-as-type ((type (eql 'boolean)) val database)
621 (case (database-underlying-type database)
627 (defmethod database-output-sql-as-type ((type (eql 'string)) val database)
628 (declare (ignore database))
631 (defmethod database-output-sql-as-type ((type (eql 'simple-string))
633 (declare (ignore database))
636 (defmethod database-output-sql-as-type ((type (eql 'simple-base-string))
638 (declare (ignore database))
641 (defmethod read-sql-value (val type database)
642 (declare (ignore type database))
643 (read-from-string val))
645 (defmethod read-sql-value (val (type (eql 'string)) database)
646 (declare (ignore database))
649 (defmethod read-sql-value (val (type (eql 'simple-string)) database)
650 (declare (ignore database))
653 (defmethod read-sql-value (val (type (eql 'simple-base-string)) database)
654 (declare (ignore database))
657 (defmethod read-sql-value (val (type (eql 'raw-string)) database)
658 (declare (ignore database))
661 (defmethod read-sql-value (val (type (eql 'keyword)) database)
662 (declare (ignore database))
663 (when (< 0 (length val))
664 (intern (symbol-name-default-case val)
665 (find-package '#:keyword))))
667 (defmethod read-sql-value (val (type (eql 'symbol)) database)
668 (declare (ignore database))
669 (when (< 0 (length val))
670 (unless (string= val (symbol-name-default-case "NIL"))
671 (intern (symbol-name-default-case val)
672 (symbol-package *update-context*)))))
674 (defmethod read-sql-value (val (type (eql 'integer)) database)
675 (declare (ignore database))
678 (unless (string-equal "NIL" val)
679 (parse-integer val)))
682 (defmethod read-sql-value (val (type (eql 'bigint)) database)
683 (declare (ignore database))
686 (unless (string-equal "NIL" val)
687 (parse-integer val)))
690 (defmethod read-sql-value (val (type (eql 'float)) database)
691 (declare (ignore database))
692 ;; writing 1.0 writes 1, so we we *really* want a float, must do (float ...)
695 (float (read-from-string val)))
699 (defmethod read-sql-value (val (type (eql 'boolean)) database)
700 (case (database-underlying-type database)
703 (string (if (string= "0" val) nil t))
704 (integer (if (zerop val) nil t))))
706 (if (eq :odbc (database-type database))
707 (if (string= "0" val) nil t)
712 (defmethod read-sql-value (val (type (eql 'univeral-time)) database)
713 (declare (ignore database))
714 (unless (eq 'NULL val)
720 (defmethod read-sql-value (val (type (eql 'wall-time)) database)
721 (declare (ignore database))
722 (unless (eq 'NULL val)
723 (parse-timestring val)))
725 (defmethod read-sql-value (val (type (eql 'duration)) database)
726 (declare (ignore database))
727 (unless (or (eq 'NULL val)
729 (parse-timestring val)))
731 ;; ------------------------------------------------------------
732 ;; Logic for 'faulting in' :join slots
734 ;; this works, but is inefficient requiring (+ 1 n-rows)
737 (defun fault-join-target-slot (class object slot-def)
738 (let* ((res (fault-join-slot-raw class object slot-def))
739 (dbi (view-class-slot-db-info slot-def))
740 (target-name (gethash :target-slot dbi))
741 (target-class (find-class target-name)))
743 (mapcar (lambda (obj)
749 (find target-name (class-slots (class-of obj))
750 :key #'slot-definition-name)))
753 #+ignore ;; this doesn't work when attempting to call slot-value
754 (mapcar (lambda (obj)
755 (cons obj (slot-value obj ts))) res))))
757 (defun fault-join-target-slot (class object slot-def)
758 (let* ((dbi (view-class-slot-db-info slot-def))
759 (ts (gethash :target-slot dbi))
760 (jc (gethash :join-class dbi))
761 (ts-view-table (view-table (find-class ts)))
762 (jc-view-table (view-table (find-class jc)))
763 (tdbi (view-class-slot-db-info
764 (find ts (class-slots (find-class jc))
765 :key #'slot-definition-name)))
766 (retrieval (gethash :retrieval tdbi))
767 (jq (join-qualifier class object slot-def))
768 (key (slot-value object (gethash :home-key dbi))))
774 :inner-join (sql-expression :table jc-view-table)
778 :attribute (gethash :foreign-key tdbi)
779 :table ts-view-table)
781 :attribute (gethash :home-key tdbi)
782 :table jc-view-table))
784 :result-types :auto)))
785 (mapcar #'(lambda (i)
786 (let* ((instance (car i))
787 (jcc (make-instance jc :view-database (view-database instance))))
788 (setf (slot-value jcc (gethash :foreign-key dbi))
790 (setf (slot-value jcc (gethash :home-key tdbi))
791 (slot-value instance (gethash :foreign-key tdbi)))
792 (list instance jcc)))
795 ;; just fill in minimal slots
798 (let ((instance (make-instance ts :view-database (view-database object)))
799 (jcc (make-instance jc :view-database (view-database object)))
801 (setf (slot-value instance (gethash :home-key tdbi)) fk)
802 (setf (slot-value jcc (gethash :foreign-key dbi))
804 (setf (slot-value jcc (gethash :home-key tdbi))
806 (list instance jcc)))
807 (select (sql-expression :attribute (gethash :foreign-key tdbi) :table jc-view-table)
808 :from (sql-expression :table jc-view-table)
814 (defvar *default-update-objects-max-len* nil
815 "The default maximum number of objects supplying data for a
816 query when updating remote joins.")
818 (defun update-object-joins (objects &key (slots t) (force-p t)
819 class-name (max-len *default-update-objects-max-len*))
820 "Updates the remote join slots, that is those slots defined without
821 :retrieval :immediate."
822 (assert (or (null max-len) (plusp max-len)))
825 (setq class-name (class-name (class-of (first objects)))))
826 (let* ((class (find-class class-name))
827 (class-slots (ordered-class-slots class))
830 (generate-retrieval-joins-list class :deferred)
832 (mapcar #'(lambda (name)
833 (let ((slotdef (find name class-slots :key #'slot-definition-name)))
835 (warn "Unable to find slot named ~S in class ~S." name class))
838 (dolist (slotdef slotdefs)
839 (let* ((dbi (view-class-slot-db-info slotdef))
840 (slotdef-name (slot-definition-name slotdef))
841 (foreign-key (gethash :foreign-key dbi))
842 (home-key (gethash :home-key dbi))
846 (mapcar #'(lambda (o) (slot-value o home-key)) objects)
849 #'(lambda (o) (if (slot-boundp o slotdef-name)
851 (slot-value o home-key)))
853 (n-object-keys (length object-keys))
854 (query-len (or max-len n-object-keys)))
856 (do ((i 0 (+ i query-len)))
857 ((>= i n-object-keys))
858 (let* ((keys (if max-len
859 (subseq object-keys i (min (+ i query-len) n-object-keys))
861 (results (find-all (list (gethash :join-class dbi))
862 :where (make-instance 'sql-relational-exp
864 :sub-expressions (list (sql-expression :attribute foreign-key)
868 (dolist (object objects)
869 (when (or force-p (not (slot-boundp object slotdef-name)))
870 (let ((res (find (slot-value object home-key) results
871 :key #'(lambda (res) (slot-value res foreign-key))
874 (setf (slot-value object slotdef-name) res)))))))))))
877 (defun fault-join-slot-raw (class object slot-def)
878 (let* ((dbi (view-class-slot-db-info slot-def))
879 (jc (gethash :join-class dbi)))
880 (let ((jq (join-qualifier class object slot-def)))
882 (select jc :where jq :flatp t :result-types nil)))))
884 (defun fault-join-slot (class object slot-def)
885 (let* ((dbi (view-class-slot-db-info slot-def))
886 (ts (gethash :target-slot dbi)))
887 (if (and ts (gethash :set dbi))
888 (fault-join-target-slot class object slot-def)
889 (let ((res (fault-join-slot-raw class object slot-def)))
892 ((and ts (not (gethash :set dbi)))
893 (mapcar (lambda (obj) (slot-value obj ts)) res))
894 ((and (not ts) (not (gethash :set dbi)))
896 ((and (not ts) (gethash :set dbi))
899 (defun join-qualifier (class object slot-def)
900 (declare (ignore class))
901 (let* ((dbi (view-class-slot-db-info slot-def))
902 (jc (find-class (gethash :join-class dbi)))
903 ;;(ts (gethash :target-slot dbi))
904 ;;(tsdef (if ts (slotdef-for-slot-with-class ts jc)))
905 (foreign-keys (gethash :foreign-key dbi))
906 (home-keys (gethash :home-key dbi)))
907 (when (every #'(lambda (slt)
908 (and (slot-boundp object slt)
909 (not (null (slot-value object slt)))))
910 (if (listp home-keys) home-keys (list home-keys)))
912 (mapcar #'(lambda (hk fk)
913 (let ((fksd (slotdef-for-slot-with-class fk jc)))
919 (view-class-slot-column fksd)
920 :table (view-table jc)))
924 (slot-value object hk))
927 (if (listp home-keys)
930 (if (listp foreign-keys)
932 (list foreign-keys)))))
934 (if (> (length jc) 1)
938 ;; FIXME: add retrieval immediate for efficiency
939 ;; For example, for (select 'employee-address) in test suite =>
940 ;; select addr.*,ea_join.* FROM addr,ea_join WHERE ea_join.aaddressid=addr.addressid\g
942 (defun build-objects (vals sclasses immediate-join-classes sels immediate-joins database refresh flatp instances)
943 "Used by find-all to build objects."
944 (labels ((build-object (vals vclass jclasses selects immediate-selects instance)
945 (let* ((db-vals (butlast vals (- (list-length vals)
946 (list-length selects))))
947 (obj (if instance instance (make-instance (class-name vclass) :view-database database)))
948 (join-vals (subseq vals (list-length selects)))
949 (joins (mapcar #'(lambda (c) (when c (make-instance c :view-database database)))
951 ;;(format t "db-vals: ~S, join-values: ~S~%" db-vals join-vals)
952 ;; use refresh keyword here
953 (setf obj (get-slot-values-from-view obj (mapcar #'car selects) db-vals))
954 (mapc #'(lambda (jc) (get-slot-values-from-view jc (mapcar #'car immediate-selects) join-vals))
958 (let ((slot (find (class-name (class-of jc)) (class-slots vclass)
959 :key #'(lambda (slot)
960 (when (and (eq :join (view-class-slot-db-kind slot))
961 (eq (slot-definition-name slot)
962 (gethash :join-class (view-class-slot-db-info slot))))
963 (slot-definition-name slot))))))
965 (setf (slot-value obj (slot-definition-name slot)) jc))))
967 (when refresh (instance-refreshed obj))
970 (mapcar #'(lambda (sclass jclass sel immediate-join instance)
972 (build-object vals sclass jclass sel immediate-join instance)
973 (setf vals (nthcdr (+ (list-length sel) (list-length immediate-join))
975 sclasses immediate-join-classes sels immediate-joins instances)))
976 (if (and flatp (= (length sclasses) 1))
980 (defun find-all (view-classes
982 &key all set-operation distinct from where group-by having
983 order-by offset limit refresh flatp result-types
985 (database *default-database*)
987 "Called by SELECT to generate object query results when the
988 View Classes VIEW-CLASSES are passed as arguments to SELECT."
989 (declare (ignore all set-operation group-by having offset limit inner-join on)
990 (optimize (debug 3) (speed 1)))
991 (labels ((ref-equal (ref1 ref2)
994 (table-sql-expr (table)
995 (sql-expression :table (view-table table)))
996 (tables-equal (table-a table-b)
997 (when (and table-a table-b)
998 (string= (string (slot-value table-a 'name))
999 (string (slot-value table-b 'name))))))
1003 (remf args :additional-fields)
1004 (remf args :result-types)
1005 (remf args :instances)
1006 (let* ((*db-deserializing* t)
1007 (sclasses (mapcar #'find-class view-classes))
1008 (immediate-join-slots
1009 (mapcar #'(lambda (c) (generate-retrieval-joins-list c :immediate)) sclasses))
1010 (immediate-join-classes
1011 (mapcar #'(lambda (jcs)
1012 (mapcar #'(lambda (slotdef)
1013 (find-class (gethash :join-class (view-class-slot-db-info slotdef))))
1015 immediate-join-slots))
1016 (immediate-join-sels (mapcar #'generate-immediate-joins-selection-list sclasses))
1017 (sels (mapcar #'generate-selection-list sclasses))
1018 (fullsels (apply #'append (mapcar #'append sels immediate-join-sels)))
1019 (sel-tables (collect-table-refs where))
1020 (tables (remove-if #'null
1021 (remove-duplicates (append (mapcar #'table-sql-expr sclasses)
1022 (mapcar #'(lambda (jcs)
1023 (mapcan #'(lambda (jc)
1024 (when jc (table-sql-expr jc)))
1026 immediate-join-classes)
1028 :test #'tables-equal)))
1029 (order-by-slots (mapcar #'(lambda (ob) (if (atom ob) ob (car ob)))
1030 (listify order-by))))
1032 (dolist (ob order-by-slots)
1033 (when (and ob (not (member ob (mapcar #'cdr fullsels)
1034 :test #'ref-equal)))
1036 (append fullsels (mapcar #'(lambda (att) (cons nil att))
1038 (dolist (ob (listify distinct))
1039 (when (and (typep ob 'sql-ident)
1040 (not (member ob (mapcar #'cdr fullsels)
1041 :test #'ref-equal)))
1043 (append fullsels (mapcar #'(lambda (att) (cons nil att))
1045 (mapcar #'(lambda (vclass jclasses jslots)
1048 #'(lambda (jclass jslot)
1049 (let ((dbi (view-class-slot-db-info jslot)))
1052 (list (sql-operation '==
1054 :attribute (gethash :foreign-key dbi)
1055 :table (view-table jclass))
1057 :attribute (gethash :home-key dbi)
1058 :table (view-table vclass))))
1059 (when where (listify where))))))
1061 sclasses immediate-join-classes immediate-join-slots)
1062 (let* ((rows (apply #'select
1063 (append (mapcar #'cdr fullsels)
1065 (list (append (when from (listify from))
1067 (list :result-types result-types)
1068 (when where (list :where where))
1070 (instances-to-add (- (length rows) (length instances)))
1071 (perhaps-extended-instances
1072 (if (plusp instances-to-add)
1073 (append instances (do ((i 0 (1+ i))
1075 ((= i instances-to-add) res)
1076 (push (make-list (length sclasses) :initial-element nil) res)))
1079 #'(lambda (row instance)
1080 (build-objects row sclasses immediate-join-classes sels
1081 immediate-join-sels database refresh flatp
1082 (if (and flatp (atom instance))
1085 rows perhaps-extended-instances)))
1088 (defmethod instance-refreshed ((instance standard-db-object)))
1090 (defun select (&rest select-all-args)
1091 "The function SELECT selects data from DATABASE, which has a
1092 default value of *DEFAULT-DATABASE*, given the constraints
1093 specified by the rest of the ARGS. It returns a list of objects
1094 as specified by SELECTIONS. By default, the objects will each be
1095 represented as lists of attribute values. The argument SELECTIONS
1096 consists either of database identifiers, type-modified database
1097 identifiers or literal strings. A type-modifed database
1098 identifier is an expression such as [foo :string] which means
1099 that the values in column foo are returned as Lisp strings. The
1100 FLATP argument, which has a default value of nil, specifies if
1101 full bracketed results should be returned for each matched
1102 entry. If FLATP is nil, the results are returned as a list of
1103 lists. If FLATP is t, the results are returned as elements of a
1104 list, only if there is only one result per row. The arguments
1105 ALL, SET-OPERATION, DISTINCT, FROM, WHERE, GROUP-BY, HAVING and
1106 ORDER-by have the same function as the equivalent SQL expression.
1107 The SELECT function is common across both the functional and
1108 object-oriented SQL interfaces. If selections refers to View
1109 Classes then the select operation becomes object-oriented. This
1110 means that SELECT returns a list of View Class instances, and
1111 SLOT-VALUE becomes a valid SQL operator for use within the where
1112 clause. In the View Class case, a second equivalent select call
1113 will return the same View Class instance objects. If REFRESH is
1114 true, then existing instances are updated if necessary, and in
1115 this case you might need to extend the hook INSTANCE-REFRESHED.
1116 The default value of REFRESH is nil. SQL expressions used in the
1117 SELECT function are specified using the square bracket syntax,
1118 once this syntax has been enabled using
1119 ENABLE-SQL-READER-SYNTAX."
1121 (flet ((select-objects (target-args)
1123 (every #'(lambda (arg)
1125 (find-class arg nil)))
1127 (multiple-value-bind (target-args qualifier-args)
1128 (query-get-selections select-all-args)
1129 (unless (or *default-database* (getf qualifier-args :database))
1130 (signal-no-database-error nil))
1133 ((select-objects target-args)
1134 (let ((caching (getf qualifier-args :caching t))
1135 (result-types (getf qualifier-args :result-types :auto))
1136 (refresh (getf qualifier-args :refresh nil))
1137 (database (or (getf qualifier-args :database) *default-database*))
1138 (order-by (getf qualifier-args :order-by)))
1139 (remf qualifier-args :caching)
1140 (remf qualifier-args :refresh)
1141 (remf qualifier-args :result-types)
1144 ;; Add explicity table name to order-by if not specified and only
1145 ;; one selected table. This is required so FIND-ALL won't duplicate
1147 (when (and order-by (= 1 (length target-args)))
1148 (let ((table-name (view-table (find-class (car target-args))))
1149 (order-by-list (copy-seq (listify order-by))))
1151 (loop for i from 0 below (length order-by-list)
1152 do (etypecase (nth i order-by-list)
1153 (sql-ident-attribute
1154 (unless (slot-value (nth i order-by-list) 'qualifier)
1155 (setf (slot-value (nth i order-by-list) 'qualifier) table-name)))
1157 (unless (slot-value (car (nth i order-by-list)) 'qualifier)
1158 (setf (slot-value (car (nth i order-by-list)) 'qualifier) table-name)))))
1159 (setf (getf qualifier-args :order-by) order-by-list)))
1163 (apply #'find-all target-args
1164 (append qualifier-args (list :result-types result-types))))
1166 (let ((cached (records-cache-results target-args qualifier-args database)))
1168 ((and cached (not refresh))
1170 ((and cached refresh)
1171 (let ((results (apply #'find-all (append (list target-args) qualifier-args `(:instances ,cached :result-types :auto)))))
1172 (setf (records-cache-results target-args qualifier-args database) results)
1175 (let ((results (apply #'find-all target-args (append qualifier-args
1176 '(:result-types :auto)))))
1177 (setf (records-cache-results target-args qualifier-args database) results)
1180 (let* ((expr (apply #'make-query select-all-args))
1182 (mapcar #'(lambda (attrib)
1183 (if (typep attrib 'sql-ident-attribute)
1184 (let ((type (slot-value attrib 'type)))
1189 (slot-value expr 'selections))))
1190 (destructuring-bind (&key (flatp nil)
1191 (result-types :auto)
1193 (database *default-database*)
1196 (query expr :flatp flatp
1198 ;; specifying a type for an attribute overrides result-types
1199 (if (some #'(lambda (x) (not (eq t x))) specified-types)
1202 :field-names field-names
1203 :database database))))))))
1205 (defun compute-records-cache-key (targets qualifiers)
1207 (do ((args *select-arguments* (cdr args))
1209 ((null args) results)
1210 (let* ((arg (car args))
1211 (value (getf qualifiers arg)))
1215 (cons (cons (sql (car value)) (cdr value)))
1216 (%sql-expression (sql value))
1220 (defun records-cache-results (targets qualifiers database)
1221 (when (record-caches database)
1222 (gethash (compute-records-cache-key targets qualifiers) (record-caches database))))
1224 (defun (setf records-cache-results) (results targets qualifiers database)
1225 (unless (record-caches database)
1226 (setf (record-caches database)
1227 (make-hash-table :test 'equal
1228 #+allegro :values #+allegro :weak)))
1229 (setf (gethash (compute-records-cache-key targets qualifiers)
1230 (record-caches database)) results)
1233 (defun update-cached-results (targets qualifiers database)
1234 ;; FIXME: this routine will need to update slots in cached objects, perhaps adding or removing objects from cached
1235 ;; for now, dump cache entry and perform fresh search
1236 (let ((res (apply #'find-all targets qualifiers)))
1237 (setf (gethash (compute-records-cache-key targets qualifiers)
1238 (record-caches database)) res)