sql/expressions.lisp

   1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
   2 ;;;; *************************************************************************
   3 ;;;;
   4 ;;;; $Id$
   5 ;;;;
   6 ;;;; Classes defining SQL expressions and methods for formatting the
   7 ;;;; appropriate SQL commands.
   8 ;;;;
   9 ;;;; This file is part of CLSQL.
  10 ;;;;
  11 ;;;; CLSQL users are granted the rights to distribute and use this software
  12 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
  13 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
  14 ;;;; *************************************************************************
  15
  16 (in-package #:clsql-sys)
  17
  18 (defvar +empty-string+ "''")
  19
  20 (defvar +null-string+ "NULL")
  21
  22 (defvar *sql-stream* nil
  23   "stream which accumulates SQL output")
  24
  25 (defun sql-output (sql-expr &optional (database *default-database*))
  26   "Top-level call for generating SQL strings. Returns an SQL
  27   string appropriate for DATABASE which corresponds to the
  28   supplied lisp expression SQL-EXPR."
  29   (progv '(*sql-stream*)
  30       `(,(make-string-output-stream))
  31     (output-sql sql-expr database)
  32     (get-output-stream-string *sql-stream*)))
  33
  34 (defmethod output-sql (expr database)
  35   (write-string (database-output-sql expr database) *sql-stream*)
  36   (values))
  37
  38 (defvar *output-hash* (make-hash-table :test #'equal)
  39   "For caching generated SQL strings.")
  40
  41 (defmethod output-sql :around ((sql t) database)
  42   (let* ((hash-key (output-sql-hash-key sql database))
  43          (hash-value (when hash-key (gethash hash-key *output-hash*))))
  44     (cond ((and hash-key hash-value)
  45            (write-string hash-value *sql-stream*))
  46           (hash-key
  47            (let ((*sql-stream* (make-string-output-stream)))
  48              (call-next-method)
  49              (setf hash-value (get-output-stream-string *sql-stream*))
  50              (setf (gethash hash-key *output-hash*) hash-value))
  51            (write-string hash-value *sql-stream*))
  52           (t
  53            (call-next-method)))))
  54
  55 (defmethod output-sql-hash-key (expr database)
  56   (declare (ignore expr database))
  57   nil)
  58
  59
  60 (defclass %sql-expression ()
  61   ())
  62
  63 (defmethod output-sql ((expr %sql-expression) database)
  64   (declare (ignore database))
  65   (write-string +null-string+ *sql-stream*))
  66
  67 (defmethod print-object ((self %sql-expression) stream)
  68   (print-unreadable-object
  69    (self stream :type t)
  70    (write-string (sql-output self) stream))
  71   self)
  72
  73 ;; For straight up strings
  74
  75 (defclass sql (%sql-expression)
  76   ((text
  77     :initarg :string
  78     :initform ""))
  79   (:documentation "A literal SQL expression."))
  80
  81 (defmethod make-load-form ((sql sql) &optional environment)
  82   (declare (ignore environment))
  83   (with-slots (text)
  84     sql
  85     `(make-instance 'sql :string ',text)))
  86
  87 (defmethod output-sql ((expr sql) database)
  88   (declare (ignore database))
  89   (write-string (slot-value expr 'text) *sql-stream*)
  90   t)
  91
  92 (defmethod print-object ((ident sql) stream)
  93   (format stream "#<~S \"~A\">"
  94           (type-of ident)
  95           (sql-output ident nil))
  96   ident)
  97
  98 ;; For SQL Identifiers of generic type
  99
 100 (defclass sql-ident (%sql-expression)
 101   ((name
 102     :initarg :name
 103     :initform +null-string+))
 104   (:documentation "An SQL identifer."))
 105
 106 (defmethod make-load-form ((sql sql-ident) &optional environment)
 107   (declare (ignore environment))
 108   (with-slots (name)
 109     sql
 110     `(make-instance 'sql-ident :name ',name)))
 111
 112 (defmethod output-sql ((expr sql-ident) database)
 113   (with-slots (name) expr
 114     (write-string
 115      (convert-to-db-default-case
 116       (etypecase name
 117         (string name)
 118         (symbol (symbol-name name)))
 119       database)
 120      *sql-stream*))
 121   t)
 122
 123 ;; For SQL Identifiers for attributes
 124
 125 (defclass sql-ident-attribute (sql-ident)
 126   ((qualifier
 127     :initarg :qualifier
 128     :initform +null-string+)
 129    (type
 130     :initarg :type
 131     :initform +null-string+))
 132   (:documentation "An SQL Attribute identifier."))
 133
 134 (defmethod collect-table-refs (sql)
 135   (declare (ignore sql))
 136   nil)
 137
 138 (defmethod collect-table-refs ((sql sql-ident-attribute))
 139   (let ((qual (slot-value sql 'qualifier)))
 140     (if (and qual (symbolp (slot-value sql 'qualifier)))
 141         (list (make-instance 'sql-ident-table :name
 142                              (slot-value sql 'qualifier))))))
 143
 144 (defmethod make-load-form ((sql sql-ident-attribute) &optional environment)
 145   (declare (ignore environment))
 146   (with-slots (qualifier type name)
 147     sql
 148     `(make-instance 'sql-ident-attribute :name ',name
 149       :qualifier ',qualifier
 150       :type ',type)))
 151
 152 (defmethod output-sql ((expr sql-ident-attribute) database)
 153   (with-slots (qualifier name type) expr
 154     (if (and (not qualifier) (not type))
 155         (etypecase name
 156           ;; Honor care of name
 157           (string
 158            (write-string name *sql-stream*))
 159           (symbol
 160            (write-string (sql-escape (convert-to-db-default-case
 161                                       (symbol-name name) database)) *sql-stream*)))
 162
 163         ;;; KMR: The TYPE field is used by CommonSQL for type conversion -- it
 164       ;;; should not be output in SQL statements
 165       #+ignore
 166       (format *sql-stream* "~@[~A.~]~A~@[ ~A~]"
 167               (when qualifier
 168                 (convert-to-db-default-case (sql-escape qualifier) database))
 169               (sql-escape (convert-to-db-default-case name database))
 170               (when type
 171                 (convert-to-db-default-case (symbol-name type) database)))
 172       (format *sql-stream* "~@[~A.~]~A"
 173               (when qualifier
 174                 (typecase qualifier
 175                   (string (format nil "~s" qualifier))
 176                   (t (convert-to-db-default-case (sql-escape qualifier)
 177                                                  database))))
 178               (sql-escape (convert-to-db-default-case name database))))
 179     t))
 180
 181 (defmethod output-sql-hash-key ((expr sql-ident-attribute) database)
 182   (with-slots (qualifier name type)
 183       expr
 184     (list (and database (database-underlying-type database))
 185           'sql-ident-attribute qualifier name type)))
 186
 187 ;; For SQL Identifiers for tables
 188
 189 (defclass sql-ident-table (sql-ident)
 190   ((alias
 191     :initarg :table-alias :initform nil))
 192   (:documentation "An SQL table identifier."))
 193
 194 (defmethod make-load-form ((sql sql-ident-table) &optional environment)
 195   (declare (ignore environment))
 196   (with-slots (alias name)
 197     sql
 198     `(make-instance 'sql-ident-table :name ',name :table-alias ',alias)))
 199
 200 (defmethod output-sql ((expr sql-ident-table) database)
 201   (with-slots (name alias) expr
 202      (let ((namestr (if (symbolp name)
 203                         (symbol-name name)
 204                       name)))
 205        (if (null alias)
 206            (write-string
 207             (sql-escape (convert-to-db-default-case namestr database))
 208             *sql-stream*)
 209          (progn
 210            (write-string
 211             (sql-escape (convert-to-db-default-case namestr database))
 212             *sql-stream*)
 213            (write-char #\Space *sql-stream*)
 214            (format *sql-stream* "~s" alias)))))
 215   t)
 216
 217 (defmethod output-sql-hash-key ((expr sql-ident-table) database)
 218   (with-slots (name alias)
 219       expr
 220     (list (and database (database-underlying-type database))
 221           'sql-ident-table name alias)))
 222
 223 (defclass sql-relational-exp (%sql-expression)
 224   ((operator
 225     :initarg :operator
 226     :initform nil)
 227    (sub-expressions
 228     :initarg :sub-expressions
 229     :initform nil))
 230   (:documentation "An SQL relational expression."))
 231
 232 (defmethod make-load-form ((self sql-relational-exp) &optional environment)
 233   (make-load-form-saving-slots self
 234                                :slot-names '(operator sub-expressions)
 235                                :environment environment))
 236
 237 (defmethod collect-table-refs ((sql sql-relational-exp))
 238   (let ((tabs nil))
 239     (dolist (exp (slot-value sql 'sub-expressions))
 240       (let ((refs (collect-table-refs exp)))
 241         (if refs (setf tabs (append refs tabs)))))
 242     (remove-duplicates tabs
 243                        :test (lambda (tab1 tab2)
 244                                (equal (slot-value tab1 'name)
 245                                       (slot-value tab2 'name))))))
 246
 247
 248
 249
 250 ;; Write SQL for relational operators (like 'AND' and 'OR').
 251 ;; should do arity checking of subexpressions
 252
 253 (defmethod output-sql ((expr sql-relational-exp) database)
 254   (with-slots (operator sub-expressions)
 255     expr
 256     (let ((subs (if (consp (car sub-expressions))
 257                     (car sub-expressions)
 258                     sub-expressions)))
 259       (write-char #\( *sql-stream*)
 260       (do ((sub subs (cdr sub)))
 261           ((null (cdr sub)) (output-sql (car sub) database))
 262         (output-sql (car sub) database)
 263         (write-char #\Space *sql-stream*)
 264         (output-sql operator database)
 265         (write-char #\Space *sql-stream*))
 266       (write-char #\) *sql-stream*)))
 267   t)
 268
 269 (defclass sql-upcase-like (sql-relational-exp)
 270   ()
 271   (:documentation "An SQL 'like' that upcases its arguments."))
 272
 273 (defmethod output-sql ((expr sql-upcase-like) database)
 274   (flet ((write-term (term)
 275            (write-string "upper(" *sql-stream*)
 276            (output-sql term database)
 277            (write-char #\) *sql-stream*)))
 278     (with-slots (sub-expressions)
 279       expr
 280       (let ((subs (if (consp (car sub-expressions))
 281                       (car sub-expressions)
 282                       sub-expressions)))
 283         (write-char #\( *sql-stream*)
 284         (do ((sub subs (cdr sub)))
 285             ((null (cdr sub)) (write-term (car sub)))
 286           (write-term (car sub))
 287           (write-string " LIKE " *sql-stream*))
 288         (write-char #\) *sql-stream*))))
 289   t)
 290
 291 (defclass sql-assignment-exp (sql-relational-exp)
 292   ()
 293   (:documentation "An SQL Assignment expression."))
 294
 295
 296 (defmethod output-sql ((expr sql-assignment-exp) database)
 297   (with-slots (operator sub-expressions)
 298     expr
 299     (do ((sub sub-expressions (cdr sub)))
 300         ((null (cdr sub)) (output-sql (car sub) database))
 301       (output-sql (car sub) database)
 302       (write-char #\Space *sql-stream*)
 303       (output-sql operator database)
 304       (write-char #\Space *sql-stream*)))
 305   t)
 306
 307 (defclass sql-value-exp (%sql-expression)
 308   ((modifier
 309     :initarg :modifier
 310     :initform nil)
 311    (components
 312     :initarg :components
 313     :initform nil))
 314   (:documentation
 315    "An SQL value expression.")
 316   )
 317
 318 (defmethod collect-table-refs ((sql sql-value-exp))
 319   (let ((tabs nil))
 320     (if (listp (slot-value sql 'components))
 321         (progn
 322           (dolist (exp (slot-value sql 'components))
 323             (let ((refs (collect-table-refs exp)))
 324               (if refs (setf tabs (append refs tabs)))))
 325           (remove-duplicates tabs
 326                              :test (lambda (tab1 tab2)
 327                                      (equal (slot-value tab1 'name)
 328                                             (slot-value tab2 'name)))))
 329         nil)))
 330
 331
 332
 333 (defmethod output-sql ((expr sql-value-exp) database)
 334   (with-slots (modifier components)
 335     expr
 336     (if modifier
 337         (progn
 338           (write-char #\( *sql-stream*)
 339           (output-sql modifier database)
 340           (write-char #\Space *sql-stream*)
 341           (output-sql components database)
 342           (write-char #\) *sql-stream*))
 343         (output-sql components database))))
 344
 345 (defclass sql-typecast-exp (sql-value-exp)
 346   ()
 347   (:documentation "An SQL typecast expression."))
 348
 349 (defmethod output-sql ((expr sql-typecast-exp) database)
 350   (with-slots (components)
 351     expr
 352     (output-sql components database)))
 353
 354 (defmethod collect-table-refs ((sql sql-typecast-exp))
 355   (when (slot-value sql 'components)
 356     (collect-table-refs (slot-value sql 'components))))
 357
 358 (defclass sql-function-exp (%sql-expression)
 359   ((name
 360     :initarg :name
 361     :initform nil)
 362    (args
 363     :initarg :args
 364     :initform nil))
 365   (:documentation
 366    "An SQL function expression."))
 367
 368 (defmethod collect-table-refs ((sql sql-function-exp))
 369   (let ((tabs nil))
 370     (dolist (exp (slot-value sql 'args))
 371       (let ((refs (collect-table-refs exp)))
 372         (if refs (setf tabs (append refs tabs)))))
 373     (remove-duplicates tabs
 374                        :test (lambda (tab1 tab2)
 375                                (equal (slot-value tab1 'name)
 376                                       (slot-value tab2 'name))))))
 377 (defvar *in-subselect* nil)
 378
 379 (defmethod output-sql ((expr sql-function-exp) database)
 380   (with-slots (name args)
 381     expr
 382     (output-sql name database)
 383     (let ((*in-subselect* nil)) ;; aboid double parens
 384       (when args (output-sql args database))))
 385   t)
 386
 387
 388 (defclass sql-between-exp (sql-function-exp)
 389   ()
 390   (:documentation "An SQL between expression."))
 391
 392 (defmethod output-sql ((expr sql-between-exp) database)
 393   (with-slots (name args)
 394       expr
 395     (output-sql (first args) database)
 396     (write-string " BETWEEN " *sql-stream*)
 397     (output-sql (second args) database)
 398     (write-string " AND " *sql-stream*)
 399     (output-sql (third args) database))
 400   t)
 401
 402 (defclass sql-query-modifier-exp (%sql-expression)
 403   ((modifier :initarg :modifier :initform nil)
 404    (components :initarg :components :initform nil))
 405   (:documentation "An SQL query modifier expression."))
 406
 407 (defmethod output-sql ((expr sql-query-modifier-exp) database)
 408   (with-slots (modifier components)
 409       expr
 410     (output-sql modifier database)
 411     (write-string " " *sql-stream*)
 412     (output-sql (car components) database)
 413     (when components
 414       (mapc #'(lambda (comp)
 415                 (write-string ", " *sql-stream*)
 416                 (output-sql comp database))
 417             (cdr components))))
 418   t)
 419
 420 (defclass sql-set-exp (%sql-expression)
 421   ((operator
 422     :initarg :operator
 423     :initform nil)
 424    (sub-expressions
 425     :initarg :sub-expressions
 426     :initform nil))
 427   (:documentation "An SQL set expression."))
 428
 429 (defmethod collect-table-refs ((sql sql-set-exp))
 430   (let ((tabs nil))
 431     (dolist (exp (slot-value sql 'sub-expressions))
 432       (let ((refs (collect-table-refs exp)))
 433         (if refs (setf tabs (append refs tabs)))))
 434     (remove-duplicates tabs
 435                        :test (lambda (tab1 tab2)
 436                                (equal (slot-value tab1 'name)
 437                                       (slot-value tab2 'name))))))
 438
 439 (defmethod output-sql ((expr sql-set-exp) database)
 440   (with-slots (operator sub-expressions)
 441       expr
 442     (let ((subs (if (consp (car sub-expressions))
 443                     (car sub-expressions)
 444                     sub-expressions)))
 445       (when (= (length subs) 1)
 446         (output-sql operator database)
 447         (write-char #\Space *sql-stream*))
 448       (do ((sub subs (cdr sub)))
 449           ((null (cdr sub)) (output-sql (car sub) database))
 450         (output-sql (car sub) database)
 451         (write-char #\Space *sql-stream*)
 452         (output-sql operator database)
 453         (write-char #\Space *sql-stream*))))
 454   t)
 455
 456 (defclass sql-query (%sql-expression)
 457   ((selections
 458     :initarg :selections
 459     :initform nil)
 460    (all
 461     :initarg :all
 462     :initform nil)
 463    (flatp
 464     :initarg :flatp
 465     :initform nil)
 466    (set-operation
 467     :initarg :set-operation
 468     :initform nil)
 469    (distinct
 470     :initarg :distinct
 471     :initform nil)
 472    (from
 473     :initarg :from
 474     :initform nil)
 475    (where
 476     :initarg :where
 477     :initform nil)
 478    (group-by
 479     :initarg :group-by
 480     :initform nil)
 481    (having
 482     :initarg :having
 483     :initform nil)
 484    (limit
 485     :initarg :limit
 486     :initform nil)
 487    (offset
 488     :initarg :offset
 489     :initform nil)
 490    (order-by
 491     :initarg :order-by
 492     :initform nil)
 493    (inner-join
 494     :initarg :inner-join
 495     :initform nil)
 496    (on
 497     :initarg :on
 498     :initform nil))
 499   (:documentation "An SQL SELECT query."))
 500
 501 (defclass sql-object-query (%sql-expression)
 502   ((objects
 503     :initarg :objects
 504     :initform nil)
 505    (flatp
 506     :initarg :flatp
 507     :initform nil)
 508    (exp
 509     :initarg :exp
 510     :initform nil)
 511    (refresh
 512     :initarg :refresh
 513     :initform nil)))
 514
 515 (defmethod collect-table-refs ((sql sql-query))
 516   (remove-duplicates (collect-table-refs (slot-value sql 'where))
 517                      :test (lambda (tab1 tab2)
 518                              (equal (slot-value tab1 'name)
 519                                     (slot-value tab2 'name)))))
 520
 521 (defvar *select-arguments*
 522   '(:all :database :distinct :flatp :from :group-by :having :order-by
 523     :set-operation :where :offset :limit :inner-join :on
 524     ;; below keywords are not a SQL argument, but these keywords may terminate select
 525     :caching :refresh))
 526
 527 (defun query-arg-p (sym)
 528   (member sym *select-arguments*))
 529
 530 (defun query-get-selections (select-args)
 531   "Return two values: the list of select-args up to the first keyword,
 532 uninclusive, and the args from that keyword to the end."
 533   (let ((first-key-arg (position-if #'query-arg-p select-args)))
 534     (if first-key-arg
 535         (values (subseq select-args 0 first-key-arg)
 536                 (subseq select-args first-key-arg))
 537         select-args)))
 538
 539 (defun make-query (&rest args)
 540   (flet ((select-objects (target-args)
 541            (and target-args
 542                 (every #'(lambda (arg)
 543                            (and (symbolp arg)
 544                                 (find-class arg nil)))
 545                        target-args))))
 546     (multiple-value-bind (selections arglist)
 547         (query-get-selections args)
 548       (if (select-objects selections)
 549           (destructuring-bind (&key flatp refresh &allow-other-keys) arglist
 550             (make-instance 'sql-object-query :objects selections
 551                            :flatp flatp :refresh refresh
 552                            :exp arglist))
 553           (destructuring-bind (&key all flatp set-operation distinct from where
 554                                     group-by having order-by
 555                                     offset limit inner-join on &allow-other-keys)
 556               arglist
 557             (if (null selections)
 558                 (error "No target columns supplied to select statement."))
 559             (if (null from)
 560                 (error "No source tables supplied to select statement."))
 561             (make-instance 'sql-query :selections selections
 562                            :all all :flatp flatp :set-operation set-operation
 563                            :distinct distinct :from from :where where
 564                            :limit limit :offset offset
 565                            :group-by group-by :having having :order-by order-by
 566                            :inner-join inner-join :on on))))))
 567
 568 (defmethod output-sql ((query sql-query) database)
 569   (with-slots (distinct selections from where group-by having order-by
 570                         limit offset inner-join on all set-operation)
 571       query
 572     (when *in-subselect*
 573       (write-string "(" *sql-stream*))
 574     (write-string "SELECT " *sql-stream*)
 575     (when all
 576       (write-string "ALL " *sql-stream*))
 577     (when (and distinct (not all))
 578       (write-string "DISTINCT " *sql-stream*)
 579       (unless (eql t distinct)
 580         (write-string "ON " *sql-stream*)
 581         (output-sql distinct database)
 582         (write-char #\Space *sql-stream*)))
 583     (output-sql (apply #'vector selections) database)
 584     (when from
 585       (write-string " FROM " *sql-stream*)
 586       (flet ((ident-table-equal (a b)
 587                (and (if (and (eql (type-of a) 'sql-ident-table)
 588                              (eql (type-of b) 'sql-ident-table))
 589                         (string-equal (slot-value a 'alias)
 590                                       (slot-value b 'alias))
 591                         t)
 592                     (string-equal (sql-escape (slot-value a 'name))
 593                                   (sql-escape (slot-value b 'name))))))
 594         (typecase from
 595           (list (output-sql (apply #'vector
 596                                    (remove-duplicates from
 597                                                       :test #'ident-table-equal))
 598                             database))
 599           (string (write-string from *sql-stream*))
 600           (t (let ((*in-subselect* t))
 601                (output-sql from database))))))
 602     (when inner-join
 603       (write-string " INNER JOIN " *sql-stream*)
 604       (output-sql inner-join database))
 605     (when on
 606       (write-string " ON " *sql-stream*)
 607       (output-sql on database))
 608     (when where
 609       (write-string " WHERE " *sql-stream*)
 610       (let ((*in-subselect* t))
 611         (output-sql where database)))
 612     (when group-by
 613       (write-string " GROUP BY " *sql-stream*)
 614       (if (listp group-by)
 615           (do ((order group-by (cdr order)))
 616               ((null order))
 617             (let ((item (car order)))
 618               (typecase item
 619                 (cons
 620                  (output-sql (car item) database)
 621                  (format *sql-stream* " ~A" (cadr item)))
 622                 (t
 623                  (output-sql item database)))
 624               (when (cdr order)
 625                 (write-char #\, *sql-stream*))))
 626           (output-sql group-by database)))
 627     (when having
 628       (write-string " HAVING " *sql-stream*)
 629       (output-sql having database))
 630     (when order-by
 631       (write-string " ORDER BY " *sql-stream*)
 632       (if (listp order-by)
 633           (do ((order order-by (cdr order)))
 634               ((null order))
 635             (let ((item (car order)))
 636               (typecase item
 637                 (cons
 638                  (output-sql (car item) database)
 639                  (format *sql-stream* " ~A" (cadr item)))
 640                 (t
 641                  (output-sql item database)))
 642               (when (cdr order)
 643                 (write-char #\, *sql-stream*))))
 644           (output-sql order-by database)))
 645     (when limit
 646       (write-string " LIMIT " *sql-stream*)
 647       (output-sql limit database))
 648     (when offset
 649       (write-string " OFFSET " *sql-stream*)
 650       (output-sql offset database))
 651     (when *in-subselect*
 652       (write-string ")" *sql-stream*))
 653     (when set-operation
 654       (write-char #\Space *sql-stream*)
 655       (output-sql set-operation database)))
 656   t)
 657
 658 (defmethod output-sql ((query sql-object-query) database)
 659   (declare (ignore database))
 660   (with-slots (objects)
 661       query
 662     (when objects
 663       (format *sql-stream* "(~{~A~^ ~})" objects))))
 664
 665
 666 ;; INSERT
 667
 668 (defclass sql-insert (%sql-expression)
 669   ((into
 670     :initarg :into
 671     :initform nil)
 672    (attributes
 673     :initarg :attributes
 674     :initform nil)
 675    (values
 676     :initarg :values
 677     :initform nil)
 678    (query
 679     :initarg :query
 680     :initform nil))
 681   (:documentation
 682    "An SQL INSERT statement."))
 683
 684 (defmethod output-sql ((ins sql-insert) database)
 685   (with-slots (into attributes values query)
 686     ins
 687     (write-string "INSERT INTO " *sql-stream*)
 688     (output-sql
 689      (typecase into
 690        (string (sql-expression :attribute into))
 691        (t into))
 692      database)
 693     (when attributes
 694       (write-char #\Space *sql-stream*)
 695       (output-sql attributes database))
 696     (when values
 697       (write-string " VALUES " *sql-stream*)
 698       (output-sql values database))
 699     (when query
 700       (write-char #\Space *sql-stream*)
 701       (output-sql query database)))
 702   t)
 703
 704 ;; DELETE
 705
 706 (defclass sql-delete (%sql-expression)
 707   ((from
 708     :initarg :from
 709     :initform nil)
 710    (where
 711     :initarg :where
 712     :initform nil))
 713   (:documentation
 714    "An SQL DELETE statement."))
 715
 716 (defmethod output-sql ((stmt sql-delete) database)
 717   (with-slots (from where)
 718     stmt
 719     (write-string "DELETE FROM " *sql-stream*)
 720     (typecase from
 721       ((or symbol string) (write-string (sql-escape from) *sql-stream*))
 722       (t  (output-sql from database)))
 723     (when where
 724       (write-string " WHERE " *sql-stream*)
 725       (output-sql where database)))
 726   t)
 727
 728 ;; UPDATE
 729
 730 (defclass sql-update (%sql-expression)
 731   ((table
 732     :initarg :table
 733     :initform nil)
 734    (attributes
 735     :initarg :attributes
 736     :initform nil)
 737    (values
 738     :initarg :values
 739     :initform nil)
 740    (where
 741     :initarg :where
 742     :initform nil))
 743   (:documentation "An SQL UPDATE statement."))
 744
 745 (defmethod output-sql ((expr sql-update) database)
 746   (with-slots (table where attributes values)
 747     expr
 748     (flet ((update-assignments ()
 749              (mapcar #'(lambda (a b)
 750                          (make-instance 'sql-assignment-exp
 751                                         :operator '=
 752                                         :sub-expressions (list a b)))
 753                      attributes values)))
 754       (write-string "UPDATE " *sql-stream*)
 755       (output-sql table database)
 756       (write-string " SET " *sql-stream*)
 757       (output-sql (apply #'vector (update-assignments)) database)
 758       (when where
 759         (write-string " WHERE " *sql-stream*)
 760         (output-sql where database))))
 761   t)
 762
 763 ;; CREATE TABLE
 764
 765 (defclass sql-create-table (%sql-expression)
 766   ((name
 767     :initarg :name
 768     :initform nil)
 769    (columns
 770     :initarg :columns
 771     :initform nil)
 772    (modifiers
 773     :initarg :modifiers
 774     :initform nil)
 775    (transactions
 776     :initarg :transactions
 777     :initform nil))
 778   (:documentation
 779    "An SQL CREATE TABLE statement."))
 780
 781 ;; Here's a real warhorse of a function!
 782
 783 (declaim (inline listify))
 784 (defun listify (x)
 785   (if (atom x)
 786       (list x)
 787       x))
 788
 789 (defmethod output-sql ((stmt sql-create-table) database)
 790   (flet ((output-column (column-spec)
 791            (destructuring-bind (name type &optional db-type &rest constraints)
 792                column-spec
 793              (let ((type (listify type)))
 794                (output-sql name database)
 795                (write-char #\Space *sql-stream*)
 796                (write-string
 797                 (if (stringp db-type) db-type ; override definition
 798                   (database-get-type-specifier (car type) (cdr type) database
 799                                                (database-underlying-type database)))
 800                 *sql-stream*)
 801                (let ((constraints (database-constraint-statement
 802                                    (if (and db-type (symbolp db-type))
 803                                        (cons db-type constraints)
 804                                        constraints)
 805                                    database)))
 806                  (when constraints
 807                    (write-string " " *sql-stream*)
 808                    (write-string constraints *sql-stream*)))))))
 809     (with-slots (name columns modifiers transactions)
 810       stmt
 811       (write-string "CREATE TABLE " *sql-stream*)
 812       (output-sql name database)
 813       (write-string " (" *sql-stream*)
 814       (do ((column columns (cdr column)))
 815           ((null (cdr column))
 816            (output-column (car column)))
 817         (output-column (car column))
 818         (write-string ", " *sql-stream*))
 819       (when modifiers
 820         (do ((modifier (listify modifiers) (cdr modifier)))
 821             ((null modifier))
 822           (write-string ", " *sql-stream*)
 823           (write-string (car modifier) *sql-stream*)))
 824       (write-char #\) *sql-stream*)
 825       (when (and (eq :mysql (database-underlying-type database))
 826                  transactions
 827                  (db-type-transaction-capable? :mysql database))
 828         (write-string " Type=InnoDB" *sql-stream*))))
 829   t)
 830
 831
 832 ;; CREATE VIEW
 833
 834 (defclass sql-create-view (%sql-expression)
 835   ((name :initarg :name :initform nil)
 836    (column-list :initarg :column-list :initform nil)
 837    (query :initarg :query :initform nil)
 838    (with-check-option :initarg :with-check-option :initform nil))
 839   (:documentation "An SQL CREATE VIEW statement."))
 840
 841 (defmethod output-sql ((stmt sql-create-view) database)
 842   (with-slots (name column-list query with-check-option) stmt
 843     (write-string "CREATE VIEW " *sql-stream*)
 844     (output-sql name database)
 845     (when column-list (write-string " " *sql-stream*)
 846           (output-sql (listify column-list) database))
 847     (write-string " AS " *sql-stream*)
 848     (output-sql query database)
 849     (when with-check-option (write-string " WITH CHECK OPTION" *sql-stream*))))
 850
 851
 852 ;;
 853 ;; DATABASE-OUTPUT-SQL
 854 ;;
 855
 856 (defmethod database-output-sql ((str string) database)
 857   (declare (optimize (speed 3) (safety 1)
 858                      #+cmu (extensions:inhibit-warnings 3)))
 859   (let ((len (length str)))
 860     (declare (type fixnum len))
 861     (cond ((zerop len)
 862            +empty-string+)
 863           ((and (null (position #\' str))
 864                 (null (position #\\ str)))
 865            (concatenate 'string "'" str "'"))
 866           (t
 867            (let ((buf (make-string (+ (* len 2) 2) :initial-element #\')))
 868              (declare (simple-string buf))
 869              (do* ((i 0 (incf i))
 870                    (j 1 (incf j)))
 871                   ((= i len) (subseq buf 0 (1+ j)))
 872                (declare (type fixnum i j))
 873                (let ((char (aref str i)))
 874                  (declare (character char))
 875                  (cond ((char= char #\')
 876                         (setf (aref buf j) #\')
 877                         (incf j)
 878                         (setf (aref buf j) #\'))
 879                        ((and (char= char #\\)
 880                              ;; MTP: only escape backslash with pgsql/mysql
 881                              (member (database-underlying-type database)
 882                                      '(:postgresql :mysql)
 883                                      :test #'eq))
 884                         (setf (aref buf j) #\\)
 885                         (incf j)
 886                         (setf (aref buf j) #\\))
 887                        (t
 888                         (setf (aref buf j) char))))))))))
 889
 890 (let ((keyword-package (symbol-package :foo)))
 891   (defmethod database-output-sql ((sym symbol) database)
 892   (if (null sym)
 893       +null-string+
 894       (convert-to-db-default-case
 895        (if (equal (symbol-package sym) keyword-package)
 896            (concatenate 'string "'" (string sym) "'")
 897            (symbol-name sym))
 898        database))))
 899
 900 (defmethod database-output-sql ((tee (eql t)) database)
 901   (if database
 902       (let ((val (database-output-sql-as-type 'boolean t database (database-type database))))
 903         (when val
 904           (typecase val
 905             (string (format nil "'~A'" val))
 906             (integer (format nil "~A" val)))))
 907     "'Y'"))
 908
 909 #+nil(defmethod database-output-sql ((tee (eql t)) database)
 910   (declare (ignore database))
 911   "'Y'")
 912
 913 (defmethod database-output-sql ((num number) database)
 914   (declare (ignore database))
 915   (number-to-sql-string num))
 916
 917 (defmethod database-output-sql ((arg list) database)
 918   (if (null arg)
 919       +null-string+
 920       (format nil "(~{~A~^,~})" (mapcar #'(lambda (val)
 921                                             (sql-output val database))
 922                                         arg))))
 923
 924 (defmethod database-output-sql ((arg vector) database)
 925   (format nil "~{~A~^,~}" (map 'list #'(lambda (val)
 926                                          (sql-output val database))
 927                                arg)))
 928
 929 (defmethod output-sql-hash-key ((arg vector) database)
 930   (list 'vector (map 'list (lambda (arg)
 931                              (or (output-sql-hash-key arg database)
 932                                  (return-from output-sql-hash-key nil)))
 933                      arg)))
 934
 935 (defmethod database-output-sql ((self wall-time) database)
 936   (declare (ignore database))
 937   (db-timestring self))
 938
 939 (defmethod database-output-sql ((self date) database)
 940   (declare (ignore database))
 941   (db-datestring self))
 942
 943 (defmethod database-output-sql ((self duration) database)
 944   (declare (ignore database))
 945   (format nil "'~a'" (duration-timestring self)))
 946
 947 #+ignore
 948 (defmethod database-output-sql ((self money) database)
 949   (database-output-sql (slot-value self 'odcl::units) database))
 950
 951 (defmethod database-output-sql (thing database)
 952   (if (or (null thing)
 953           (eq 'null thing))
 954       +null-string+
 955     (error 'sql-user-error
 956            :message
 957            (format nil
 958                    "No type conversion to SQL for ~A is defined for DB ~A."
 959                    (type-of thing) (type-of database)))))
 960
 961
 962 ;;
 963 ;; Column constraint types and conversion to SQL
 964 ;;
 965
 966 (defparameter *constraint-types*
 967   (list
 968    (cons (symbol-name-default-case "NOT-NULL") "NOT NULL")
 969    (cons (symbol-name-default-case "PRIMARY-KEY") "PRIMARY KEY")
 970    (cons (symbol-name-default-case "NOT") "NOT")
 971    (cons (symbol-name-default-case "NULL") "NULL")
 972    (cons (symbol-name-default-case "PRIMARY") "PRIMARY")
 973    (cons (symbol-name-default-case "KEY") "KEY")
 974    (cons (symbol-name-default-case "UNSIGNED") "UNSIGNED")
 975    (cons (symbol-name-default-case "ZEROFILL") "ZEROFILL")
 976    (cons (symbol-name-default-case "AUTO-INCREMENT") "AUTO_INCREMENT")
 977    (cons (symbol-name-default-case "UNIQUE") "UNIQUE")))
 978
 979 (defmethod database-constraint-statement (constraint-list database)
 980   (declare (ignore database))
 981   (make-constraints-description constraint-list))
 982
 983 (defun make-constraints-description (constraint-list)
 984   (if constraint-list
 985       (let ((string ""))
 986         (do ((constraint constraint-list (cdr constraint)))
 987             ((null constraint) string)
 988           (let ((output (assoc (symbol-name (car constraint))
 989                                *constraint-types*
 990                                :test #'equal)))
 991             (if (null output)
 992                 (error 'sql-user-error
 993                        :message (format nil "unsupported column constraint '~A'"
 994                                         constraint))
 995                 (setq string (concatenate 'string string (cdr output))))
 996             (if (< 1 (length constraint))
 997                 (setq string (concatenate 'string string " "))))))))
 998