sql/oodml.lisp

   1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
   2 ;;;; *************************************************************************
   3 ;;;;
   4 ;;;; $Id$
   5 ;;;;
   6 ;;;; The CLSQL Object Oriented Data Manipulation Language (OODML).
   7 ;;;;
   8 ;;;; This file is part of CLSQL.
   9 ;;;;
  10 ;;;; CLSQL users are granted the rights to distribute and use this software
  11 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
  12 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
  13 ;;;; *************************************************************************
  14
  15 (in-package #:clsql-sys)
  16
  17
  18 (defun key-qualifier-for-instance (obj &key (database *default-database*))
  19   (let ((tb (view-table (class-of obj))))
  20     (flet ((qfk (k)
  21              (sql-operation '==
  22                             (sql-expression :attribute
  23                                             (view-class-slot-column k)
  24                                             :table tb)
  25                             (db-value-from-slot
  26                              k
  27                              (slot-value obj (slot-definition-name k))
  28                              database))))
  29       (let* ((keys (keyslots-for-class (class-of obj)))
  30              (keyxprs (mapcar #'qfk (reverse keys))))
  31         (cond
  32           ((= (length keyxprs) 0) nil)
  33           ((= (length keyxprs) 1) (car keyxprs))
  34           ((> (length keyxprs) 1) (apply #'sql-operation 'and keyxprs)))))))
  35
  36 ;;
  37 ;; Function used by 'generate-selection-list'
  38 ;;
  39
  40 (defun generate-attribute-reference (vclass slotdef)
  41   (cond
  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)))
  48    (t nil)))
  49
  50 ;;
  51 ;; Function used by 'find-all'
  52 ;;
  53
  54 (defun generate-selection-list (vclass)
  55   (let ((sels nil))
  56     (dolist (slotdef (ordered-class-slots vclass))
  57       (let ((res (generate-attribute-reference vclass slotdef)))
  58         (when res
  59           (push (cons slotdef res) sels))))
  60     (if sels
  61         sels
  62         (error "No slots of type :base in view-class ~A" (class-name vclass)))))
  63
  64
  65
  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)))))
  73
  74 (defun generate-immediate-joins-selection-list (vclass)
  75   "Returns list of immediate join slots for a class."
  76   (let (sels)
  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)))
  82             (when res
  83               (push (cons slotdef res) sels))))))
  84     sels))
  85
  86
  87 ;; Called by 'get-slot-values-from-view'
  88 ;;
  89
  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)))))
 101           ((null value)
 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 '(or symbol function))
 107            (setf (slot-value instance slot-name)
 108                  (apply slot-reader (list value))))
 109           (t
 110            (error "Slot reader is of an unusual type.")))))
 111
 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)))
 119           ((null value)
 120            nil)
 121           ((typep slot-reader 'string)
 122            (format nil slot-reader value))
 123           ((typep slot-reader '(or symbol function))
 124            (apply slot-reader (list value)))
 125           (t
 126            (error "Slot reader is of an unusual type.")))))
 127
 128 (defun db-value-from-slot (slotdef val database)
 129   (let ((dbwriter (view-class-slot-db-writer slotdef))
 130         (dbtype (specified-type slotdef)))
 131     (typecase dbwriter
 132       (string (format nil dbwriter val))
 133       ((and (or symbol function) (not null)) (apply dbwriter (list val)))
 134       (t
 135        (database-output-sql-as-type
 136         (typecase dbtype
 137           (cons (car dbtype))
 138           (t dbtype))
 139         val database (database-underlying-type database))))))
 140
 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
 147                :message
 148                (format nil "Invalid value ~A in slot ~A, not of type ~A."
 149                        val (slot-definition-name slotdef) slot-type))))))
 150
 151 ;;
 152 ;; Called by find-all
 153 ;;
 154
 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)
 159       obj))
 160
 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))
 172                              :values (list val)
 173                              :where (key-qualifier-for-instance
 174                                      obj :database database)
 175                              :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))
 179                              :values (list val)
 180                              :database database)
 181              (setf (slot-value obj 'view-database) database))
 182             (t
 183              (error "Unable to update record.")))))
 184   (values))
 185
 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))))
 198                        sds)))
 199     (cond ((and avps (view-database obj))
 200            (update-records (sql-expression :table vct)
 201                            :av-pairs avps
 202                            :where (key-qualifier-for-instance
 203                                    obj :database database)
 204                            :database database))
 205           ((and avps (not (view-database obj)))
 206            (insert-records :into (sql-expression :table vct)
 207                            :av-pairs avps
 208                            :database database)
 209            (setf (slot-value obj 'view-database) database))
 210           (t
 211            (error "Unable to update records"))))
 212   (values))
 213
 214 (defmethod update-records-from-instance ((obj standard-db-object) &key database)
 215   (let ((database (or database (view-database obj) *default-database*)))
 216     (labels ((slot-storedp (slot)
 217                (and (member (view-class-slot-db-kind slot) '(:base :key))
 218                     (slot-boundp obj (slot-definition-name slot))))
 219              (slot-value-list (slot)
 220                (let ((value (slot-value obj (slot-definition-name slot))))
 221                  (check-slot-type slot value)
 222                  (list (sql-expression :attribute (view-class-slot-column slot))
 223                        (db-value-from-slot slot value database)))))
 224       (let* ((view-class (class-of obj))
 225              (view-class-table (view-table view-class))
 226              (slots (remove-if-not #'slot-storedp
 227                                    (ordered-class-slots view-class)))
 228              (record-values (mapcar #'slot-value-list slots)))
 229         (unless record-values
 230           (error "No settable slots."))
 231         (if (view-database obj)
 232             (update-records (sql-expression :table view-class-table)
 233                             :av-pairs record-values
 234                             :where (key-qualifier-for-instance
 235                                     obj :database database)
 236                             :database database)
 237             (progn
 238               (insert-records :into (sql-expression :table view-class-table)
 239                               :av-pairs record-values
 240                               :database database)
 241               (setf (slot-value obj 'view-database) database))))))
 242   (values))
 243
 244 (defmethod delete-instance-records ((instance standard-db-object))
 245   (let ((vt (sql-expression :table (view-table (class-of instance))))
 246         (vd (view-database instance)))
 247     (if vd
 248         (let ((qualifier (key-qualifier-for-instance instance :database vd)))
 249           (delete-records :from vt :where qualifier :database vd)
 250           (setf (record-caches vd) nil)
 251           (setf (slot-value instance 'view-database) nil)
 252           (values))
 253         (signal-no-database-error vd))))
 254
 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
 264                                             :where view-qual
 265                                             :result-types nil
 266                                             :database vd)))))
 267     (when res
 268       (get-slot-values-from-view instance (mapcar #'car sels) (car res)))))
 269
 270 (defmethod update-slot-from-record ((instance standard-db-object)
 271                                     slot &key (database *default-database*))
 272   (let* ((view-class (find-class (class-name (class-of instance))))
 273          (view-table (sql-expression :table (view-table view-class)))
 274          (vd (or (view-database instance) database))
 275          (view-qual (key-qualifier-for-instance instance :database vd))
 276          (slot-def (slotdef-for-slot-with-class slot view-class))
 277          (att-ref (generate-attribute-reference view-class slot-def))
 278          (res (select att-ref :from  view-table :where view-qual
 279                       :result-types nil)))
 280     (when res
 281       (get-slot-values-from-view instance (list slot-def) (car res)))))
 282
 283
 284 (defmethod update-slot-with-null ((object standard-db-object)
 285                                   slotname
 286                                   slotdef)
 287   (setf (slot-value object slotname) (slot-value slotdef 'void-value)))
 288
 289 (defvar +no-slot-value+ '+no-slot-value+)
 290
 291 (defsql sql-slot-value (:symbol "slot-value") (classname slot &optional (value +no-slot-value+) (database *default-database*))
 292   (let* ((class (find-class classname))
 293          (sld (slotdef-for-slot-with-class slot class)))
 294     (if sld
 295         (if (eq value +no-slot-value+)
 296             (sql-expression :attribute (view-class-slot-column sld)
 297                             :table (view-table class))
 298             (db-value-from-slot
 299              sld
 300              value
 301              database))
 302         (error "Unknown slot ~A for class ~A" slot classname))))
 303
 304 (defsql sql-view-class (:symbol "view-class") (classname &optional (database *default-database*))
 305         (declare (ignore database))
 306         (let* ((class (find-class classname)))
 307           (unless (view-table class)
 308             (error "No view-table for class ~A"  classname))
 309           (sql-expression :table (view-table class))))
 310
 311
 312 (defmethod database-get-type-specifier (type args database db-type)
 313   (declare (ignore type args database db-type))
 314   (format nil "VARCHAR(~D)" *default-string-length*))
 315
 316 (defmethod database-get-type-specifier ((type (eql 'integer)) args database db-type)
 317   (declare (ignore database db-type))
 318   (if args
 319       (format nil "INT(~A)" (car args))
 320     "INT"))
 321
 322 (deftype tinyint ()
 323   "An 8-bit integer, this width may vary by SQL implementation."
 324   'integer)
 325
 326 (defmethod database-get-type-specifier ((type (eql 'tinyint)) args database db-type)
 327   (declare (ignore args database db-type))
 328   "INT")
 329
 330 (deftype smallint ()
 331   "An integer smaller than a 32-bit integer. this width may vary by SQL implementation."
 332   'integer)
 333
 334 (defmethod database-get-type-specifier ((type (eql 'smallint)) args database db-type)
 335   (declare (ignore args database db-type))
 336   "INT")
 337
 338 (deftype mediumint ()
 339   "An integer smaller than a 32-bit integer, but may be larger than a smallint. This width may vary by SQL implementation."
 340   'integer)
 341
 342 (defmethod database-get-type-specifier ((type (eql 'mediumint)) args database db-type)
 343   (declare (ignore args database db-type))
 344   "INT")
 345
 346 (deftype bigint ()
 347   "An integer larger than a 32-bit integer, this width may vary by SQL implementation."
 348   'integer)
 349
 350 (defmethod database-get-type-specifier ((type (eql 'bigint)) args database db-type)
 351   (declare (ignore args database db-type))
 352   "BIGINT")
 353
 354 (deftype varchar (&optional size)
 355   "A variable length string for the SQL varchar type."
 356   (declare (ignore size))
 357   'string)
 358
 359 (defmethod database-get-type-specifier ((type (eql 'varchar)) args
 360                                         database db-type)
 361   (declare (ignore database db-type))
 362   (if args
 363       (format nil "VARCHAR(~A)" (car args))
 364       (format nil "VARCHAR(~D)" *default-string-length*)))
 365
 366 (defmethod database-get-type-specifier ((type (eql 'string)) args database db-type)
 367   (declare (ignore database db-type))
 368   (if args
 369       (format nil "CHAR(~A)" (car args))
 370       (format nil "VARCHAR(~D)" *default-string-length*)))
 371
 372 (deftype universal-time ()
 373   "A positive integer as returned by GET-UNIVERSAL-TIME."
 374   '(integer 1 *))
 375
 376 (defmethod database-get-type-specifier ((type (eql 'universal-time)) args database db-type)
 377   (declare (ignore args database db-type))
 378   "BIGINT")
 379
 380 (defmethod database-get-type-specifier ((type (eql 'wall-time)) args database db-type)
 381   (declare (ignore args database db-type))
 382   "TIMESTAMP")
 383
 384 (defmethod database-get-type-specifier ((type (eql 'date)) args database db-type)
 385   (declare (ignore args database db-type))
 386   "DATE")
 387
 388 (defmethod database-get-type-specifier ((type (eql 'duration)) args database db-type)
 389   (declare (ignore database args db-type))
 390   "VARCHAR")
 391
 392 (defmethod database-get-type-specifier ((type (eql 'money)) args database db-type)
 393   (declare (ignore database args db-type))
 394   "INT8")
 395
 396 #+ignore
 397 (deftype char (&optional len)
 398   "A lisp type for the SQL CHAR type."
 399   `(string ,len))
 400
 401 (defmethod database-get-type-specifier ((type (eql 'float)) args database db-type)
 402   (declare (ignore database db-type))
 403   (if args
 404       (format nil "FLOAT(~A)" (car args))
 405       "FLOAT"))
 406
 407 (defmethod database-get-type-specifier ((type (eql 'long-float)) args database db-type)
 408   (declare (ignore database db-type))
 409   (if args
 410       (format nil "FLOAT(~A)" (car args))
 411       "FLOAT"))
 412
 413 (deftype generalized-boolean ()
 414   "A type which outputs a SQL boolean value, though any lisp type can be stored in the slot."
 415   t)
 416
 417 (defmethod database-get-type-specifier ((type (eql 'boolean)) args database db-type)
 418   (declare (ignore args database db-type))
 419   "BOOL")
 420
 421 (defmethod database-get-type-specifier ((type (eql 'generalized-boolean)) args database db-type)
 422   (declare (ignore args database db-type))
 423   "BOOL")
 424
 425 (defmethod database-get-type-specifier ((type (eql 'number)) args database db-type)
 426   (declare (ignore database db-type))
 427   (cond
 428    ((and (consp args) (= (length args) 2))
 429     (format nil "NUMBER(~D,~D)" (first args) (second args)))
 430    ((and (consp args) (= (length args) 1))
 431     (format nil "NUMBER(~D)" (first args)))
 432    (t
 433     "NUMBER")))
 434
 435 (defmethod database-get-type-specifier ((type (eql 'char)) args database db-type)
 436   (declare (ignore database db-type))
 437   (if args
 438       (format nil "CHAR(~D)" (first args))
 439       "CHAR(1)"))
 440
 441
 442 (defmethod database-output-sql-as-type (type val database db-type)
 443   (declare (ignore type database db-type))
 444   val)
 445
 446 (defmethod database-output-sql-as-type ((type (eql 'list)) val database db-type)
 447   (declare (ignore database db-type))
 448   (progv '(*print-circle* *print-array*) '(t t)
 449     (let ((escaped (prin1-to-string val)))
 450       (substitute-char-string
 451        escaped #\Null " "))))
 452
 453 (defmethod database-output-sql-as-type ((type (eql 'symbol)) val database db-type)
 454   (declare (ignore database db-type))
 455   (if val
 456     (concatenate 'string
 457                  (package-name (symbol-package val))
 458                  "::"
 459                  (symbol-name val))
 460     ""))
 461
 462 (defmethod database-output-sql-as-type ((type (eql 'keyword)) val database db-type)
 463   (declare (ignore database db-type))
 464   (if val
 465       (symbol-name val)
 466       ""))
 467
 468 (defmethod database-output-sql-as-type ((type (eql 'vector)) val database db-type)
 469   (declare (ignore database db-type))
 470   (progv '(*print-circle* *print-array*) '(t t)
 471     (prin1-to-string val)))
 472
 473 (defmethod database-output-sql-as-type ((type (eql 'array)) val database db-type)
 474   (declare (ignore database db-type))
 475   (progv '(*print-circle* *print-array*) '(t t)
 476     (prin1-to-string val)))
 477
 478 (defmethod database-output-sql-as-type ((type (eql 'boolean)) val database db-type)
 479   (declare (ignore database db-type))
 480   (if val "t" "f"))
 481
 482 (defmethod database-output-sql-as-type ((type (eql 'generalized-boolean)) val database db-type)
 483   (declare (ignore database db-type))
 484   (if val "t" "f"))
 485
 486 (defmethod database-output-sql-as-type ((type (eql 'string)) val database db-type)
 487   (declare (ignore database db-type))
 488   val)
 489
 490 (defmethod database-output-sql-as-type ((type (eql 'char)) val database db-type)
 491   (declare (ignore database db-type))
 492   (etypecase val
 493     (character (write-to-string val))
 494     (string val)))
 495
 496 (defmethod database-output-sql-as-type ((type (eql 'float)) val database db-type)
 497   (declare (ignore database db-type))
 498   (let ((*read-default-float-format* (type-of val)))
 499     (format nil "~F" val)))
 500
 501 (defmethod read-sql-value (val type database db-type)
 502   (declare (ignore type database db-type))
 503   (read-from-string val))
 504
 505 (defmethod read-sql-value (val (type (eql 'string)) database db-type)
 506   (declare (ignore database db-type))
 507   val)
 508
 509 (defmethod read-sql-value (val (type (eql 'varchar)) database db-type)
 510   (declare (ignore database db-type))
 511   val)
 512
 513 (defmethod read-sql-value (val (type (eql 'char)) database db-type)
 514   (declare (ignore database db-type))
 515   (schar val 0))
 516
 517 (defmethod read-sql-value (val (type (eql 'keyword)) database db-type)
 518   (declare (ignore database db-type))
 519   (when (< 0 (length val))
 520     (intern (symbol-name-default-case val)
 521             (find-package '#:keyword))))
 522
 523 (defmethod read-sql-value (val (type (eql 'symbol)) database db-type)
 524   (declare (ignore database db-type))
 525   (when (< 0 (length val))
 526     (unless (string= val (symbol-name-default-case "NIL"))
 527       (read-from-string val))))
 528
 529 (defmethod read-sql-value (val (type (eql 'integer)) database db-type)
 530   (declare (ignore database db-type))
 531   (etypecase val
 532     (string
 533      (unless (string-equal "NIL" val)
 534        (parse-integer val)))
 535     (number val)))
 536
 537 (defmethod read-sql-value (val (type (eql 'smallint)) database db-type)
 538   (declare (ignore database db-type))
 539   (etypecase val
 540     (string
 541      (unless (string-equal "NIL" val)
 542        (parse-integer val)))
 543     (number val)))
 544
 545 (defmethod read-sql-value (val (type (eql 'bigint)) database db-type)
 546   (declare (ignore database db-type))
 547   (etypecase val
 548     (string
 549      (unless (string-equal "NIL" val)
 550        (parse-integer val)))
 551     (number val)))
 552
 553 (defmethod read-sql-value (val (type (eql 'float)) database db-type)
 554   (declare (ignore database db-type))
 555   ;; writing 1.0 writes 1, so we we *really* want a float, must do (float ...)
 556   (etypecase val
 557     (string
 558      (float (read-from-string val)))
 559     (float
 560      val)))
 561
 562 (defmethod read-sql-value (val (type (eql 'boolean)) database db-type)
 563   (declare (ignore database db-type))
 564   (equal "t" val))
 565
 566 (defmethod read-sql-value (val (type (eql 'generalized-boolean)) database db-type)
 567   (declare (ignore database db-type))
 568   (equal "t" val))
 569
 570 (defmethod read-sql-value (val (type (eql 'number)) database db-type)
 571   (declare (ignore database db-type))
 572   (etypecase val
 573     (string
 574      (unless (string-equal "NIL" val)
 575        (read-from-string val)))
 576     (number val)))
 577
 578 (defmethod read-sql-value (val (type (eql 'universal-time)) database db-type)
 579   (declare (ignore database db-type))
 580   (unless (eq 'NULL val)
 581     (etypecase val
 582       (string
 583        (parse-integer val))
 584       (number val))))
 585
 586 (defmethod read-sql-value (val (type (eql 'wall-time)) database db-type)
 587   (declare (ignore database db-type))
 588   (unless (eq 'NULL val)
 589     (parse-timestring val)))
 590
 591 (defmethod read-sql-value (val (type (eql 'date)) database db-type)
 592   (declare (ignore database db-type))
 593   (unless (eq 'NULL val)
 594     (parse-datestring val)))
 595
 596 (defmethod read-sql-value (val (type (eql 'duration)) database db-type)
 597   (declare (ignore database db-type))
 598   (unless (or (eq 'NULL val)
 599               (equal "NIL" val))
 600     (parse-timestring val)))
 601
 602 ;; ------------------------------------------------------------
 603 ;; Logic for 'faulting in' :join slots
 604
 605 ;; this works, but is inefficient requiring (+ 1 n-rows)
 606 ;; SQL queries
 607 #+ignore
 608 (defun fault-join-target-slot (class object slot-def)
 609   (let* ((res (fault-join-slot-raw class object slot-def))
 610          (dbi (view-class-slot-db-info slot-def))
 611          (target-name (gethash :target-slot dbi))
 612          (target-class (find-class target-name)))
 613     (when res
 614       (mapcar (lambda (obj)
 615                 (list
 616                  (car
 617                   (fault-join-slot-raw
 618                    target-class
 619                    obj
 620                    (find target-name (class-slots (class-of obj))
 621                          :key #'slot-definition-name)))
 622                  obj))
 623               res)
 624       #+ignore ;; this doesn't work when attempting to call slot-value
 625       (mapcar (lambda (obj)
 626                 (cons obj (slot-value obj ts))) res))))
 627
 628 (defun fault-join-target-slot (class object slot-def)
 629   (let* ((dbi (view-class-slot-db-info slot-def))
 630          (ts (gethash :target-slot dbi))
 631          (jc (gethash :join-class dbi))
 632          (ts-view-table (view-table (find-class ts)))
 633          (jc-view-table (view-table (find-class jc)))
 634          (tdbi (view-class-slot-db-info
 635                 (find ts (class-slots (find-class jc))
 636                       :key #'slot-definition-name)))
 637          (retrieval (gethash :retrieval tdbi))
 638          (jq (join-qualifier class object slot-def))
 639          (key (slot-value object (gethash :home-key dbi))))
 640     (when jq
 641       (ecase retrieval
 642         (:immediate
 643          (let ((res
 644                 (find-all (list ts)
 645                           :inner-join (sql-expression :table jc-view-table)
 646                           :on (sql-operation
 647                                '==
 648                                (sql-expression
 649                                 :attribute (gethash :foreign-key tdbi)
 650                                 :table ts-view-table)
 651                                (sql-expression
 652                                 :attribute (gethash :home-key tdbi)
 653                                 :table jc-view-table))
 654                           :where jq
 655                           :result-types :auto
 656                           :database (view-database object))))
 657            (mapcar #'(lambda (i)
 658                        (let* ((instance (car i))
 659                               (jcc (make-instance jc :view-database (view-database instance))))
 660                          (setf (slot-value jcc (gethash :foreign-key dbi))
 661                                key)
 662                          (setf (slot-value jcc (gethash :home-key tdbi))
 663                                (slot-value instance (gethash :foreign-key tdbi)))
 664                       (list instance jcc)))
 665                    res)))
 666         (:deferred
 667             ;; just fill in minimal slots
 668             (mapcar
 669              #'(lambda (k)
 670                  (let ((instance (make-instance ts :view-database (view-database object)))
 671                        (jcc (make-instance jc :view-database (view-database object)))
 672                        (fk (car k)))
 673                    (setf (slot-value instance (gethash :home-key tdbi)) fk)
 674                    (setf (slot-value jcc (gethash :foreign-key dbi))
 675                          key)
 676                    (setf (slot-value jcc (gethash :home-key tdbi))
 677                          fk)
 678                    (list instance jcc)))
 679              (select (sql-expression :attribute (gethash :foreign-key tdbi) :table jc-view-table)
 680                      :from (sql-expression :table jc-view-table)
 681                      :where jq
 682                      :database (view-database object))))))))
 683
 684
 685 ;;; Remote Joins
 686
 687 (defvar *default-update-objects-max-len* nil
 688   "The default value to use for the MAX-LEN keyword argument to
 689   UPDATE-OBJECT-JOINS.")
 690
 691 (defun update-objects-joins (objects &key (slots t) (force-p t)
 692                             class-name (max-len
 693                             *default-update-objects-max-len*))
 694   "Updates from the records of the appropriate database tables
 695 the join slots specified by SLOTS in the supplied list of View
 696 Class instances OBJECTS.  SLOTS is t by default which means that
 697 all join slots with :retrieval :immediate are updated. CLASS-NAME
 698 is used to specify the View Class of all instance in OBJECTS and
 699 default to nil which means that the class of the first instance
 700 in OBJECTS is used. FORCE-P is t by default which means that all
 701 join slots are updated whereas a value of nil means that only
 702 unbound join slots are updated. MAX-LEN defaults to
 703 *DEFAULT-UPDATE-OBJECTS-MAX-LEN* and when non-nil specifies that
 704 UPDATE-OBJECT-JOINS may issue multiple database queries with a
 705 maximum of MAX-LEN instances updated in each query."
 706   (assert (or (null max-len) (plusp max-len)))
 707   (when objects
 708     (unless class-name
 709       (setq class-name (class-name (class-of (first objects)))))
 710     (let* ((class (find-class class-name))
 711            (class-slots (ordered-class-slots class))
 712            (slotdefs
 713             (if (eq t slots)
 714                 (generate-retrieval-joins-list class :deferred)
 715               (remove-if #'null
 716                          (mapcar #'(lambda (name)
 717                                      (let ((slotdef (find name class-slots :key #'slot-definition-name)))
 718                                        (unless slotdef
 719                                          (warn "Unable to find slot named ~S in class ~S." name class))
 720                                        slotdef))
 721                                  slots)))))
 722       (dolist (slotdef slotdefs)
 723         (let* ((dbi (view-class-slot-db-info slotdef))
 724                (slotdef-name (slot-definition-name slotdef))
 725                (foreign-key (gethash :foreign-key dbi))
 726                (home-key (gethash :home-key dbi))
 727                (object-keys
 728                 (remove-duplicates
 729                  (if force-p
 730                      (mapcar #'(lambda (o) (slot-value o home-key)) objects)
 731                    (remove-if #'null
 732                               (mapcar
 733                                #'(lambda (o) (if (slot-boundp o slotdef-name)
 734                                                  nil
 735                                                (slot-value o home-key)))
 736                                objects)))))
 737                (n-object-keys (length object-keys))
 738                (query-len (or max-len n-object-keys)))
 739
 740           (do ((i 0 (+ i query-len)))
 741               ((>= i n-object-keys))
 742             (let* ((keys (if max-len
 743                              (subseq object-keys i (min (+ i query-len) n-object-keys))
 744                            object-keys))
 745                    (results (find-all (list (gethash :join-class dbi))
 746                                       :where (make-instance 'sql-relational-exp
 747                                                :operator 'in
 748                                                :sub-expressions (list (sql-expression :attribute foreign-key)
 749                                                                       keys))
 750                                       :result-types :auto
 751                                       :flatp t)))
 752
 753               (dolist (object objects)
 754                 (when (or force-p (not (slot-boundp object slotdef-name)))
 755                   (let ((res (remove-if-not #'(lambda (obj)
 756                                                 (equal obj (slot-value
 757                                                             object
 758                                                             home-key)))
 759                                             results
 760                                             :key #'(lambda (res)
 761                                                      (slot-value res
 762                                                                  foreign-key)))))
 763                     (when res
 764                       (setf (slot-value object slotdef-name)
 765                             (if (gethash :set dbi) res (car res)))))))))))))
 766   (values))
 767
 768 (defun fault-join-slot-raw (class object slot-def)
 769   (let* ((dbi (view-class-slot-db-info slot-def))
 770          (jc (gethash :join-class dbi)))
 771     (let ((jq (join-qualifier class object slot-def)))
 772       (when jq
 773         (select jc :where jq :flatp t :result-types nil
 774                 :database (view-database object))))))
 775
 776 (defun fault-join-slot (class object slot-def)
 777   (let* ((dbi (view-class-slot-db-info slot-def))
 778          (ts (gethash :target-slot dbi)))
 779     (if (and ts (gethash :set dbi))
 780         (fault-join-target-slot class object slot-def)
 781         (let ((res (fault-join-slot-raw class object slot-def)))
 782           (when res
 783             (cond
 784               ((and ts (not (gethash :set dbi)))
 785                (mapcar (lambda (obj) (slot-value obj ts)) res))
 786               ((and (not ts) (not (gethash :set dbi)))
 787                (car res))
 788               ((and (not ts) (gethash :set dbi))
 789                res)))))))
 790
 791 (defun join-qualifier (class object slot-def)
 792     (declare (ignore class))
 793     (let* ((dbi (view-class-slot-db-info slot-def))
 794            (jc (find-class (gethash :join-class dbi)))
 795            ;;(ts (gethash :target-slot dbi))
 796            ;;(tsdef (if ts (slotdef-for-slot-with-class ts jc)))
 797            (foreign-keys (gethash :foreign-key dbi))
 798            (home-keys (gethash :home-key dbi)))
 799       (when (every #'(lambda (slt)
 800                        (and (slot-boundp object slt)
 801                             (not (null (slot-value object slt)))))
 802                    (if (listp home-keys) home-keys (list home-keys)))
 803         (let ((jc
 804                (mapcar #'(lambda (hk fk)
 805                            (let ((fksd (slotdef-for-slot-with-class fk jc)))
 806                              (sql-operation '==
 807                                             (typecase fk
 808                                               (symbol
 809                                                (sql-expression
 810                                                 :attribute
 811                                                 (view-class-slot-column fksd)
 812                                                 :table (view-table jc)))
 813                                               (t fk))
 814                                             (typecase hk
 815                                               (symbol
 816                                                (slot-value object hk))
 817                                               (t
 818                                                hk)))))
 819                        (if (listp home-keys)
 820                            home-keys
 821                            (list home-keys))
 822                        (if (listp foreign-keys)
 823                            foreign-keys
 824                            (list foreign-keys)))))
 825           (when jc
 826             (if (> (length jc) 1)
 827                 (apply #'sql-and jc)
 828                 jc))))))
 829
 830 ;; FIXME: add retrieval immediate for efficiency
 831 ;; For example, for (select 'employee-address) in test suite =>
 832 ;; select addr.*,ea_join.* FROM addr,ea_join WHERE ea_join.aaddressid=addr.addressid\g
 833
 834 (defun build-objects (vals sclasses immediate-join-classes sels immediate-joins database refresh flatp instances)
 835   "Used by find-all to build objects."
 836   (labels ((build-object (vals vclass jclasses selects immediate-selects instance)
 837              (let* ((db-vals (butlast vals (- (list-length vals)
 838                                               (list-length selects))))
 839                     (obj (if instance instance (make-instance (class-name vclass) :view-database database)))
 840                     (join-vals (subseq vals (list-length selects)))
 841                     (joins (mapcar #'(lambda (c) (when c (make-instance c :view-database database)))
 842                                    jclasses)))
 843
 844                ;;(format t "joins: ~S~%db-vals: ~S~%join-values: ~S~%selects: ~S~%immediate-selects: ~S~%"
 845                ;;joins db-vals join-vals selects immediate-selects)
 846
 847                ;; use refresh keyword here
 848                (setf obj (get-slot-values-from-view obj (mapcar #'car selects) db-vals))
 849                (mapc #'(lambda (jo)
 850                          ;; find all immediate-select slots and join-vals for this object
 851                          (let* ((slots (class-slots (class-of jo)))
 852                                 (pos-list (remove-if #'null
 853                                                      (mapcar
 854                                                       #'(lambda (s)
 855                                                           (position s immediate-selects
 856                                                                     :key #'car
 857                                                                     :test #'eq))
 858                                                       slots))))
 859                            (get-slot-values-from-view jo
 860                                                       (mapcar #'car
 861                                                               (mapcar #'(lambda (pos)
 862                                                                           (nth pos immediate-selects))
 863                                                                       pos-list))
 864                                                       (mapcar #'(lambda (pos) (nth pos join-vals))
 865                                                               pos-list))))
 866                      joins)
 867                (mapc
 868                 #'(lambda (jc)
 869                     (let ((slot (find (class-name (class-of jc)) (class-slots vclass)
 870                                       :key #'(lambda (slot)
 871                                                (when (and (eq :join (view-class-slot-db-kind slot))
 872                                                           (eq (slot-definition-name slot)
 873                                                               (gethash :join-class (view-class-slot-db-info slot))))
 874                                                  (slot-definition-name slot))))))
 875                       (when slot
 876                         (setf (slot-value obj (slot-definition-name slot)) jc))))
 877                 joins)
 878                (when refresh (instance-refreshed obj))
 879                obj)))
 880     (let* ((objects
 881             (mapcar #'(lambda (sclass jclass sel immediate-join instance)
 882                         (prog1
 883                             (build-object vals sclass jclass sel immediate-join instance)
 884                           (setf vals (nthcdr (+ (list-length sel) (list-length immediate-join))
 885                                              vals))))
 886                     sclasses immediate-join-classes sels immediate-joins instances)))
 887       (if (and flatp (= (length sclasses) 1))
 888           (car objects)
 889         objects))))
 890
 891 (defun find-all (view-classes
 892                  &rest args
 893                  &key all set-operation distinct from where group-by having
 894                       order-by offset limit refresh flatp result-types
 895                       inner-join on
 896                       (database *default-database*)
 897                       instances)
 898   "Called by SELECT to generate object query results when the
 899   View Classes VIEW-CLASSES are passed as arguments to SELECT."
 900   (declare (ignore all set-operation group-by having offset limit inner-join on)
 901            (optimize (debug 3) (speed 1)))
 902   (flet ((ref-equal (ref1 ref2)
 903            (string= (sql-output ref1 database)
 904                     (sql-output ref2 database)))
 905          (table-sql-expr (table)
 906            (sql-expression :table (view-table table)))
 907          (tables-equal (table-a table-b)
 908            (when (and table-a table-b)
 909              (string= (string (slot-value table-a 'name))
 910                       (string (slot-value table-b 'name))))))
 911     (remf args :from)
 912     (remf args :where)
 913     (remf args :flatp)
 914     (remf args :additional-fields)
 915     (remf args :result-types)
 916     (remf args :instances)
 917     (let* ((*db-deserializing* t)
 918            (sclasses (mapcar #'find-class view-classes))
 919            (immediate-join-slots
 920             (mapcar #'(lambda (c) (generate-retrieval-joins-list c :immediate)) sclasses))
 921            (immediate-join-classes
 922             (mapcar #'(lambda (jcs)
 923                         (mapcar #'(lambda (slotdef)
 924                                     (find-class (gethash :join-class (view-class-slot-db-info slotdef))))
 925                                 jcs))
 926                     immediate-join-slots))
 927            (immediate-join-sels (mapcar #'generate-immediate-joins-selection-list sclasses))
 928            (sels (mapcar #'generate-selection-list sclasses))
 929            (fullsels (apply #'append (mapcar #'append sels immediate-join-sels)))
 930            (sel-tables (collect-table-refs where))
 931            (tables (remove-if #'null
 932                               (remove-duplicates
 933                                (append (mapcar #'table-sql-expr sclasses)
 934                                        (mapcan #'(lambda (jc-list)
 935                                                    (mapcar
 936                                                     #'(lambda (jc) (when jc (table-sql-expr jc)))
 937                                                     jc-list))
 938                                                immediate-join-classes)
 939                                        sel-tables)
 940                                :test #'tables-equal)))
 941            (order-by-slots (mapcar #'(lambda (ob) (if (atom ob) ob (car ob)))
 942                                    (listify order-by)))
 943            (join-where nil))
 944
 945
 946       ;;(format t "sclasses: ~W~%ijc: ~W~%tables: ~W~%" sclasses immediate-join-classes tables)
 947
 948       (dolist (ob order-by-slots)
 949         (when (and ob (not (member ob (mapcar #'cdr fullsels)
 950                                    :test #'ref-equal)))
 951           (setq fullsels
 952             (append fullsels (mapcar #'(lambda (att) (cons nil att))
 953                                      order-by-slots)))))
 954       (dolist (ob (listify distinct))
 955         (when (and (typep ob 'sql-ident)
 956                    (not (member ob (mapcar #'cdr fullsels)
 957                                 :test #'ref-equal)))
 958           (setq fullsels
 959               (append fullsels (mapcar #'(lambda (att) (cons nil att))
 960                                        (listify ob))))))
 961       (mapcar #'(lambda (vclass jclasses jslots)
 962                   (when jclasses
 963                     (mapcar
 964                      #'(lambda (jclass jslot)
 965                          (let ((dbi (view-class-slot-db-info jslot)))
 966                            (setq join-where
 967                              (append
 968                               (list (sql-operation '==
 969                                                    (sql-expression
 970                                                     :attribute (gethash :foreign-key dbi)
 971                                                     :table (view-table jclass))
 972                                                    (sql-expression
 973                                                     :attribute (gethash :home-key dbi)
 974                                                     :table (view-table vclass))))
 975                               (when join-where (listify join-where))))))
 976                      jclasses jslots)))
 977               sclasses immediate-join-classes immediate-join-slots)
 978       (when where
 979         (setq where (listify where)))
 980       (cond
 981        ((and where join-where)
 982         (setq where (list (apply #'sql-and where join-where))))
 983        ((and (null where) (> (length join-where) 1))
 984         (setq where (list (apply #'sql-and join-where)))))
 985
 986       (let* ((rows (apply #'select
 987                           (append (mapcar #'cdr fullsels)
 988                                   (cons :from
 989                                         (list (append (when from (listify from))
 990                                                       (listify tables))))
 991                                   (list :result-types result-types)
 992                                   (when where
 993                                     (list :where where))
 994                                   args)))
 995              (instances-to-add (- (length rows) (length instances)))
 996              (perhaps-extended-instances
 997               (if (plusp instances-to-add)
 998                   (append instances (do ((i 0 (1+ i))
 999                                          (res nil))
1000                                         ((= i instances-to-add) res)
1001                                       (push (make-list (length sclasses) :initial-element nil) res)))
1002                 instances))
1003              (objects (mapcar
1004                        #'(lambda (row instance)
1005                            (build-objects row sclasses immediate-join-classes sels
1006                                           immediate-join-sels database refresh flatp
1007                                           (if (and flatp (atom instance))
1008                                               (list instance)
1009                                             instance)))
1010                        rows perhaps-extended-instances)))
1011         objects))))
1012
1013 (defmethod instance-refreshed ((instance standard-db-object)))
1014
1015 (defvar *default-caching* t
1016   "Controls whether SELECT caches objects by default. The CommonSQL
1017 specification states caching is on by default.")
1018
1019 (defun select (&rest select-all-args)
1020    "Executes a query on DATABASE, which has a default value of
1021 *DEFAULT-DATABASE*, specified by the SQL expressions supplied
1022 using the remaining arguments in SELECT-ALL-ARGS. The SELECT
1023 argument can be used to generate queries in both functional and
1024 object oriented contexts.
1025
1026 In the functional case, the required arguments specify the
1027 columns selected by the query and may be symbolic SQL expressions
1028 or strings representing attribute identifiers. Type modified
1029 identifiers indicate that the values selected from the specified
1030 column are converted to the specified lisp type. The keyword
1031 arguments ALL, DISTINCT, FROM, GROUP-by, HAVING, ORDER-BY,
1032 SET-OPERATION and WHERE are used to specify, using the symbolic
1033 SQL syntax, the corresponding components of the SQL query
1034 generated by the call to SELECT. RESULT-TYPES is a list of
1035 symbols which specifies the lisp type for each field returned by
1036 the query. If RESULT-TYPES is nil all results are returned as
1037 strings whereas the default value of :auto means that the lisp
1038 types are automatically computed for each field. FIELD-NAMES is t
1039 by default which means that the second value returned is a list
1040 of strings representing the columns selected by the query. If
1041 FIELD-NAMES is nil, the list of column names is not returned as a
1042 second value.
1043
1044 In the object oriented case, the required arguments to SELECT are
1045 symbols denoting View Classes which specify the database tables
1046 to query. In this case, SELECT returns a list of View Class
1047 instances whose slots are set from the attribute values of the
1048 records in the specified table. Slot-value is a legal operator
1049 which can be employed as part of the symbolic SQL syntax used in
1050 the WHERE keyword argument to SELECT. REFRESH is nil by default
1051 which means that the View Class instances returned are retrieved
1052 from a cache if an equivalent call to SELECT has previously been
1053 issued. If REFRESH is true, the View Class instances returned are
1054 updated as necessary from the database and the generic function
1055 INSTANCE-REFRESHED is called to perform any necessary operations
1056 on the updated instances.
1057
1058 In both object oriented and functional contexts, FLATP has a
1059 default value of nil which means that the results are returned as
1060 a list of lists. If FLATP is t and only one result is returned
1061 for each record selected in the query, the results are returned
1062 as elements of a list."
1063
1064    (flet ((select-objects (target-args)
1065             (and target-args
1066                  (every #'(lambda (arg)
1067                             (and (symbolp arg)
1068                                  (find-class arg nil)))
1069                         target-args))))
1070      (multiple-value-bind (target-args qualifier-args)
1071          (query-get-selections select-all-args)
1072        (unless (or *default-database* (getf qualifier-args :database))
1073          (signal-no-database-error nil))
1074
1075        (cond
1076          ((select-objects target-args)
1077           (let ((caching (getf qualifier-args :caching *default-caching*))
1078                 (result-types (getf qualifier-args :result-types :auto))
1079                 (refresh (getf qualifier-args :refresh nil))
1080                 (database (or (getf qualifier-args :database) *default-database*))
1081                 (order-by (getf qualifier-args :order-by)))
1082             (remf qualifier-args :caching)
1083             (remf qualifier-args :refresh)
1084             (remf qualifier-args :result-types)
1085
1086             ;; Add explicity table name to order-by if not specified and only
1087             ;; one selected table. This is required so FIND-ALL won't duplicate
1088             ;; the field
1089             (when (and order-by (= 1 (length target-args)))
1090               (let ((table-name  (view-table (find-class (car target-args))))
1091                     (order-by-list (copy-seq (listify order-by))))
1092
1093                 (loop for i from 0 below (length order-by-list)
1094                       do (etypecase (nth i order-by-list)
1095                            (sql-ident-attribute
1096                             (unless (slot-value (nth i order-by-list) 'qualifier)
1097                               (setf (slot-value (nth i order-by-list) 'qualifier) table-name)))
1098                            (cons
1099                             (unless (slot-value (car (nth i order-by-list)) 'qualifier)
1100                               (setf (slot-value (car (nth i order-by-list)) 'qualifier) table-name)))))
1101                 (setf (getf qualifier-args :order-by) order-by-list)))
1102
1103             (cond
1104               ((null caching)
1105                (apply #'find-all target-args
1106                       (append qualifier-args
1107                               (list :result-types result-types :refresh refresh))))
1108               (t
1109                (let ((cached (records-cache-results target-args qualifier-args database)))
1110                  (cond
1111                    ((and cached (not refresh))
1112                     cached)
1113                    ((and cached refresh)
1114                     (let ((results (apply #'find-all (append (list target-args) qualifier-args `(:instances ,cached :result-types :auto :refresh ,refresh)))))
1115                       (setf (records-cache-results target-args qualifier-args database) results)
1116                       results))
1117                    (t
1118                     (let ((results (apply #'find-all target-args (append qualifier-args
1119                                                                          `(:result-types :auto :refresh ,refresh)))))
1120                       (setf (records-cache-results target-args qualifier-args database) results)
1121                       results))))))))
1122          (t
1123           (let* ((expr (apply #'make-query select-all-args))
1124                  (specified-types
1125                   (mapcar #'(lambda (attrib)
1126                               (if (typep attrib 'sql-ident-attribute)
1127                                   (let ((type (slot-value attrib 'type)))
1128                                     (if type
1129                                         type
1130                                         t))
1131                                   t))
1132                           (slot-value expr 'selections))))
1133             (destructuring-bind (&key (flatp nil)
1134                                       (result-types :auto)
1135                                       (field-names t)
1136                                       (database *default-database*)
1137                                       &allow-other-keys)
1138                 qualifier-args
1139               (query expr :flatp flatp
1140                      :result-types
1141                      ;; specifying a type for an attribute overrides result-types
1142                      (if (some #'(lambda (x) (not (eq t x))) specified-types)
1143                          specified-types
1144                          result-types)
1145                      :field-names field-names
1146                      :database database))))))))
1147
1148 (defun compute-records-cache-key (targets qualifiers)
1149   (list targets
1150         (do ((args *select-arguments* (cdr args))
1151              (results nil))
1152             ((null args) results)
1153           (let* ((arg (car args))
1154                  (value (getf qualifiers arg)))
1155             (when value
1156               (push (list arg
1157                           (typecase value
1158                             (cons (cons (sql (car value)) (cdr value)))
1159                             (%sql-expression (sql value))
1160                             (t value)))
1161                     results))))))
1162
1163 (defun records-cache-results (targets qualifiers database)
1164   (when (record-caches database)
1165     (gethash (compute-records-cache-key targets qualifiers) (record-caches database))))
1166
1167 (defun (setf records-cache-results) (results targets qualifiers database)
1168   (unless (record-caches database)
1169     (setf (record-caches database)
1170           (make-hash-table :test 'equal
1171                            #+allegro   :values    #+allegro :weak
1172                            #+clisp     :weak      #+clisp :value
1173                            #+lispworks :weak-kind #+lispworks :value)))
1174   (setf (gethash (compute-records-cache-key targets qualifiers)
1175                  (record-caches database)) results)
1176   results)
1177
1178
1179
1180 ;;; Serialization functions
1181
1182 (defun write-instance-to-stream (obj stream)
1183   "Writes an instance to a stream where it can be later be read.
1184 NOTE: an error will occur if a slot holds a value which can not be written readably."
1185   (let* ((class (class-of obj))
1186          (alist '()))
1187     (dolist (slot (ordered-class-slots (class-of obj)))
1188       (let ((name (slot-definition-name slot)))
1189         (when (and (not (eq 'view-database name))
1190                    (slot-boundp obj name))
1191           (push (cons name (slot-value obj name)) alist))))
1192     (setq alist (reverse alist))
1193     (write (cons (class-name class) alist) :stream stream :readably t))
1194   obj)
1195
1196 (defun read-instance-from-stream (stream)
1197   (let ((raw (read stream nil nil)))
1198     (when raw
1199       (let ((obj (make-instance (car raw))))
1200         (dolist (pair (cdr raw))
1201           (setf (slot-value obj (car pair)) (cdr pair)))
1202         obj))))