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 (defvar *default-schema* "UNCOMMONSQL")
27 (defvar *object-schemas* (make-hash-table :test #'equal)
28 "Hash of schema name to class constituent lists.")
30 (defun in-schema (schemaname)
31 (setf *default-schema* schemaname))
33 (defun sql-output (sql-expr &optional database)
34 (progv '(*sql-stream*)
35 `(,(make-string-output-stream))
36 (output-sql sql-expr database)
37 (get-output-stream-string *sql-stream*)))
40 (defclass %sql-expression ()
43 (defmethod output-sql ((expr %sql-expression) &optional
44 (database *default-database*))
45 (declare (ignore database))
46 (write-string +null-string+ *sql-stream*))
48 (defmethod print-object ((self %sql-expression) stream)
49 (print-unreadable-object
51 (write-string (sql-output self) stream)))
53 ;; For straight up strings
55 (defclass sql (%sql-expression)
59 (:documentation "A literal SQL expression."))
61 (defmethod make-load-form ((sql sql) &optional environment)
62 (declare (ignore environment))
65 `(make-instance 'sql :string ',text)))
67 (defmethod output-sql ((expr sql) &optional (database *default-database*))
68 (declare (ignore database))
69 (write-string (slot-value expr 'text) *sql-stream*)
72 (defmethod print-object ((ident sql) stream)
73 (format stream "#<~S \"~A\">"
77 ;; For SQL Identifiers of generic type
78 (defclass sql-ident (%sql-expression)
82 (:documentation "An SQL identifer."))
84 (defmethod make-load-form ((sql sql-ident) &optional environment)
85 (declare (ignore environment))
88 `(make-instance 'sql-ident :name ',name)))
90 (defvar *output-hash* (make-hash-table :test #'equal))
92 (defmethod output-sql-hash-key (expr &optional (database *default-database*))
93 (declare (ignore expr database))
96 (defmethod output-sql :around ((sql t) &optional (database *default-database*))
97 (declare (ignore database))
98 (let* ((hash-key (output-sql-hash-key sql))
99 (hash-value (when hash-key (gethash hash-key *output-hash*))))
100 (cond ((and hash-key hash-value)
101 (write-string hash-value *sql-stream*))
103 (let ((*sql-stream* (make-string-output-stream)))
105 (setf hash-value (get-output-stream-string *sql-stream*))
106 (setf (gethash hash-key *output-hash*) hash-value))
107 (write-string hash-value *sql-stream*))
109 (call-next-method)))))
111 (defmethod output-sql ((expr sql-ident) &optional
112 (database *default-database*))
113 (declare (ignore database))
118 (write-string name *sql-stream*))
120 (write-string (symbol-name name) *sql-stream*)))
123 ;; For SQL Identifiers for attributes
125 (defclass sql-ident-attribute (sql-ident)
135 (:documentation "An SQL Attribute identifier."))
137 (defmethod collect-table-refs (sql)
138 (declare (ignore sql))
141 (defmethod collect-table-refs ((sql sql-ident-attribute))
142 (let ((qual (slot-value sql 'qualifier)))
143 (if (and qual (symbolp (slot-value sql 'qualifier)))
144 (list (make-instance 'sql-ident-table :name
145 (slot-value sql 'qualifier))))))
147 (defmethod make-load-form ((sql sql-ident-attribute) &optional environment)
148 (declare (ignore environment))
149 (with-slots (qualifier type name)
151 `(make-instance 'sql-ident-attribute :name ',name
152 :qualifier ',qualifier
155 (defmethod output-sql ((expr sql-ident-attribute) &optional
156 (database *default-database*))
157 (declare (ignore database))
158 (with-slots (qualifier name type params)
160 (if (and name (not qualifier) (not type))
161 (write-string (sql-escape (symbol-name name)) *sql-stream*)
162 (format *sql-stream* "~@[~A.~]~A~@[ ~A~]"
163 (if qualifier (sql-escape qualifier) qualifier)
168 (defmethod output-sql-hash-key ((expr sql-ident-attribute) &optional
169 (database *default-database*))
170 (declare (ignore database))
171 (with-slots (qualifier name type params)
173 (list 'sql-ident-attribute qualifier name type params)))
175 ;; For SQL Identifiers for tables
176 (defclass sql-ident-table (sql-ident)
178 :initarg :table-alias :initform nil))
179 (:documentation "An SQL table identifier."))
181 (defmethod make-load-form ((sql sql-ident-table) &optional environment)
182 (declare (ignore environment))
183 (with-slots (alias name)
185 `(make-instance 'sql-ident-table :name name :alias ',alias)))
187 (defun generate-sql (expr)
188 (let ((*sql-stream* (make-string-output-stream)))
190 (get-output-stream-string *sql-stream*)))
192 (defmethod output-sql ((expr sql-ident-table) &optional
193 (database *default-database*))
194 (declare (ignore database))
195 (with-slots (name alias)
198 (write-string (sql-escape (symbol-name name)) *sql-stream*)
200 (write-string (sql-escape (symbol-name name)) *sql-stream*)
201 (write-char #\Space *sql-stream*)
202 (format *sql-stream* "~s" alias))))
205 (defmethod output-sql-hash-key ((expr sql-ident-table) &optional
206 (database *default-database*))
207 (declare (ignore database))
208 (with-slots (name alias)
210 (list 'sql-ident-table name alias)))
212 (defclass sql-relational-exp (%sql-expression)
217 :initarg :sub-expressions
219 (:documentation "An SQL relational expression."))
221 (defmethod collect-table-refs ((sql sql-relational-exp))
223 (dolist (exp (slot-value sql 'sub-expressions))
224 (let ((refs (collect-table-refs exp)))
225 (if refs (setf tabs (append refs tabs)))))
226 (remove-duplicates tabs
227 :test (lambda (tab1 tab2)
228 (equal (slot-value tab1 'name)
229 (slot-value tab2 'name))))))
234 ;; Write SQL for relational operators (like 'AND' and 'OR').
235 ;; should do arity checking of subexpressions
237 (defmethod output-sql ((expr sql-relational-exp) &optional
238 (database *default-database*))
239 (with-slots (operator sub-expressions)
241 (let ((subs (if (consp (car sub-expressions))
242 (car sub-expressions)
244 (write-char #\( *sql-stream*)
245 (do ((sub subs (cdr sub)))
246 ((null (cdr sub)) (output-sql (car sub) database))
247 (output-sql (car sub) database)
248 (write-char #\Space *sql-stream*)
249 (output-sql operator database)
250 (write-char #\Space *sql-stream*))
251 (write-char #\) *sql-stream*)))
254 (defclass sql-upcase-like (sql-relational-exp)
256 (:documentation "An SQL 'like' that upcases its arguments."))
258 ;; Write SQL for relational operators (like 'AND' and 'OR').
259 ;; should do arity checking of subexpressions
261 (defmethod output-sql ((expr sql-upcase-like) &optional
262 (database *default-database*))
263 (flet ((write-term (term)
264 (write-string "upper(" *sql-stream*)
265 (output-sql term database)
266 (write-char #\) *sql-stream*)))
267 (with-slots (sub-expressions)
269 (let ((subs (if (consp (car sub-expressions))
270 (car sub-expressions)
272 (write-char #\( *sql-stream*)
273 (do ((sub subs (cdr sub)))
274 ((null (cdr sub)) (write-term (car sub)))
275 (write-term (car sub))
276 (write-string " LIKE " *sql-stream*))
277 (write-char #\) *sql-stream*))))
280 (defclass sql-assignment-exp (sql-relational-exp)
282 (:documentation "An SQL Assignment expression."))
285 (defmethod output-sql ((expr sql-assignment-exp) &optional
286 (database *default-database*))
287 (with-slots (operator sub-expressions)
289 (do ((sub sub-expressions (cdr sub)))
290 ((null (cdr sub)) (output-sql (car sub) database))
291 (output-sql (car sub) database)
292 (write-char #\Space *sql-stream*)
293 (output-sql operator database)
294 (write-char #\Space *sql-stream*)))
297 (defclass sql-value-exp (%sql-expression)
305 "An SQL value expression.")
308 (defmethod collect-table-refs ((sql sql-value-exp))
310 (if (listp (slot-value sql 'components))
312 (dolist (exp (slot-value sql 'components))
313 (let ((refs (collect-table-refs exp)))
314 (if refs (setf tabs (append refs tabs)))))
315 (remove-duplicates tabs
316 :test (lambda (tab1 tab2)
317 (equal (slot-value tab1 'name)
318 (slot-value tab2 'name)))))
323 (defmethod output-sql ((expr sql-value-exp) &optional
324 (database *default-database*))
325 (with-slots (modifier components)
329 (write-char #\( *sql-stream*)
330 (output-sql modifier database)
331 (write-char #\Space *sql-stream*)
332 (output-sql components database)
333 (write-char #\) *sql-stream*))
334 (output-sql components database))))
336 (defclass sql-typecast-exp (sql-value-exp)
338 (:documentation "An SQL typecast expression."))
340 (defmethod output-sql ((expr sql-typecast-exp) &optional
341 (database *default-database*))
342 (database-output-sql expr database))
344 (defmethod database-output-sql ((expr sql-typecast-exp) database)
345 (with-slots (components)
347 (output-sql components database)))
350 (defmethod collect-table-refs ((sql sql-typecast-exp))
351 (when (slot-value sql 'components)
352 (collect-table-refs (slot-value sql 'components))))
354 (defclass sql-function-exp (%sql-expression)
362 "An SQL function expression."))
364 (defmethod collect-table-refs ((sql sql-function-exp))
366 (dolist (exp (slot-value sql 'components))
367 (let ((refs (collect-table-refs exp)))
368 (if refs (setf tabs (append refs tabs)))))
369 (remove-duplicates tabs
370 :test (lambda (tab1 tab2)
371 (equal (slot-value tab1 'name)
372 (slot-value tab2 'name))))))
374 (defmethod output-sql ((expr sql-function-exp) &optional
375 (database *default-database*))
376 (with-slots (name args)
378 (output-sql name database)
379 (when args (output-sql args database)))
382 (defclass sql-query (%sql-expression)
393 :initarg :set-operation
420 :initarg :order-by-descending
422 (:documentation "An SQL SELECT query."))
424 (defmethod collect-table-refs ((sql sql-query))
425 (remove-duplicates (collect-table-refs (slot-value sql 'where))
426 :test (lambda (tab1 tab2)
427 (equal (slot-value tab1 'name)
428 (slot-value tab2 'name)))))
430 (defvar *select-arguments*
431 '(:all :database :distinct :flatp :from :group-by :having :order-by
432 :order-by-descending :set-operation :where :offset :limit))
434 (defun query-arg-p (sym)
435 (member sym *select-arguments*))
437 (defun query-get-selections (select-args)
438 "Return two values: the list of select-args up to the first keyword,
439 uninclusive, and the args from that keyword to the end."
440 (let ((first-key-arg (position-if #'query-arg-p select-args)))
442 (values (subseq select-args 0 first-key-arg)
443 (subseq select-args first-key-arg))
446 (defmethod make-query (&rest args)
447 (multiple-value-bind (selections arglist)
448 (query-get-selections args)
449 (destructuring-bind (&key all flatp set-operation distinct from where
450 group-by having order-by order-by-descending
451 offset limit &allow-other-keys)
453 (if (null selections)
454 (error "No target columns supplied to select statement."))
456 (error "No source tables supplied to select statement."))
457 (make-instance 'sql-query :selections selections
458 :all all :flatp flatp :set-operation set-operation
459 :distinct distinct :from from :where where
460 :limit limit :offset offset
461 :group-by group-by :having having :order-by order-by
462 :order-by-descending order-by-descending))))
464 (defvar *in-subselect* nil)
466 (defmethod output-sql ((query sql-query) &optional
467 (database *default-database*))
468 (with-slots (distinct selections from where group-by having order-by
469 order-by-descending limit offset)
472 (write-string "(" *sql-stream*))
473 (write-string "SELECT " *sql-stream*)
475 (write-string "DISTINCT " *sql-stream*)
476 (unless (eql t distinct)
477 (write-string "ON " *sql-stream*)
478 (output-sql distinct database)
479 (write-char #\Space *sql-stream*)))
480 (output-sql (apply #'vector selections) database)
481 (write-string " FROM " *sql-stream*)
483 (output-sql (apply #'vector from) database)
484 (output-sql from database))
486 (write-string " WHERE " *sql-stream*)
487 (let ((*in-subselect* t))
488 (output-sql where database)))
490 (write-string " GROUP BY " *sql-stream*)
491 (output-sql group-by database))
493 (write-string " HAVING " *sql-stream*)
494 (output-sql having database))
496 (write-string " ORDER BY " *sql-stream*)
498 (do ((order order-by (cdr order)))
500 (output-sql (car order) database)
502 (write-char #\, *sql-stream*)))
503 (output-sql order-by database)))
504 (when order-by-descending
505 (write-string " ORDER BY " *sql-stream*)
506 (if (listp order-by-descending)
507 (do ((order order-by-descending (cdr order)))
509 (output-sql (car order) database)
511 (write-char #\, *sql-stream*)))
512 (output-sql order-by-descending database))
513 (write-string " DESC " *sql-stream*))
515 (write-string " LIMIT " *sql-stream*)
516 (output-sql limit database))
518 (write-string " OFFSET " *sql-stream*)
519 (output-sql offset database))
521 (write-string ")" *sql-stream*)))
526 (defclass sql-insert (%sql-expression)
540 "An SQL INSERT statement."))
542 (defmethod output-sql ((ins sql-insert) &optional
543 (database *default-database*))
544 (with-slots (into attributes values query)
546 (write-string "INSERT INTO " *sql-stream*)
547 (output-sql into database)
549 (write-char #\Space *sql-stream*)
550 (output-sql attributes database))
552 (write-string " VALUES " *sql-stream*)
553 (output-sql values database))
555 (write-char #\Space *sql-stream*)
556 (output-sql query database)))
561 (defclass sql-delete (%sql-expression)
569 "An SQL DELETE statement."))
571 (defmethod output-sql ((stmt sql-delete) &optional
572 (database *default-database*))
573 (with-slots (from where)
575 (write-string "DELETE FROM " *sql-stream*)
577 (symbol (write-string (sql-escape from) *sql-stream*))
578 (t (output-sql from database)))
580 (write-string " WHERE " *sql-stream*)
581 (output-sql where database)))
586 (defclass sql-update (%sql-expression)
599 (:documentation "An SQL UPDATE statement."))
601 (defmethod output-sql ((expr sql-update) &optional
602 (database *default-database*))
603 (with-slots (table where attributes values)
605 (flet ((update-assignments ()
606 (mapcar #'(lambda (a b)
607 (make-instance 'sql-assignment-exp
609 :sub-expressions (list a b)))
611 (write-string "UPDATE " *sql-stream*)
612 (output-sql table database)
613 (write-string " SET " *sql-stream*)
614 (output-sql (apply #'vector (update-assignments)) database)
616 (write-string " WHERE " *sql-stream*)
617 (output-sql where database))))
622 (defclass sql-create-table (%sql-expression)
633 "An SQL CREATE TABLE statement."))
635 ;; Here's a real warhorse of a function!
642 (defmethod output-sql ((stmt sql-create-table) &optional
643 (database *default-database*))
644 (flet ((output-column (column-spec)
645 (destructuring-bind (name type &rest constraints)
647 (let ((type (listify type)))
648 (output-sql name database)
649 (write-char #\Space *sql-stream*)
651 (database-get-type-specifier (car type) (cdr type) database)
654 (database-constraint-statement constraints database)))
656 (write-string " " *sql-stream*)
657 (write-string constraints *sql-stream*)))))))
658 (with-slots (name columns modifiers)
660 (write-string "CREATE TABLE " *sql-stream*)
661 (output-sql name database)
662 (write-string " (" *sql-stream*)
663 (do ((column columns (cdr column)))
665 (output-column (car column)))
666 (output-column (car column))
667 (write-string ", " *sql-stream*))
669 (do ((modifier (listify modifiers) (cdr modifier)))
671 (write-string ", " *sql-stream*)
672 (write-string (car modifier) *sql-stream*)))
673 (write-char #\) *sql-stream*)))
679 (defclass sql-create-view (%sql-expression)
680 ((name :initarg :name :initform nil)
681 (column-list :initarg :column-list :initform nil)
682 (query :initarg :query :initform nil)
683 (with-check-option :initarg :with-check-option :initform nil))
684 (:documentation "An SQL CREATE VIEW statement."))
686 (defmethod output-sql ((stmt sql-create-view) &optional database)
687 (with-slots (name column-list query with-check-option) stmt
688 (write-string "CREATE VIEW " *sql-stream*)
689 (output-sql name database)
690 (when column-list (write-string " " *sql-stream*)
691 (output-sql (listify column-list) database))
692 (write-string " AS " *sql-stream*)
693 (output-sql query database)
694 (when with-check-option (write-string " WITH CHECK OPTION" *sql-stream*))))
698 ;; Column constraint types
700 (defparameter *constraint-types*
701 '(("NOT-NULL" . "NOT NULL")
702 ("PRIMARY-KEY" . "PRIMARY KEY")))
705 ;; Convert type spec to sql syntax
708 (defmethod database-constraint-description (constraint database)
709 (declare (ignore database))
710 (let ((output (assoc (symbol-name constraint) *constraint-types*
713 (error 'clsql-sql-syntax-error
714 :reason (format nil "unsupported column constraint '~a'"
718 (defmethod database-constraint-statement (constraint-list database)
719 (declare (ignore database))
720 (make-constraints-description constraint-list))
722 (defun make-constraints-description (constraint-list)
725 (do ((constraint constraint-list (cdr constraint)))
726 ((null constraint) string)
727 (let ((output (assoc (symbol-name (car constraint))
731 (error 'clsql-sql-syntax-error
732 :reason (format nil "unsupported column constraint '~a'"
734 (setq string (concatenate 'string string (cdr output))))
735 (if (< 1 (length constraint))
736 (setq string (concatenate 'string string " "))))))))