1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
4 ;;;; The CLSQL Object Oriented Data Manipulation Language (OODML).
6 ;;;; This file is part of CLSQL.
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 ;;;; *************************************************************************
13 (in-package #:clsql-sys)
15 (defun find-normalized-key (obj)
16 "Find the first / primary key of a normalized object"
17 (find-slot-if obj #'key-slot-p T T))
19 (defun normalized-key-value (obj)
20 "Normalized classes share a single key for all their key slots"
21 (when (normalizedp (class-of obj))
22 (easy-slot-value obj (find-normalized-key obj))))
24 (defun key-qualifier-for-instance (obj &key (database *default-database*) this-class)
25 "Generate a boolean sql-expression that identifies an object by its keys"
26 (let* ((obj-class (or this-class (class-of obj)))
27 (keys (keyslots-for-class obj-class))
28 (normal-db-value (normalized-key-value obj)))
30 (labels ((db-value (k)
34 (easy-slot-value obj k)
37 (sql-operation '== (generate-attribute-reference obj-class k database)
39 (clsql-ands (mapcar #'key-equal-exp keys))))))
41 (defun generate-attribute-reference (vclass slotdef &optional (database *default-database*))
42 "Turns key class and slot-def into a sql-expression representing the
43 table and column it comes from
45 used by things like make-select-list, update-slot-from-record"
46 (when (key-or-base-slot-p slotdef)
47 (sql-expression :attribute (database-identifier slotdef database)
48 :table (database-identifier vclass database))))
50 (defun get-join-slots (class &optional retrieval-method)
51 "Returns list of join slots for a class.
53 if a retrieval method is specified only return slots of that type
54 if the retrieval method is T, nil or :all return all join slots"
55 (assert (member retrieval-method '(nil t :all :immediate :deferred)))
56 (setf class (to-class class))
57 (let ((all? (member retrieval-method '(nil t :all))))
58 (loop for slot in (ordered-class-slots class)
59 when (and (join-slot-p slot)
60 (or all? (eql (join-slot-retrieval-method slot) retrieval-method)))
63 (defun immediate-join-slots (class)
64 (get-join-slots class :immediate))
66 (defmethod choose-database-for-instance ((obj standard-db-object) &optional database)
67 "Determine which database connection to use for a standard-db-object.
68 Errs if none is available."
69 (or (find-if #'(lambda (db)
70 (and db (is-database-open db)))
71 (list (view-database obj)
74 (signal-no-database-error nil)))
78 (defmethod update-slot-with-null ((object standard-db-object) slotdef)
79 "sets a slot to the void value of the slot-def (usually nil)"
80 (setf (easy-slot-value object slotdef)
81 (slot-value slotdef 'void-value)))
83 (defmethod update-slot-from-db-value ((instance standard-db-object) slotdef value)
84 "This gets a value from the database and turns it itno a lisp value
85 based on the slot's slot-db-reader or baring that read-sql-value"
86 (declare (optimize (speed 3) #+cmu (extensions:inhibit-warnings 3)))
87 (let* ((slot-reader (view-class-slot-db-reader slotdef))
88 (slot-type (specified-type slotdef)))
90 ((null value) (update-slot-with-null instance slotdef))
92 (setf (easy-slot-value instance slotdef)
93 (read-sql-value value (delistify slot-type)
94 (choose-database-for-instance instance)
95 (database-underlying-type
96 (choose-database-for-instance instance)))))
97 (t (etypecase slot-reader
99 (setf (easy-slot-value instance slotdef)
100 (apply slot-reader (list value))))
102 (setf (easy-slot-value instance slotdef)
103 (format nil slot-reader value))))))))
105 (defmethod key-value-from-db (slotdef value database)
106 "TODO: is this deprecated? there are no uses anywhere in clsql"
107 (declare (optimize (speed 3) #+cmu (extensions:inhibit-warnings 3)))
108 (let ((slot-reader (view-class-slot-db-reader slotdef))
109 (slot-type (specified-type slotdef)))
110 (cond ((and value (null slot-reader))
111 (read-sql-value value (delistify slot-type) database
112 (database-underlying-type database)))
115 ((typep slot-reader 'string)
116 (format nil slot-reader value))
117 ((typep slot-reader '(or symbol function))
118 (apply slot-reader (list value)))
120 (error "Slot reader is of an unusual type.")))))
122 (defun db-value-from-slot (slotdef val database)
123 (let ((dbwriter (view-class-slot-db-writer slotdef))
124 (dbtype (specified-type slotdef)))
126 (string (format nil dbwriter val))
127 ((and (or symbol function) (not null)) (apply dbwriter (list val)))
129 (database-output-sql-as-type
133 val database (database-underlying-type database))))))
135 (defun check-slot-type (slotdef val)
136 (let* ((slot-type (specified-type slotdef))
137 (basetype (if (listp slot-type) (car slot-type) slot-type)))
138 (when (and slot-type val)
139 (unless (typep val basetype)
140 (error 'sql-user-error
142 (format nil "Invalid value ~A in slot ~A, not of type ~A."
143 val (slot-definition-name slotdef) slot-type))))))
145 (defmethod get-slot-values-from-view (obj slotdeflist values)
146 "Used to copy values from the database into the object
147 used by things like find-all and select"
148 (loop for slot in slotdeflist
150 do (update-slot-from-db-value obj slot value))
153 (defclass class-and-slots ()
154 ((view-class :accessor view-class :initarg :view-class :initform nil)
155 (slot-defs :accessor slot-defs :initarg :slot-defs :initform nil))
156 (:documentation "A helper class to keep track of which slot-defs from a
157 table need to be updated, a normalized class might have many of these
158 because each of its parent classes might represent some other table and we
159 need to match which slots came from which parent class/table"))
161 (defun make-class-and-slots (c &optional s)
162 "Create a new class-and-slots object"
163 (make-instance 'class-and-slots :view-class c :slot-defs (listify s) ))
165 (defmethod view-table ((o class-and-slots))
166 "get the view-table of the view-class of o"
167 (view-table (view-class o)))
169 (defmethod view-table-exp ((o class-and-slots))
170 (sql-expression :table (view-table o)))
172 (defmethod view-table-exp ((o standard-db-class))
173 (sql-expression :table (view-table o)))
175 (defmethod attribute-references ((o class-and-slots))
176 "build sql-ident-attributes for a given class-and-slots"
178 with class = (view-class o)
179 for sd in (slot-defs o)
180 collect (generate-attribute-reference class sd)))
182 (defmethod attribute-value-pairs ((def class-and-slots) (o standard-db-object)
184 "for a given class-and-slots and object, create the sql-expression & value pairs
185 that need to be sent to the database"
186 (loop for s in (slot-defs def)
187 for n = (to-slot-name s)
188 when (slot-boundp o n)
189 collect (make-attribute-value-pair s (slot-value o n) database)))
191 (defmethod view-classes-and-slots-by-name ((obj standard-db-object) slots-to-match)
192 "If it's normalized, find the class that actually contains
193 the slot that's tied to the db,
195 otherwise just search the current class
197 (let* ((view-class (class-of obj))
198 (normalizedp (normalizedp view-class))
200 (labels ((get-c&s-obj (class)
201 (or (find class rtns :key #'view-class)
202 (first (push (make-class-and-slots class) rtns))))
203 (associate-slot-with-class (class slot)
204 "Find the best class to associate with the slot. If it is
205 normalized then it needs to be a direct slot otherwise it just
206 needs to be on the class."
207 (let ((sd (find-slot-by-name class slot normalizedp nil)))
209 ;;we found it directly or it's (not normalized)
210 (pushnew sd (slot-defs (get-c&s-obj class)))
212 (loop for parent in (class-direct-superclasses class)
213 until (associate-slot-with-class parent slot))))
216 for in-slot in (listify slots-to-match)
217 do (associate-slot-with-class view-class in-slot)))
220 (defun update-auto-increments-keys (class obj database)
221 " handle pulling any autoincrement values into the object
222 Also handles normalized key chaining"
223 (let ((pk-slots (keyslots-for-class class))
224 (table (view-table class))
226 (labels ((do-update (slot &aux (val (easy-slot-value obj slot)))
228 (setf new-pk-value val)
229 (update-slot-from-db-value
233 (database-last-auto-increment-id
234 database table slot))))))
235 ;; NB: This interacts very strangely with autoincrement keys
236 ;; (see changelog 2014-01-30)
237 (chain-primary-keys (in-class)
238 "This seems kindof wrong, but this is mostly how it was working, so
239 its here to keep the normalized code path working"
240 (when (typep in-class 'standard-db-class)
241 (loop for slot in (ordered-class-slots in-class)
242 when (key-slot-p slot)
243 do (do-update slot)))))
244 (loop for slot in pk-slots do (do-update slot))
245 (let ((direct-class (to-class obj)))
246 (when (and new-pk-value (normalizedp direct-class))
247 (chain-primary-keys direct-class)))
250 (defmethod %update-instance-helper
251 (class-and-slots obj database
252 &aux (avps (attribute-value-pairs class-and-slots obj database)))
253 "A function to help us update a given table (based on class-and-slots)
254 with values from an object"
255 ;; we dont actually need to update anything on this particular
256 ;; class / parent class
257 (unless avps (return-from %update-instance-helper))
259 (let* ((view-class (view-class class-and-slots))
260 (table (view-table view-class))
261 (table-sql (sql-expression :table table)))
263 ;; view database is the flag we use to tell it was pulled from a database
264 ;; and thus probably needs an update instead of an insert
265 (cond ((view-database obj)
266 (let ((where (key-qualifier-for-instance
267 obj :database database :this-class view-class)))
269 (error "update-record-from-*: could not generate a where clause for ~a using ~A"
271 (update-records table-sql
274 :database database)))
275 (T ;; was not pulled from the db so insert it
276 ;; avps MUST contain any primary key slots set
277 ;; by previous inserts of the same object into different
278 ;; tables (ie: normalized stuff)
279 (insert-records :into table-sql
282 ;; also handles normalized-class key chaining
283 (update-auto-increments-keys view-class obj database)
284 ;; we dont set view database here, because there could be
285 ;; N of these for each call to update-record-from-* because
286 ;; of normalized classes
288 (update-slot-default-values obj class-and-slots)))
290 (defmethod update-record-from-slots ((obj standard-db-object) slots
291 &key (database *default-database*))
292 "For a given list of slots, update all records associated with those slots
295 Generally this will update the single record associated with this object,
296 but for normalized classes might update as many records as there are
298 (setf slots (listify slots))
299 (let* ((classes-and-slots (view-classes-and-slots-by-name obj slots))
300 (database (choose-database-for-instance obj database)))
301 (loop for class-and-slots in classes-and-slots
302 do (%update-instance-helper class-and-slots obj database))
303 (setf (slot-value obj 'view-database) database))
306 (defmethod update-record-from-slot
307 ((obj standard-db-object) slot &key (database *default-database*))
308 "just call update-records-from-slots which now handles this.
310 This function is only here to maintain backwards compatibility in
312 (update-record-from-slots obj slot :database database))
314 (defmethod view-classes-and-storable-slots (class &key to-database-p)
315 "Get a list of all the tables we need to update and the slots on them
317 for non normalized classes we return the class and all its storable slots
319 for normalized classes we return a list of direct slots and the class they
320 came from for each normalized view class
322 to-database-p is provided so that we can read / write different data
323 to the database in different circumstances
324 (specifically clsql-helper:dirty-db-slots-mixin which only updates slots
327 (setf class (to-class class))
329 (labels ((storable-slots (class)
330 (loop for sd in (slots-for-possibly-normalized-class class)
331 when (and (key-or-base-slot-p sd)
332 ;; we dont want to insert/update auto-increments
333 ;; but we do read them
334 (not (and to-database-p (auto-increment-column-p sd))))
336 (get-classes-and-slots (class &aux (normalizedp (normalizedp class)))
337 (let ((slots (storable-slots class)))
339 (push (make-class-and-slots class slots) rtns)))
341 (loop for new-class in (class-direct-superclasses class)
342 do (when (typep new-class 'standard-db-class)
343 (get-classes-and-slots new-class))))))
344 (get-classes-and-slots class))
347 (defmethod primary-key-slot-values ((obj standard-db-object)
349 "Returns the values of all key-slots for a given class"
350 (defaulting class (class-of obj)
351 slots (keyslots-for-class class))
352 (loop for slot in slots
353 collect (easy-slot-value obj slot)))
355 (defmethod update-slot-default-values ((obj standard-db-object)
357 "Makes sure that if a class has unfilled slots that claim to have a default,
358 that we retrieve those defaults from the database
360 TODO: use update-slots-from-record (doesnt exist) instead to batch this!"
361 (loop for class-and-slots in (listify classes-and-slots)
362 do (loop for slot in (slot-defs class-and-slots)
363 do (when (and (slot-has-default-p slot)
364 (not (easy-slot-value obj slot)))
365 (update-slot-from-record obj (to-slot-name slot))))))
367 (defmethod update-records-from-instance ((obj standard-db-object)
368 &key (database *default-database*))
369 "Updates the records in the database associated with this object if
370 view-database slot on the object is nil then the object is assumed to be
372 (let ((database (choose-database-for-instance obj database))
373 (classes-and-slots (view-classes-and-storable-slots obj :to-database-p t)))
374 (loop for class-and-slots in classes-and-slots
375 do (%update-instance-helper class-and-slots obj database))
376 (setf (slot-value obj 'view-database) database)
377 (primary-key-slot-values obj)))
379 (defmethod delete-instance-records ((instance standard-db-object) &key database)
380 "Removes the records associated with a given instance
381 (as determined by key-qualifier-for-instance)
383 TODO: Doesnt handle normalized classes at all afaict"
384 (let ((database (choose-database-for-instance instance database))
385 (vt (sql-expression :table (view-table (class-of instance)))))
387 (let ((qualifier (key-qualifier-for-instance instance :database database)))
388 (delete-records :from vt :where qualifier :database database)
389 (setf (record-caches database) nil)
390 (setf (slot-value instance 'view-database) nil)
392 (signal-no-database-error database))))
394 (defmethod update-instance-from-records ((instance standard-db-object)
395 &key (database *default-database*))
396 "Updates a database object with the current values stored in the database
398 TODO: Should this update immediate join slots similar to build-objects?
399 Can we just call build-objects?, update-objects-joins?
402 (let* ((classes-and-slots (view-classes-and-storable-slots
403 instance :to-database-p nil))
404 (vd (choose-database-for-instance instance database)))
405 (labels ((do-update (class-and-slots)
406 (let* ((select-list (make-select-list class-and-slots
409 (view-table (sql-table select-list))
410 (view-qual (key-qualifier-for-instance
411 instance :database vd
412 :this-class (view-class select-list)))
416 (append (full-select-list select-list)
417 (list :from view-table
422 (setf (slot-value instance 'view-database) vd)
423 (get-slot-values-from-view instance (slot-list select-list) res))
425 (loop for class-and-slots in classes-and-slots
426 do (do-update class-and-slots)))))
429 (defmethod get-slot-value-from-record ((instance standard-db-object)
430 slot &key (database *default-database*))
431 (let* ((class-and-slot
433 (view-classes-and-slots-by-name instance slot)))
434 (view-class (view-class class-and-slot))
435 (slot-def (first (slot-defs class-and-slot)))
436 (vd (choose-database-for-instance instance database))
437 (att-ref (first (attribute-references class-and-slot)))
440 :from (view-table-exp class-and-slot)
441 :where (key-qualifier-for-instance
444 :this-class view-class)
447 (values res slot-def)))
449 (defmethod update-slot-from-record ((instance standard-db-object)
450 slot &key (database *default-database*))
451 "Pulls the value of a given slot form the database and stores that in the
452 appropriate slot on instance"
453 (multiple-value-bind (res slot-def)
454 (get-slot-value-from-record instance slot :database database)
455 (let ((vd (choose-database-for-instance instance database)))
456 (setf (slot-value instance 'view-database) vd)
457 (update-slot-from-db-value instance slot-def res))))
460 (defvar +no-slot-value+ '+no-slot-value+)
462 (defsql sql-slot-value (:symbol "slot-value") (classname slot &optional (value +no-slot-value+) (database *default-database*))
463 (let* ((class (find-class classname))
464 (sld (slotdef-for-slot-with-class slot class)))
466 (if (eq value +no-slot-value+)
467 (sql-expression :attribute (database-identifier sld database)
468 :table (view-table class))
473 (error "Unknown slot ~A for class ~A" slot classname))))
475 (defsql sql-view-class (:symbol "view-class") (classname &optional (database *default-database*))
476 (declare (ignore database))
477 (let* ((class (find-class classname)))
478 (unless (view-table class)
479 (error "No view-table for class ~A" classname))
480 (sql-expression :table (view-table class))))
483 "An 8-bit integer, this width may vary by SQL implementation."
487 "An integer smaller than a 32-bit integer. this width may vary by SQL implementation."
490 (deftype mediumint ()
491 "An integer smaller than a 32-bit integer, but may be larger than a smallint. This width may vary by SQL implementation."
495 "An integer larger than a 32-bit integer, this width may vary by SQL implementation."
498 (deftype varchar (&optional size)
499 "A variable length string for the SQL varchar type."
500 (declare (ignore size))
503 (deftype universal-time ()
504 "A positive integer as returned by GET-UNIVERSAL-TIME."
507 (deftype generalized-boolean ()
508 "A type which outputs a SQL boolean value, though any lisp type can be stored in the slot."
512 (deftype char (&optional len)
513 "A lisp type for the SQL CHAR type."
516 (defmethod database-get-type-specifier ((type string) args database (db-type t))
517 "Pass through the literal type as defined in the type string"
518 (declare (ignore args database db-type))
522 (defmethod database-get-type-specifier ((type symbol) args database db-type)
525 (format nil "CHAR(~D)" (first args))
527 ((varchar string symbol keyword)
529 (format nil "VARCHAR(~A)" (car args))
530 (format nil "VARCHAR(~D)" *default-string-length*)))
531 ((longchar text) "text")
533 (format nil "INT(~A)" (car args))
535 ((tinyint smallint mediumint) "INT")
538 (format nil "FLOAT(~A)" (car args))
540 ((bigint universal-time) "BIGINT")
543 ((and (consp args) (= (length args) 2))
544 (format nil "NUMBER(~D,~D)" (first args) (second args)))
545 ((and (consp args) (= (length args) 1))
546 (format nil "NUMBER(~D)" (first args)))
549 (wall-time "TIMESTAMP")
553 ((boolean generalized-boolean) "BOOL")
554 (t (warn "Could not determine a valid ~A type specifier for ~A ~A ~A, defaulting to VARCHAR "
555 db-type type args database)
556 (format nil "VARCHAR(~D)" *default-string-length*))))
558 (defun print-readable-symbol (in &aux (*package* (find-package :keyword))
559 (*print-readably* t))
560 (prin1-to-string in))
562 (defmethod database-output-sql-as-type
563 (type val database db-type
565 (*print-circle* t) (*print-array* t)
566 (*print-length* nil) (*print-base* #10r10))
567 (declare (ignore database))
570 ((member type '(boolean generalized-boolean))
571 ;; booleans handle null differently
573 ;; done here so it can be done once
574 ((:mssql :mysql) (if val 1 0))
575 (otherwise (if val "t" "f"))))
577 (when (next-method-p)
582 (print-readable-symbol val))
585 (character (write-to-string val))
587 (float (format nil "~F" val))
589 (prin1-to-string val))
596 (defmethod read-sql-value :around
597 (val type database db-type
598 ;; never eval while reading values, always read base 10
599 &aux *read-eval* (*read-base* #10r10))
600 (declare (ignore db-type))
602 ;; null value or type
603 ((or (equalp "nil" val) (eql 'null val)) nil)
605 ;; no specified type or already the right type
607 (ignore-errors (typep val type)))
612 (let ((res (handler-bind
613 ;; all errors should be converted to sql-value-conversion-error
615 (when *debugger-hook*
617 (unless (typep c 'sql-value-conversion-error)
618 (error-converting-value val type database)))))
619 (call-next-method))))
620 ;; if we didnt get the right type after converting, we should probably
622 (maybe-error-converting-value
623 res val type database)))))
625 (defmethod read-sql-value (val type database db-type)
626 ;; errors, nulls and preconverted types are already handled in around
630 ((string varchar) val)
631 (char (string (schar val 0)))
633 (read-from-string val))
634 ((smallint mediumint bigint integer universal-time)
636 ((double-float float)
637 ;; ensure that whatever we got is coerced to a float of the correct
638 ;; type (eg: 1=>1.0d0)
641 (string (let ((*read-default-float-format*
643 (float 'single-float)
644 (double-float 'double-float))))
645 (read-from-string val)))
646 ;; maybe wrong type of float
648 (if (eql type 'double-float) 1.0d0 1.0s0)))
649 (number (read-from-string val))
650 ((boolean generalized-boolean)
651 (if (member val '(nil t))
655 (when (member val '("1" "t" "true" "y") :test #'string-equal)
657 (number (not (zerop val))))))
658 ((wall-time duration) (parse-timestring val))
659 (date (parse-datestring val))
660 (list (let ((*read-eval* nil))
661 (read-from-string val)))
662 (t (error-converting-value val type database))))
665 (let ((*read-eval* nil))
666 (read-from-string val)))
667 (t (error-converting-value val type database))))))
669 ;; ------------------------------------------------------------
670 ;; Logic for 'faulting in' :join slots
672 ;; this works, but is inefficient requiring (+ 1 n-rows)
675 (defun fault-join-target-slot (class object slot-def)
676 (let* ((res (fault-join-slot-raw class object slot-def))
677 (dbi (view-class-slot-db-info slot-def))
678 (target-name (gethash :target-slot dbi))
679 (target-class (find-class target-name)))
681 (mapcar (lambda (obj)
687 (find target-name (class-slots (class-of obj))
688 :key #'slot-definition-name)))
691 #+ignore ;; this doesn't work when attempting to call slot-value
692 (mapcar (lambda (obj)
693 (cons obj (slot-value obj ts))) res))))
695 (defun fault-join-target-slot (class object slot-def)
696 (let* ((dbi (view-class-slot-db-info slot-def))
697 (ts (gethash :target-slot dbi))
698 (jc (gethash :join-class dbi))
699 (jc-view-table (view-table (find-class jc)))
700 (tdbi (view-class-slot-db-info
701 (find ts (class-slots (find-class jc))
702 :key #'slot-definition-name)))
703 (retrieval (gethash :retrieval tdbi))
704 (tsc (gethash :join-class tdbi))
705 (ts-view-table (view-table (find-class tsc)))
706 (jq (join-qualifier class object slot-def))
707 (key (slot-value object (gethash :home-key dbi))))
714 :inner-join (sql-expression :table jc-view-table)
718 :attribute (gethash :foreign-key tdbi)
719 :table ts-view-table)
721 :attribute (gethash :home-key tdbi)
722 :table jc-view-table))
725 :database (choose-database-for-instance object))))
726 (mapcar #'(lambda (i)
727 (let* ((instance (car i))
728 (jcc (make-instance jc :view-database (choose-database-for-instance instance))))
729 (setf (slot-value jcc (gethash :foreign-key dbi))
731 (setf (slot-value jcc (gethash :home-key tdbi))
732 (slot-value instance (gethash :foreign-key tdbi)))
733 (list instance jcc)))
736 ;; just fill in minimal slots
739 (let ((instance (make-instance tsc :view-database (choose-database-for-instance object)))
740 (jcc (make-instance jc :view-database (choose-database-for-instance object)))
742 (setf (slot-value instance (gethash :home-key tdbi)) fk)
743 (setf (slot-value jcc (gethash :foreign-key dbi))
745 (setf (slot-value jcc (gethash :home-key tdbi))
747 (list instance jcc)))
748 (select (sql-expression :attribute (gethash :foreign-key tdbi) :table jc-view-table)
749 :from (sql-expression :table jc-view-table)
751 :database (choose-database-for-instance object))))))))
756 (defvar *default-update-objects-max-len* nil
757 "The default value to use for the MAX-LEN keyword argument to
758 UPDATE-OBJECT-JOINS.")
760 (defun %update-objects-joins-slot-defs (class slot-names)
761 "Get the slot definitions for the joins slots specified as slot-names
762 if slot-names is :immediate, :deferred or (or :all t) return all of
763 that type of slot definitions"
764 (setf class (to-class class))
765 (when (eq t slot-names) (setf slot-names :all))
766 (etypecase slot-names
769 ;; slot-names is the retrieval type of the join-slot or :all
770 (get-join-slots class slot-names))
772 (loop for slot in (listify slot-names)
773 for def = (find-slot-by-name class slot)
774 when (and def (join-slot-p def))
776 unless (and def (join-slot-p def))
777 do (warn "Unable to find join slot named ~S in class ~S." slot class)))))
779 (defun get-joined-objects (objects slotdef &key force-p
780 (batch-size *default-update-objects-max-len*))
781 "Given a list of objects and a join slot-def get the objects that need to be
782 joined to the input objects
784 we will query in batches as large as batch-size"
785 (when (join-slot-p slotdef)
786 (let* ((slot-name (to-slot-name slotdef))
787 (join-class (join-slot-class-name slotdef))
788 (home-key (join-slot-info-value slotdef :home-key))
789 (foreign-key (join-slot-info-value slotdef :foreign-key))
792 (loop for object in (listify objects)
793 for hk = (slot-value object home-key)
795 (not (slot-boundp object slot-name)))
798 ;; we want to retrieve at most batch-size objects per query
802 :where (make-instance
805 :sub-expressions (list (sql-expression :attribute foreign-key)
809 (if (null batch-size)
810 (fetch foreign-key-values)
812 for keys = (pop-n foreign-key-values batch-size)
814 nconcing (fetch keys)))))))
816 (defun %object-joins-from-list (object slot joins force-p )
817 "Given a list of objects that we are trying to join to, pull the correct
818 ones for this object"
819 (when (or force-p (not (slot-boundp object (to-slot-name slot))))
820 (let ((home-key (join-slot-info-value slot :home-key))
821 (foreign-key (join-slot-info-value slot :foreign-key)))
822 (loop for join in joins
823 when (equal (slot-value join foreign-key)
824 (slot-value object home-key))
827 (defun update-objects-joins (objects &key (slots :immediate) (force-p t)
828 class-name (max-len *default-update-objects-max-len*))
829 "Updates from the records of the appropriate database tables the join slots
830 specified by SLOTS in the supplied list of View Class instances OBJECTS.
832 A simpler method of causing a join-slot to be requeried is to set it to
833 unbound, then request it again. This function has efficiency gains where
834 join-objects are shared among the `objects` (querying all join-objects,
835 then attaching them appropriately to each of the `objects`)
839 * :immediate (DEFAULT) - refresh join slots created with :retrieval :immediate
840 * :deferred - refresh join slots created with :retrieval :deferred
841 * :all,t - refresh all join slots regardless of :retrieval
842 * list of symbols - which explicit slots to refresh
843 * a single symobl - what slot to refresh
845 CLASS-NAME is used to specify the View Class of all instance in OBJECTS and
846 default to nil which means that the class of the first instance in OBJECTS
849 FORCE-P is t by default which means that all join slots are updated whereas
850 a value of nil means that only unbound join slots are updated.
852 MAX-LEN defaults to *DEFAULT-UPDATE-OBJECTS-MAX-LEN* When non-nil this is
853 essentially a batch size for the max number of objects to query from the
854 database at a time. If we need more than max-len we loop till we have all
856 (assert (or (null max-len) (plusp max-len)))
858 (defaulting class-name (class-name (class-of (first objects))))
859 (let* ((class (find-class class-name))
860 (slotdefs (%update-objects-joins-slot-defs class slots)))
861 (loop for slotdef in slotdefs
862 ;; all the joins we will need for *all* the objects
863 ;; which then get filtered below for each object
864 for joins = (unless (join-slot-info-value slotdef :target-slot)
865 (get-joined-objects objects slotdef
866 :force-p force-p :batch-size max-len))
867 do (loop for object in objects
868 for these-joins = ;; the joins just for this object (filtered from above)
869 ;; or retrieved via fault-join-target-slot
870 (or (%object-joins-from-list object slotdef joins force-p)
871 (when (join-slot-info-value slotdef :target-slot)
872 (fault-join-target-slot class object slotdef)))
873 ;; when this object has joined-objects copy them in to the correct slot
875 (setf (easy-slot-value object slotdef)
876 (if (join-slot-info-value slotdef :set)
878 (first these-joins))))))))
881 (defun fault-join-slot-raw (class object slot-def)
882 (let* ((dbi (view-class-slot-db-info slot-def))
883 (jc (gethash :join-class dbi)))
884 (let ((jq (join-qualifier class object slot-def)))
886 (select jc :where jq :flatp t :result-types nil
887 :database (choose-database-for-instance object))))))
889 (defun fault-join-slot (class object slot-def)
890 (let* ((dbi (view-class-slot-db-info slot-def))
891 (ts (gethash :target-slot dbi))
892 (dbi-set (gethash :set dbi)))
894 (fault-join-target-slot class object slot-def)
895 (let ((res (fault-join-slot-raw class object slot-def)))
898 ((and ts (not dbi-set))
899 (mapcar (lambda (obj) (slot-value obj ts)) res))
900 ((and (not ts) (not dbi-set))
902 ((and (not ts) dbi-set)
905 (defun update-fault-join-normalized-slot (class object slot-def)
906 (if (and (normalizedp class) (key-slot-p slot-def))
907 (setf (easy-slot-value object slot-def)
908 (normalized-key-value object))
909 (update-slot-from-record object slot-def)))
911 (defun all-home-keys-have-values-p (object slot-def)
912 "Do all of the home-keys have values ?"
913 (let ((home-keys (join-slot-info-value slot-def :home-key)))
914 (loop for key in (listify home-keys)
915 always (easy-slot-value object key))))
917 (defun join-qualifier (class object slot-def)
918 "Builds the join where clause based on the keys of the join slot and values
920 (declare (ignore class))
921 (let* ((jc (join-slot-class slot-def))
922 ;;(ts (gethash :target-slot dbi))
923 ;;(tsdef (if ts (slotdef-for-slot-with-class ts jc)))
924 (foreign-keys (listify (join-slot-info-value slot-def :foreign-key)))
925 (home-keys (listify (join-slot-info-value slot-def :home-key))))
926 (when (all-home-keys-have-values-p object slot-def)
928 (loop for hk in home-keys
929 for fk in foreign-keys
930 for fksd = (slotdef-for-slot-with-class fk jc)
931 for fk-sql = (typecase fk
934 :attribute (database-identifier fksd nil)
935 :table (database-identifier jc nil)))
937 for hk-val = (typecase hk
939 view-class-effective-slot-definition
940 view-class-direct-slot-definition)
941 (easy-slot-value object hk))
943 collect (sql-operation '== fk-sql hk-val))))))
945 (defmethod select-table-sql-expr ((table T))
946 "Turns an object representing a table into the :from part of the sql expression that will be executed "
947 (sql-expression :table (view-table table)))
949 (defun select-reference-equal (r1 r2)
950 "determines if two sql select references are equal
951 using database identifier equal"
955 (sql-ident-attribute r))))
956 (database-identifier-equal (id-of r1) (id-of r2))))
958 (defun join-slot-qualifier (class join-slot)
959 "Creates a sql-expression expressing the join between the home-key on the table
960 and its respective key on the joined-to-table"
964 :attribute (join-slot-info-value join-slot :foreign-key)
965 :table (view-table (join-slot-class join-slot)))
967 :attribute (join-slot-info-value join-slot :home-key)
968 :table (view-table class))))
970 (defun all-immediate-join-classes-for (classes)
971 "returns a list of all join-classes needed for a list of classes"
972 (loop for class in (listify classes)
973 appending (loop for slot in (immediate-join-slots class)
974 collect (join-slot-class slot))))
976 (defun %tables-for-query (classes from where inner-joins)
977 "Given lists of classes froms wheres and inner-join compile a list
978 of tables that should appear in the FROM section of the query.
980 This includes any immediate join classes from each of the classes"
981 (let ((inner-join-tables (collect-table-refs (listify inner-joins))))
982 (loop for tbl in (append
983 (mapcar #'select-table-sql-expr classes)
984 (mapcar #'select-table-sql-expr
985 (all-immediate-join-classes-for classes))
986 (collect-table-refs (listify where))
987 (collect-table-refs (listify from)))
989 (not (find tbl rtn :test #'database-identifier-equal))
990 ;; TODO: inner-join is currently hacky as can be
991 (not (find tbl inner-join-tables :test #'database-identifier-equal)))
993 finally (return rtn))))
996 (defclass select-list ()
997 ((view-class :accessor view-class :initarg :view-class :initform nil)
998 (select-list :accessor select-list :initarg :select-list :initform nil)
999 (slot-list :accessor slot-list :initarg :slot-list :initform nil)
1000 (joins :accessor joins :initarg :joins :initform nil)
1001 (join-slots :accessor join-slots :initarg :join-slots :initform nil))
1003 "Collects the classes, slots and their respective sql representations
1004 so that update-instance-from-recors, find-all, build-objects can share this
1005 info and calculate it once. Joins are select-lists for each immediate join-slot
1006 but only if make-select-list is called with do-joins-p"))
1008 (defmethod view-table ((o select-list))
1009 (view-table (view-class o)))
1011 (defmethod sql-table ((o select-list))
1012 (sql-expression :table (view-table o)))
1014 (defmethod filter-select-list ((c clsql-sys::standard-db-object)
1015 (sl clsql-sys::select-list)
1019 (defun make-select-list (class-and-slots &key (do-joins-p nil)
1020 (database *default-database*))
1021 "Make a select-list for the current class (or class-and-slots) object."
1022 (let* ((class-and-slots
1023 (etypecase class-and-slots
1024 (class-and-slots class-and-slots)
1025 ((or symbol standard-db-class)
1026 ;; find the first class with slots for us to select (this should be)
1027 ;; the first of its classes / parent-classes with slots
1028 (first (reverse (view-classes-and-storable-slots
1029 (to-class class-and-slots)
1030 :to-database-p nil))))))
1031 (class (view-class class-and-slots))
1032 (join-slots (when do-joins-p (immediate-join-slots class))))
1033 (multiple-value-bind (slots sqls)
1034 (loop for slot in (slot-defs class-and-slots)
1035 for sql = (generate-attribute-reference class slot)
1036 collect slot into slots
1037 collect sql into sqls
1038 finally (return (values slots sqls)))
1040 (error "No slots of type :base in view-class ~A" (class-name class)))
1041 (let ((sl (make-instance
1046 :join-slots join-slots
1047 ;; only do a single layer of join objects
1048 :joins (when do-joins-p
1049 (loop for js in join-slots
1050 collect (make-select-list
1051 (join-slot-class js)
1053 :database database))))))
1054 (filter-select-list (make-instance class) sl database)
1057 (defun full-select-list ( select-lists )
1058 "Returns a list of sql-ref of things to select for the given classes
1060 THIS NEEDS TO MATCH THE ORDER OF build-objects
1062 (loop for s in (listify select-lists)
1063 appending (select-list s)
1064 appending (loop for join in (joins s)
1065 appending (select-list join))))
1067 (defun build-objects (select-lists row database &optional existing-instances)
1068 "Used by find-all to build objects.
1070 THIS NEEDS TO MATCH THE ORDER OF FULL-SELECT-LIST
1072 TODO: this caching scheme seems bad for a number of reasons
1073 * order is not guaranteed so references being held by one object
1074 might change to represent a different database row (seems HIGHLY
1076 * also join objects are overwritten rather than refreshed
1078 TODO: the way we handle immediate joins seems only valid if it is a single
1079 object. I suspect that making a :set :immediate join column would result
1080 in an invalid number of objects returned from the database, because there
1081 would be multiple rows per object, but we would return an object per row
1083 (setf existing-instances (listify existing-instances))
1085 for select-list in select-lists
1086 for class = (view-class select-list)
1087 for existing = (pop existing-instances)
1088 for object = (or existing
1089 (make-instance class :view-database database))
1090 do (loop for slot in (slot-list select-list)
1091 do (update-slot-from-db-value object slot (pop row)))
1092 do (loop for join-slot in (join-slots select-list)
1093 for join in (joins select-list)
1094 for join-class = (view-class join)
1096 (setf (easy-slot-value object join-slot)
1097 (make-instance join-class))
1098 do (loop for slot in (slot-list join)
1099 do (update-slot-from-db-value join-object slot (pop row))))
1100 do (when existing (instance-refreshed object))
1103 (defun find-all (view-classes
1105 &key all set-operation distinct from where group-by having
1106 order-by offset limit refresh flatp result-types
1108 (database *default-database*)
1109 instances parameters)
1110 "Called by SELECT to generate object query results when the
1111 View Classes VIEW-CLASSES are passed as arguments to SELECT.
1113 TODO: the caching scheme of passing in instances and overwriting their
1114 values seems bad for a number of reasons
1115 * order is not guaranteed so references being held by one object
1116 might change to represent a different database row (seems HIGHLY
1119 TODO: the way we handle immediate joins seems only valid if it is a single
1120 object. I suspect that making a :set :immediate join column would result
1121 in an invalid number of objects returned from the database, because there
1122 would be multiple objects returned from the database
1124 (declare (ignore all set-operation group-by having offset limit on parameters
1126 (dynamic-extent args))
1127 (let* ((args (filter-plist
1128 args :from :where :flatp :additional-fields :result-types :instances))
1129 (*db-deserializing* t)
1130 (sclasses (mapcar #'to-class view-classes))
1131 (tables (%tables-for-query sclasses from where inner-join))
1133 (loop for class in sclasses
1134 appending (loop for slot in (immediate-join-slots class)
1135 collect (join-slot-qualifier class slot))))
1136 (select-lists (loop for class in sclasses
1137 collect (make-select-list class :do-joins-p t :database database)))
1138 (full-select-list (full-select-list select-lists))
1139 (where (clsql-ands (append (listify where) (listify join-where))))
1141 (_ (format t "~&sclasses: ~W~%ijc: ~W~%tables: ~W~%"
1142 sclasses immediate-join-classes tables))
1144 (rows (apply #'select
1145 (append full-select-list
1147 :result-types result-types
1151 (loop for row in rows
1152 for old-objs = (pop instances)
1153 for objs = (build-objects select-lists row database
1154 (when refresh old-objs))
1155 collecting (if flatp
1156 (delist-if-single objs)
1160 (defmethod instance-refreshed ((instance standard-db-object)))
1162 (defvar *default-caching* t
1163 "Controls whether SELECT caches objects by default. The CommonSQL
1164 specification states caching is on by default.")
1166 (defun select (&rest select-all-args)
1167 "Executes a query on DATABASE, which has a default value of
1168 *DEFAULT-DATABASE*, specified by the SQL expressions supplied
1169 using the remaining arguments in SELECT-ALL-ARGS. The SELECT
1170 argument can be used to generate queries in both functional and
1171 object oriented contexts.
1173 In the functional case, the required arguments specify the
1174 columns selected by the query and may be symbolic SQL expressions
1175 or strings representing attribute identifiers. Type modified
1176 identifiers indicate that the values selected from the specified
1177 column are converted to the specified lisp type. The keyword
1178 arguments ALL, DISTINCT, FROM, GROUP-by, HAVING, ORDER-BY,
1179 SET-OPERATION and WHERE are used to specify, using the symbolic
1180 SQL syntax, the corresponding components of the SQL query
1181 generated by the call to SELECT. RESULT-TYPES is a list of
1182 symbols which specifies the lisp type for each field returned by
1183 the query. If RESULT-TYPES is nil all results are returned as
1184 strings whereas the default value of :auto means that the lisp
1185 types are automatically computed for each field. FIELD-NAMES is t
1186 by default which means that the second value returned is a list
1187 of strings representing the columns selected by the query. If
1188 FIELD-NAMES is nil, the list of column names is not returned as a
1191 In the object oriented case, the required arguments to SELECT are
1192 symbols denoting View Classes which specify the database tables
1193 to query. In this case, SELECT returns a list of View Class
1194 instances whose slots are set from the attribute values of the
1195 records in the specified table. Slot-value is a legal operator
1196 which can be employed as part of the symbolic SQL syntax used in
1197 the WHERE keyword argument to SELECT. REFRESH is nil by default
1198 which means that the View Class instances returned are retrieved
1199 from a cache if an equivalent call to SELECT has previously been
1200 issued. If REFRESH is true, the View Class instances returned are
1201 updated as necessary from the database and the generic function
1202 INSTANCE-REFRESHED is called to perform any necessary operations
1203 on the updated instances.
1205 In both object oriented and functional contexts, FLATP has a
1206 default value of nil which means that the results are returned as
1207 a list of lists. If FLATP is t and only one result is returned
1208 for each record selected in the query, the results are returned
1209 as elements of a list."
1210 (multiple-value-bind (target-args qualifier-args)
1211 (query-get-selections select-all-args)
1212 (unless (or *default-database* (getf qualifier-args :database))
1213 (signal-no-database-error nil))
1215 (let ((caching (getf qualifier-args :caching *default-caching*))
1216 (result-types (getf qualifier-args :result-types :auto))
1217 (refresh (getf qualifier-args :refresh nil))
1218 (database (getf qualifier-args :database *default-database*)))
1222 (every #'(lambda (arg)
1224 (find-class arg nil)))
1227 (setf qualifier-args (filter-plist qualifier-args :caching :refresh :result-types))
1229 ;; Add explicity table name to order-by if not specified and only
1230 ;; one selected table. This is required so FIND-ALL won't duplicate
1232 (let ((order-by (getf qualifier-args :order-by)))
1233 (when (and order-by (= 1 (length target-args)))
1234 (let ((table-name (view-table (find-class (car target-args))))
1235 (order-by-list (copy-seq (listify order-by))))
1236 (labels ((sv (val name) (ignore-errors (slot-value val name)))
1237 (set-table-if-needed (val)
1239 (sql-ident-attribute
1241 (if (sv val 'qualifier)
1243 (make-instance 'sql-ident-attribute
1244 :name (sv val 'name)
1245 :qualifier table-name))
1247 ;; TODO: Check for a specific error we expect
1249 (cons (cons (set-table-if-needed (car val))
1253 (loop for i from 0 below (length order-by-list)
1254 for id in order-by-list
1255 collect (set-table-if-needed id))))
1256 (setf (getf qualifier-args :order-by) order-by-list))))
1260 (apply #'find-all target-args :result-types result-types :refresh refresh qualifier-args))
1262 (let ((cached (records-cache-results target-args qualifier-args database)))
1263 (if (and cached (not refresh))
1265 (let ((results (apply #'find-all target-args
1266 :result-types :auto :refresh refresh
1269 (setf (records-cache-results target-args qualifier-args database) results)
1273 (let* ((expr (apply #'make-query select-all-args))
1274 (parameters (second (member :parameters select-all-args)))
1276 (mapcar #'(lambda (attrib)
1277 (if (typep attrib 'sql-ident-attribute)
1278 (let ((type (slot-value attrib 'type)))
1283 (slot-value expr 'selections)))
1284 (flatp (getf qualifier-args :flatp))
1285 (field-names (getf qualifier-args :field-names t)))
1288 (setf expr (command-object (sql-output expr database) parameters)))
1289 (query expr :flatp flatp
1291 ;; specifying a type for an attribute overrides result-types
1292 (if (some #'(lambda (x) (not (eq t x))) specified-types)
1295 :field-names field-names
1296 :database database)))))))
1298 (defun compute-records-cache-key (targets qualifiers)
1300 (do ((args *select-arguments* (cdr args))
1302 ((null args) results)
1303 (let* ((arg (car args))
1304 (value (getf qualifiers arg)))
1308 (cons (cons (sql (car value)) (cdr value)))
1309 (%sql-expression (sql value))
1313 (defun records-cache-results (targets qualifiers database)
1314 (when (record-caches database)
1315 (gethash (compute-records-cache-key targets qualifiers) (record-caches database))))
1317 (defun (setf records-cache-results) (results targets qualifiers database)
1318 (unless (record-caches database)
1319 (setf (record-caches database)
1320 (make-weak-hash-table :test 'equal)))
1321 (setf (gethash (compute-records-cache-key (copy-list targets) qualifiers)
1322 (record-caches database)) results)
1327 ;;; Serialization functions
1329 (defun write-instance-to-stream (obj stream)
1330 "Writes an instance to a stream where it can be later be read.
1331 NOTE: an error will occur if a slot holds a value which can not be written readably."
1332 (let* ((class (class-of obj))
1334 (dolist (slot (ordered-class-slots (class-of obj)))
1335 (let ((name (slot-definition-name slot)))
1336 (when (and (not (eq 'view-database name))
1337 (slot-boundp obj name))
1338 (push (cons name (slot-value obj name)) alist))))
1339 (setq alist (reverse alist))
1340 (write (cons (class-name class) alist) :stream stream :readably t))
1343 (defun read-instance-from-stream (stream)
1344 (let ((raw (read stream nil nil)))
1346 (let ((obj (make-instance (car raw))))
1347 (dolist (pair (cdr raw))
1348 (setf (slot-value obj (car pair)) (cdr pair)))