1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
6 ;;;; Classes defining SQL expressions and methods for formatting the
7 ;;;; appropriate SQL commands.
9 ;;;; This file is part of CLSQL.
11 ;;;; CLSQL users are granted the rights to distribute and use this software
12 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
13 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
14 ;;;; *************************************************************************
16 (in-package #:clsql-sys)
18 (defvar +empty-string+ "''")
20 (defvar +null-string+ "NULL")
22 (defvar *sql-stream* nil
23 "stream which accumulates SQL output")
25 (defun sql-output (sql-expr &optional database)
26 (progv '(*sql-stream*)
27 `(,(make-string-output-stream))
28 (output-sql sql-expr database)
29 (get-output-stream-string *sql-stream*)))
32 (defclass %sql-expression ()
35 (defmethod output-sql ((expr %sql-expression) database)
36 (declare (ignore database))
37 (write-string +null-string+ *sql-stream*))
39 (defmethod print-object ((self %sql-expression) stream)
40 (print-unreadable-object
42 (write-string (sql-output self) stream)))
44 ;; For straight up strings
46 (defclass sql (%sql-expression)
50 (:documentation "A literal SQL expression."))
52 (defmethod make-load-form ((sql sql) &optional environment)
53 (declare (ignore environment))
56 `(make-instance 'sql :string ',text)))
58 (defmethod output-sql ((expr sql) database)
59 (declare (ignore database))
60 (write-string (slot-value expr 'text) *sql-stream*)
63 (defmethod print-object ((ident sql) stream)
64 (format stream "#<~S \"~A\">"
66 (sql-output ident nil)))
68 ;; For SQL Identifiers of generic type
69 (defclass sql-ident (%sql-expression)
73 (:documentation "An SQL identifer."))
75 (defmethod make-load-form ((sql sql-ident) &optional environment)
76 (declare (ignore environment))
79 `(make-instance 'sql-ident :name ',name)))
81 (defvar *output-hash* (make-hash-table :test #'equal))
83 (defmethod output-sql-hash-key (expr database)
84 (declare (ignore expr database))
88 (defmethod output-sql :around ((sql t) database)
89 (let* ((hash-key (output-sql-hash-key sql database))
90 (hash-value (when hash-key (gethash hash-key *output-hash*))))
91 (cond ((and hash-key hash-value)
92 (write-string hash-value *sql-stream*))
94 (let ((*sql-stream* (make-string-output-stream)))
96 (setf hash-value (get-output-stream-string *sql-stream*))
97 (setf (gethash hash-key *output-hash*) hash-value))
98 (write-string hash-value *sql-stream*))
100 (call-next-method)))))
102 (defmethod output-sql ((expr sql-ident) database)
106 (convert-to-db-default-case
109 (symbol (symbol-name name)))
114 ;; For SQL Identifiers for attributes
116 (defclass sql-ident-attribute (sql-ident)
126 (:documentation "An SQL Attribute identifier."))
128 (defmethod collect-table-refs (sql)
129 (declare (ignore sql))
132 (defmethod collect-table-refs ((sql sql-ident-attribute))
133 (let ((qual (slot-value sql 'qualifier)))
134 (if (and qual (symbolp (slot-value sql 'qualifier)))
135 (list (make-instance 'sql-ident-table :name
136 (slot-value sql 'qualifier))))))
138 (defmethod make-load-form ((sql sql-ident-attribute) &optional environment)
139 (declare (ignore environment))
140 (with-slots (qualifier type name)
142 `(make-instance 'sql-ident-attribute :name ',name
143 :qualifier ',qualifier
146 (defmethod output-sql ((expr sql-ident-attribute) database)
147 (with-slots (qualifier name type params)
149 (if (and (not qualifier) (not type))
150 (write-string (sql-escape (convert-to-db-default-case
151 (symbol-name name) database)) *sql-stream*)
152 ;;; KMR: The TYPE field is used by CommonSQL for type conversion -- it
153 ;;; should not be output in SQL statements
155 (format *sql-stream* "~@[~A.~]~A~@[ ~A~]"
157 (convert-to-db-default-case (sql-escape qualifier) database))
158 (sql-escape (convert-to-db-default-case name database))
160 (convert-to-db-default-case (symbol-name type) database)))
161 (format *sql-stream* "~@[~A.~]~A"
164 (string (format nil "~s" qualifier))
165 (t (convert-to-db-default-case (sql-escape qualifier)
167 (sql-escape (convert-to-db-default-case name database))))
170 (defmethod output-sql-hash-key ((expr sql-ident-attribute) database)
171 (declare (ignore database))
172 (with-slots (qualifier name type params)
174 (list 'sql-ident-attribute qualifier name type params)))
176 ;; For SQL Identifiers for tables
177 (defclass sql-ident-table (sql-ident)
179 :initarg :table-alias :initform nil))
180 (:documentation "An SQL table identifier."))
182 (defmethod make-load-form ((sql sql-ident-table) &optional environment)
183 (declare (ignore environment))
184 (with-slots (alias name)
186 `(make-instance 'sql-ident-table :name ',name :table-alias ',alias)))
188 (defun generate-sql (expr database)
189 (let ((*sql-stream* (make-string-output-stream)))
190 (output-sql expr database)
191 (get-output-stream-string *sql-stream*)))
193 (defmethod output-sql ((expr sql-ident-table) database)
194 (with-slots (name alias)
197 (write-string (sql-escape (convert-to-db-default-case (symbol-name name) database)) *sql-stream*)
199 (write-string (sql-escape (convert-to-db-default-case (symbol-name name) database)) *sql-stream*)
200 (write-char #\Space *sql-stream*)
201 (format *sql-stream* "~s" alias))))
205 (defmethod database-output-sql ((self duration) database)
206 (declare (ignore database))
207 (format nil "'~a'" (duration-timestring self)))
209 (defmethod database-output-sql ((self money) database)
210 (database-output-sql (slot-value self 'odcl::units) database))
214 (defmethod output-sql-hash-key ((expr sql-ident-table) database)
215 (declare (ignore database))
216 (with-slots (name alias)
218 (list 'sql-ident-table name alias)))
220 (defclass sql-relational-exp (%sql-expression)
225 :initarg :sub-expressions
227 (:documentation "An SQL relational expression."))
229 (defmethod collect-table-refs ((sql sql-relational-exp))
231 (dolist (exp (slot-value sql 'sub-expressions))
232 (let ((refs (collect-table-refs exp)))
233 (if refs (setf tabs (append refs tabs)))))
234 (remove-duplicates tabs
235 :test (lambda (tab1 tab2)
236 (equal (slot-value tab1 'name)
237 (slot-value tab2 'name))))))
242 ;; Write SQL for relational operators (like 'AND' and 'OR').
243 ;; should do arity checking of subexpressions
245 (defmethod output-sql ((expr sql-relational-exp) database)
246 (with-slots (operator sub-expressions)
248 (let ((subs (if (consp (car sub-expressions))
249 (car sub-expressions)
251 (write-char #\( *sql-stream*)
252 (do ((sub subs (cdr sub)))
253 ((null (cdr sub)) (output-sql (car sub) database))
254 (output-sql (car sub) database)
255 (write-char #\Space *sql-stream*)
256 (output-sql operator database)
257 (write-char #\Space *sql-stream*))
258 (write-char #\) *sql-stream*)))
261 (defclass sql-upcase-like (sql-relational-exp)
263 (:documentation "An SQL 'like' that upcases its arguments."))
265 ;; Write SQL for relational operators (like 'AND' and 'OR').
266 ;; should do arity checking of subexpressions
268 (defmethod output-sql ((expr sql-upcase-like) database)
269 (flet ((write-term (term)
270 (write-string "upper(" *sql-stream*)
271 (output-sql term database)
272 (write-char #\) *sql-stream*)))
273 (with-slots (sub-expressions)
275 (let ((subs (if (consp (car sub-expressions))
276 (car sub-expressions)
278 (write-char #\( *sql-stream*)
279 (do ((sub subs (cdr sub)))
280 ((null (cdr sub)) (write-term (car sub)))
281 (write-term (car sub))
282 (write-string " LIKE " *sql-stream*))
283 (write-char #\) *sql-stream*))))
286 (defclass sql-assignment-exp (sql-relational-exp)
288 (:documentation "An SQL Assignment expression."))
291 (defmethod output-sql ((expr sql-assignment-exp) database)
292 (with-slots (operator sub-expressions)
294 (do ((sub sub-expressions (cdr sub)))
295 ((null (cdr sub)) (output-sql (car sub) database))
296 (output-sql (car sub) database)
297 (write-char #\Space *sql-stream*)
298 (output-sql operator database)
299 (write-char #\Space *sql-stream*)))
302 (defclass sql-value-exp (%sql-expression)
310 "An SQL value expression.")
313 (defmethod collect-table-refs ((sql sql-value-exp))
315 (if (listp (slot-value sql 'components))
317 (dolist (exp (slot-value sql 'components))
318 (let ((refs (collect-table-refs exp)))
319 (if refs (setf tabs (append refs tabs)))))
320 (remove-duplicates tabs
321 :test (lambda (tab1 tab2)
322 (equal (slot-value tab1 'name)
323 (slot-value tab2 'name)))))
328 (defmethod output-sql ((expr sql-value-exp) database)
329 (with-slots (modifier components)
333 (write-char #\( *sql-stream*)
334 (output-sql modifier database)
335 (write-char #\Space *sql-stream*)
336 (output-sql components database)
337 (write-char #\) *sql-stream*))
338 (output-sql components database))))
340 (defclass sql-typecast-exp (sql-value-exp)
342 (:documentation "An SQL typecast expression."))
344 (defmethod output-sql ((expr sql-typecast-exp) database)
345 (database-output-sql expr database))
347 (defmethod database-output-sql ((expr sql-typecast-exp) database)
348 (with-slots (components)
350 (output-sql components database)))
353 (defmethod collect-table-refs ((sql sql-typecast-exp))
354 (when (slot-value sql 'components)
355 (collect-table-refs (slot-value sql 'components))))
357 (defclass sql-function-exp (%sql-expression)
365 "An SQL function expression."))
367 (defmethod collect-table-refs ((sql sql-function-exp))
369 (dolist (exp (slot-value sql 'components))
370 (let ((refs (collect-table-refs exp)))
371 (if refs (setf tabs (append refs tabs)))))
372 (remove-duplicates tabs
373 :test (lambda (tab1 tab2)
374 (equal (slot-value tab1 'name)
375 (slot-value tab2 'name))))))
377 (defmethod output-sql ((expr sql-function-exp) database)
378 (with-slots (name args)
380 (output-sql name database)
381 (when args (output-sql args database)))
385 (defclass sql-between-exp (sql-function-exp)
387 (:documentation "An SQL between expression."))
389 (defmethod output-sql ((expr sql-between-exp) database)
390 (with-slots (name args)
392 (output-sql (first args) database)
393 (write-string " BETWEEN " *sql-stream*)
394 (output-sql (second args) database)
395 (write-string " AND " *sql-stream*)
396 (output-sql (third args) database))
399 (defclass sql-query-modifier-exp (%sql-expression)
400 ((modifier :initarg :modifier :initform nil)
401 (components :initarg :components :initform nil))
402 (:documentation "An SQL query modifier expression."))
404 (defmethod output-sql ((expr sql-query-modifier-exp) database)
405 (with-slots (modifier components)
407 (output-sql modifier database)
408 (write-string " " *sql-stream*)
409 (output-sql (car components) database)
411 (mapc #'(lambda (comp)
412 (write-string ", " *sql-stream*)
413 (output-sql comp database))
417 (defclass sql-set-exp (%sql-expression)
422 :initarg :sub-expressions
424 (:documentation "An SQL set expression."))
426 (defmethod collect-table-refs ((sql sql-set-exp))
428 (dolist (exp (slot-value sql 'sub-expressions))
429 (let ((refs (collect-table-refs exp)))
430 (if refs (setf tabs (append refs tabs)))))
431 (remove-duplicates tabs
432 :test (lambda (tab1 tab2)
433 (equal (slot-value tab1 'name)
434 (slot-value tab2 'name))))))
436 (defmethod output-sql ((expr sql-set-exp) database)
437 (with-slots (operator sub-expressions)
439 (let ((subs (if (consp (car sub-expressions))
440 (car sub-expressions)
442 (when (= (length subs) 1)
443 (output-sql operator database)
444 (write-char #\Space *sql-stream*))
445 (do ((sub subs (cdr sub)))
446 ((null (cdr sub)) (output-sql (car sub) database))
447 (output-sql (car sub) database)
448 (write-char #\Space *sql-stream*)
449 (output-sql operator database)
450 (write-char #\Space *sql-stream*))))
453 (defclass sql-query (%sql-expression)
464 :initarg :set-operation
496 (:documentation "An SQL SELECT query."))
498 (defclass sql-object-query (%sql-expression)
512 (defmethod collect-table-refs ((sql sql-query))
513 (remove-duplicates (collect-table-refs (slot-value sql 'where))
514 :test (lambda (tab1 tab2)
515 (equal (slot-value tab1 'name)
516 (slot-value tab2 'name)))))
518 (defvar *select-arguments*
519 '(:all :database :distinct :flatp :from :group-by :having :order-by
520 :set-operation :where :offset :limit :inner-join :on
521 ;; below keywords are not a SQL argument, but these keywords may terminate select
524 (defun query-arg-p (sym)
525 (member sym *select-arguments*))
527 (defun query-get-selections (select-args)
528 "Return two values: the list of select-args up to the first keyword,
529 uninclusive, and the args from that keyword to the end."
530 (let ((first-key-arg (position-if #'query-arg-p select-args)))
532 (values (subseq select-args 0 first-key-arg)
533 (subseq select-args first-key-arg))
536 (defun make-query (&rest args)
537 (flet ((select-objects (target-args)
539 (every #'(lambda (arg)
541 (find-class arg nil)))
543 (multiple-value-bind (selections arglist)
544 (query-get-selections args)
545 (if (select-objects selections)
546 (destructuring-bind (&key flatp refresh &allow-other-keys) arglist
547 (make-instance 'sql-object-query :objects selections
548 :flatp flatp :refresh refresh
550 (destructuring-bind (&key all flatp set-operation distinct from where
551 group-by having order-by
552 offset limit inner-join on &allow-other-keys)
554 (if (null selections)
555 (error "No target columns supplied to select statement."))
557 (error "No source tables supplied to select statement."))
558 (make-instance 'sql-query :selections selections
559 :all all :flatp flatp :set-operation set-operation
560 :distinct distinct :from from :where where
561 :limit limit :offset offset
562 :group-by group-by :having having :order-by order-by
563 :inner-join inner-join :on on))))))
565 (defvar *in-subselect* nil)
567 (defmethod output-sql ((query sql-query) database)
568 (with-slots (distinct selections from where group-by having order-by
569 limit offset inner-join on all set-operation)
572 (write-string "(" *sql-stream*))
573 (write-string "SELECT " *sql-stream*)
575 (write-string "ALL " *sql-stream*))
576 (when (and distinct (not all))
577 (write-string "DISTINCT " *sql-stream*)
578 (unless (eql t distinct)
579 (write-string "ON " *sql-stream*)
580 (output-sql distinct database)
581 (write-char #\Space *sql-stream*)))
582 (output-sql (apply #'vector selections) database)
584 (write-string " FROM " *sql-stream*)
586 (list (output-sql (apply #'vector from) database))
587 (string (write-string
589 (convert-to-db-default-case from database)) *sql-stream*))
590 (t (output-sql from database))))
592 (write-string " INNER JOIN " *sql-stream*)
593 (output-sql inner-join database))
595 (write-string " ON " *sql-stream*)
596 (output-sql on database))
598 (write-string " WHERE " *sql-stream*)
599 (let ((*in-subselect* t))
600 (output-sql where database)))
602 (write-string " GROUP BY " *sql-stream*)
603 (output-sql group-by database))
605 (write-string " HAVING " *sql-stream*)
606 (output-sql having database))
608 (write-string " ORDER BY " *sql-stream*)
610 (do ((order order-by (cdr order)))
612 (let ((item (car order)))
615 (output-sql (car item) database)
616 (format *sql-stream* " ~A" (cadr item)))
618 (output-sql item database)))
620 (write-char #\, *sql-stream*))))
621 (output-sql order-by database)))
623 (write-string " LIMIT " *sql-stream*)
624 (output-sql limit database))
626 (write-string " OFFSET " *sql-stream*)
627 (output-sql offset database))
629 (write-string ")" *sql-stream*))
631 (write-char #\Space *sql-stream*)
632 (output-sql set-operation database)))
635 (defmethod output-sql ((query sql-object-query) database)
636 (declare (ignore database))
637 (with-slots (objects)
640 (format *sql-stream* "(~{~A~^ ~})" objects))))
645 (defclass sql-insert (%sql-expression)
659 "An SQL INSERT statement."))
661 (defmethod output-sql ((ins sql-insert) database)
662 (with-slots (into attributes values query)
664 (write-string "INSERT INTO " *sql-stream*)
665 (output-sql into database)
667 (write-char #\Space *sql-stream*)
668 (output-sql attributes database))
670 (write-string " VALUES " *sql-stream*)
671 (output-sql values database))
673 (write-char #\Space *sql-stream*)
674 (output-sql query database)))
679 (defclass sql-delete (%sql-expression)
687 "An SQL DELETE statement."))
689 (defmethod output-sql ((stmt sql-delete) database)
690 (with-slots (from where)
692 (write-string "DELETE FROM " *sql-stream*)
694 (symbol (write-string (sql-escape from) *sql-stream*))
695 (t (output-sql from database)))
697 (write-string " WHERE " *sql-stream*)
698 (output-sql where database)))
703 (defclass sql-update (%sql-expression)
716 (:documentation "An SQL UPDATE statement."))
718 (defmethod output-sql ((expr sql-update) database)
719 (with-slots (table where attributes values)
721 (flet ((update-assignments ()
722 (mapcar #'(lambda (a b)
723 (make-instance 'sql-assignment-exp
725 :sub-expressions (list a b)))
727 (write-string "UPDATE " *sql-stream*)
728 (output-sql table database)
729 (write-string " SET " *sql-stream*)
730 (output-sql (apply #'vector (update-assignments)) database)
732 (write-string " WHERE " *sql-stream*)
733 (output-sql where database))))
738 (defclass sql-create-table (%sql-expression)
749 :initarg :transactions
752 "An SQL CREATE TABLE statement."))
754 ;; Here's a real warhorse of a function!
756 (declaim (inline listify))
762 (defmethod output-sql ((stmt sql-create-table) database)
763 (flet ((output-column (column-spec)
764 (destructuring-bind (name type &optional db-type &rest constraints)
766 (let ((type (listify type)))
767 (output-sql name database)
768 (write-char #\Space *sql-stream*)
770 (if (stringp db-type) db-type ; override definition
771 (database-get-type-specifier (car type) (cdr type) database))
774 (database-constraint-statement constraints database)))
776 (write-string " " *sql-stream*)
777 (write-string constraints *sql-stream*)))))))
778 (with-slots (name columns modifiers transactions)
780 (write-string "CREATE TABLE " *sql-stream*)
781 (output-sql name database)
782 (write-string " (" *sql-stream*)
783 (do ((column columns (cdr column)))
785 (output-column (car column)))
786 (output-column (car column))
787 (write-string ", " *sql-stream*))
789 (do ((modifier (listify modifiers) (cdr modifier)))
791 (write-string ", " *sql-stream*)
792 (write-string (car modifier) *sql-stream*)))
793 (write-char #\) *sql-stream*)
794 (when (and (eq :mysql (database-underlying-type database))
796 (db-type-transaction-capable? :mysql database))
797 (write-string " Type=InnoDB" *sql-stream*))))
803 (defclass sql-create-view (%sql-expression)
804 ((name :initarg :name :initform nil)
805 (column-list :initarg :column-list :initform nil)
806 (query :initarg :query :initform nil)
807 (with-check-option :initarg :with-check-option :initform nil))
808 (:documentation "An SQL CREATE VIEW statement."))
810 (defmethod output-sql ((stmt sql-create-view) database)
811 (with-slots (name column-list query with-check-option) stmt
812 (write-string "CREATE VIEW " *sql-stream*)
813 (output-sql name database)
814 (when column-list (write-string " " *sql-stream*)
815 (output-sql (listify column-list) database))
816 (write-string " AS " *sql-stream*)
817 (output-sql query database)
818 (when with-check-option (write-string " WITH CHECK OPTION" *sql-stream*))))
822 ;; Column constraint types
824 (defparameter *constraint-types*
826 (cons (symbol-name-default-case "NOT-NULL") "NOT NULL")
827 (cons (symbol-name-default-case "PRIMARY-KEY") "PRIMARY KEY")))
830 ;; Convert type spec to sql syntax
833 (defmethod database-constraint-description (constraint database)
834 (declare (ignore database))
835 (let ((output (assoc (symbol-name constraint) *constraint-types*
838 (error 'sql-user-error
839 :message (format nil "unsupported column constraint '~A'"
843 (defmethod database-constraint-statement (constraint-list database)
844 (declare (ignore database))
845 (make-constraints-description constraint-list))
847 (defun make-constraints-description (constraint-list)
850 (do ((constraint constraint-list (cdr constraint)))
851 ((null constraint) string)
852 (let ((output (assoc (symbol-name (car constraint))
856 (error 'sql-user-error
857 :message (format nil "unsupported column constraint '~A'"
859 (setq string (concatenate 'string string (cdr output))))
860 (if (< 1 (length constraint))
861 (setq string (concatenate 'string string " "))))))))