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) &optional
36 (database *default-database*))
37 (declare (ignore database))
38 (write-string +null-string+ *sql-stream*))
40 (defmethod print-object ((self %sql-expression) stream)
41 (print-unreadable-object
43 (write-string (sql-output self) stream)))
45 ;; For straight up strings
47 (defclass sql (%sql-expression)
51 (:documentation "A literal SQL expression."))
53 (defmethod make-load-form ((sql sql) &optional environment)
54 (declare (ignore environment))
57 `(make-instance 'sql :string ',text)))
59 (defmethod output-sql ((expr sql) &optional (database *default-database*))
60 (declare (ignore database))
61 (write-string (slot-value expr 'text) *sql-stream*)
64 (defmethod print-object ((ident sql) stream)
65 (format stream "#<~S \"~A\">"
69 ;; For SQL Identifiers of generic type
70 (defclass sql-ident (%sql-expression)
74 (:documentation "An SQL identifer."))
76 (defmethod make-load-form ((sql sql-ident) &optional environment)
77 (declare (ignore environment))
80 `(make-instance 'sql-ident :name ',name)))
82 (defvar *output-hash* (make-hash-table :test #'equal))
84 (defmethod output-sql-hash-key (expr &optional (database *default-database*))
85 (declare (ignore expr database))
88 (defmethod output-sql :around ((sql t) &optional (database *default-database*))
89 (declare (ignore database))
90 (let* ((hash-key (output-sql-hash-key sql))
91 (hash-value (when hash-key (gethash hash-key *output-hash*))))
92 (cond ((and hash-key hash-value)
93 (write-string hash-value *sql-stream*))
95 (let ((*sql-stream* (make-string-output-stream)))
97 (setf hash-value (get-output-stream-string *sql-stream*))
98 (setf (gethash hash-key *output-hash*) hash-value))
99 (write-string hash-value *sql-stream*))
101 (call-next-method)))))
103 (defmethod output-sql ((expr sql-ident) &optional
104 (database *default-database*))
105 (declare (ignore database))
110 (write-string name *sql-stream*))
112 (write-string (symbol-name name) *sql-stream*)))
115 ;; For SQL Identifiers for attributes
117 (defclass sql-ident-attribute (sql-ident)
127 (:documentation "An SQL Attribute identifier."))
129 (defmethod collect-table-refs (sql)
130 (declare (ignore sql))
133 (defmethod collect-table-refs ((sql sql-ident-attribute))
134 (let ((qual (slot-value sql 'qualifier)))
135 (if (and qual (symbolp (slot-value sql 'qualifier)))
136 (list (make-instance 'sql-ident-table :name
137 (slot-value sql 'qualifier))))))
139 (defmethod make-load-form ((sql sql-ident-attribute) &optional environment)
140 (declare (ignore environment))
141 (with-slots (qualifier type name)
143 `(make-instance 'sql-ident-attribute :name ',name
144 :qualifier ',qualifier
147 (defmethod output-sql ((expr sql-ident-attribute) &optional
148 (database *default-database*))
149 (declare (ignore database))
150 (with-slots (qualifier name type params)
152 (if (and name (not qualifier) (not type))
153 (write-string (sql-escape (symbol-name name)) *sql-stream*)
154 (format *sql-stream* "~@[~A.~]~A~@[ ~A~]"
155 (if qualifier (sql-escape qualifier) qualifier)
160 (defmethod output-sql-hash-key ((expr sql-ident-attribute) &optional
161 (database *default-database*))
162 (declare (ignore database))
163 (with-slots (qualifier name type params)
165 (list 'sql-ident-attribute qualifier name type params)))
167 ;; For SQL Identifiers for tables
168 (defclass sql-ident-table (sql-ident)
170 :initarg :table-alias :initform nil))
171 (:documentation "An SQL table identifier."))
173 (defmethod make-load-form ((sql sql-ident-table) &optional environment)
174 (declare (ignore environment))
175 (with-slots (alias name)
177 `(make-instance 'sql-ident-table :name name :alias ',alias)))
179 (defun generate-sql (expr)
180 (let ((*sql-stream* (make-string-output-stream)))
182 (get-output-stream-string *sql-stream*)))
184 (defmethod output-sql ((expr sql-ident-table) &optional
185 (database *default-database*))
186 (declare (ignore database))
187 (with-slots (name alias)
190 (write-string (sql-escape (symbol-name name)) *sql-stream*)
192 (write-string (sql-escape (symbol-name name)) *sql-stream*)
193 (write-char #\Space *sql-stream*)
194 (format *sql-stream* "~s" alias))))
198 (defmethod database-output-sql ((self duration) database)
199 (declare (ignore database))
200 (format nil "'~a'" (duration-timestring self)))
202 (defmethod database-output-sql ((self money) database)
203 (database-output-sql (slot-value self 'odcl::units) database))
207 (defmethod output-sql-hash-key ((expr sql-ident-table) &optional
208 (database *default-database*))
209 (declare (ignore database))
210 (with-slots (name alias)
212 (list 'sql-ident-table name alias)))
214 (defclass sql-relational-exp (%sql-expression)
219 :initarg :sub-expressions
221 (:documentation "An SQL relational expression."))
223 (defmethod collect-table-refs ((sql sql-relational-exp))
225 (dolist (exp (slot-value sql 'sub-expressions))
226 (let ((refs (collect-table-refs exp)))
227 (if refs (setf tabs (append refs tabs)))))
228 (remove-duplicates tabs
229 :test (lambda (tab1 tab2)
230 (equal (slot-value tab1 'name)
231 (slot-value tab2 'name))))))
236 ;; Write SQL for relational operators (like 'AND' and 'OR').
237 ;; should do arity checking of subexpressions
239 (defmethod output-sql ((expr sql-relational-exp) &optional
240 (database *default-database*))
241 (with-slots (operator sub-expressions)
243 (let ((subs (if (consp (car sub-expressions))
244 (car sub-expressions)
246 (write-char #\( *sql-stream*)
247 (do ((sub subs (cdr sub)))
248 ((null (cdr sub)) (output-sql (car sub) database))
249 (output-sql (car sub) database)
250 (write-char #\Space *sql-stream*)
251 (output-sql operator database)
252 (write-char #\Space *sql-stream*))
253 (write-char #\) *sql-stream*)))
256 (defclass sql-upcase-like (sql-relational-exp)
258 (:documentation "An SQL 'like' that upcases its arguments."))
260 ;; Write SQL for relational operators (like 'AND' and 'OR').
261 ;; should do arity checking of subexpressions
263 (defmethod output-sql ((expr sql-upcase-like) &optional
264 (database *default-database*))
265 (flet ((write-term (term)
266 (write-string "upper(" *sql-stream*)
267 (output-sql term database)
268 (write-char #\) *sql-stream*)))
269 (with-slots (sub-expressions)
271 (let ((subs (if (consp (car sub-expressions))
272 (car sub-expressions)
274 (write-char #\( *sql-stream*)
275 (do ((sub subs (cdr sub)))
276 ((null (cdr sub)) (write-term (car sub)))
277 (write-term (car sub))
278 (write-string " LIKE " *sql-stream*))
279 (write-char #\) *sql-stream*))))
282 (defclass sql-assignment-exp (sql-relational-exp)
284 (:documentation "An SQL Assignment expression."))
287 (defmethod output-sql ((expr sql-assignment-exp) &optional
288 (database *default-database*))
289 (with-slots (operator sub-expressions)
291 (do ((sub sub-expressions (cdr sub)))
292 ((null (cdr sub)) (output-sql (car sub) database))
293 (output-sql (car sub) database)
294 (write-char #\Space *sql-stream*)
295 (output-sql operator database)
296 (write-char #\Space *sql-stream*)))
299 (defclass sql-value-exp (%sql-expression)
307 "An SQL value expression.")
310 (defmethod collect-table-refs ((sql sql-value-exp))
312 (if (listp (slot-value sql 'components))
314 (dolist (exp (slot-value sql 'components))
315 (let ((refs (collect-table-refs exp)))
316 (if refs (setf tabs (append refs tabs)))))
317 (remove-duplicates tabs
318 :test (lambda (tab1 tab2)
319 (equal (slot-value tab1 'name)
320 (slot-value tab2 'name)))))
325 (defmethod output-sql ((expr sql-value-exp) &optional
326 (database *default-database*))
327 (with-slots (modifier components)
331 (write-char #\( *sql-stream*)
332 (output-sql modifier database)
333 (write-char #\Space *sql-stream*)
334 (output-sql components database)
335 (write-char #\) *sql-stream*))
336 (output-sql components database))))
338 (defclass sql-typecast-exp (sql-value-exp)
340 (:documentation "An SQL typecast expression."))
342 (defmethod output-sql ((expr sql-typecast-exp) &optional
343 (database *default-database*))
344 (database-output-sql expr database))
346 (defmethod database-output-sql ((expr sql-typecast-exp) database)
347 (with-slots (components)
349 (output-sql components database)))
352 (defmethod collect-table-refs ((sql sql-typecast-exp))
353 (when (slot-value sql 'components)
354 (collect-table-refs (slot-value sql 'components))))
356 (defclass sql-function-exp (%sql-expression)
364 "An SQL function expression."))
366 (defmethod collect-table-refs ((sql sql-function-exp))
368 (dolist (exp (slot-value sql 'components))
369 (let ((refs (collect-table-refs exp)))
370 (if refs (setf tabs (append refs tabs)))))
371 (remove-duplicates tabs
372 :test (lambda (tab1 tab2)
373 (equal (slot-value tab1 'name)
374 (slot-value tab2 'name))))))
376 (defmethod output-sql ((expr sql-function-exp) &optional
377 (database *default-database*))
378 (with-slots (name args)
380 (output-sql name database)
381 (when args (output-sql args database)))
384 (defclass sql-query (%sql-expression)
395 :initarg :set-operation
422 :initarg :order-by-descending
424 (:documentation "An SQL SELECT query."))
426 (defmethod collect-table-refs ((sql sql-query))
427 (remove-duplicates (collect-table-refs (slot-value sql 'where))
428 :test (lambda (tab1 tab2)
429 (equal (slot-value tab1 'name)
430 (slot-value tab2 'name)))))
432 (defvar *select-arguments*
433 '(:all :database :distinct :flatp :from :group-by :having :order-by
434 :order-by-descending :set-operation :where :offset :limit))
436 (defun query-arg-p (sym)
437 (member sym *select-arguments*))
439 (defun query-get-selections (select-args)
440 "Return two values: the list of select-args up to the first keyword,
441 uninclusive, and the args from that keyword to the end."
442 (let ((first-key-arg (position-if #'query-arg-p select-args)))
444 (values (subseq select-args 0 first-key-arg)
445 (subseq select-args first-key-arg))
448 (defmethod make-query (&rest args)
449 (multiple-value-bind (selections arglist)
450 (query-get-selections args)
451 (destructuring-bind (&key all flatp set-operation distinct from where
452 group-by having order-by order-by-descending
453 offset limit &allow-other-keys)
455 (if (null selections)
456 (error "No target columns supplied to select statement."))
458 (error "No source tables supplied to select statement."))
459 (make-instance 'sql-query :selections selections
460 :all all :flatp flatp :set-operation set-operation
461 :distinct distinct :from from :where where
462 :limit limit :offset offset
463 :group-by group-by :having having :order-by order-by
464 :order-by-descending order-by-descending))))
466 (defvar *in-subselect* nil)
468 (defmethod output-sql ((query sql-query) &optional
469 (database *default-database*))
470 (with-slots (distinct selections from where group-by having order-by
471 order-by-descending limit offset)
474 (write-string "(" *sql-stream*))
475 (write-string "SELECT " *sql-stream*)
477 (write-string "DISTINCT " *sql-stream*)
478 (unless (eql t distinct)
479 (write-string "ON " *sql-stream*)
480 (output-sql distinct database)
481 (write-char #\Space *sql-stream*)))
482 (output-sql (apply #'vector selections) database)
483 (write-string " FROM " *sql-stream*)
485 (output-sql (apply #'vector from) database)
486 (output-sql from database))
488 (write-string " WHERE " *sql-stream*)
489 (let ((*in-subselect* t))
490 (output-sql where database)))
492 (write-string " GROUP BY " *sql-stream*)
493 (output-sql group-by database))
495 (write-string " HAVING " *sql-stream*)
496 (output-sql having database))
498 (write-string " ORDER BY " *sql-stream*)
500 (do ((order order-by (cdr order)))
502 (output-sql (car order) database)
504 (write-char #\, *sql-stream*)))
505 (output-sql order-by database)))
506 (when order-by-descending
507 (write-string " ORDER BY " *sql-stream*)
508 (if (listp order-by-descending)
509 (do ((order order-by-descending (cdr order)))
511 (output-sql (car order) database)
513 (write-char #\, *sql-stream*)))
514 (output-sql order-by-descending database))
515 (write-string " DESC " *sql-stream*))
517 (write-string " LIMIT " *sql-stream*)
518 (output-sql limit database))
520 (write-string " OFFSET " *sql-stream*)
521 (output-sql offset database))
523 (write-string ")" *sql-stream*)))
528 (defclass sql-insert (%sql-expression)
542 "An SQL INSERT statement."))
544 (defmethod output-sql ((ins sql-insert) &optional
545 (database *default-database*))
546 (with-slots (into attributes values query)
548 (write-string "INSERT INTO " *sql-stream*)
549 (output-sql into database)
551 (write-char #\Space *sql-stream*)
552 (output-sql attributes database))
554 (write-string " VALUES " *sql-stream*)
555 (output-sql values database))
557 (write-char #\Space *sql-stream*)
558 (output-sql query database)))
563 (defclass sql-delete (%sql-expression)
571 "An SQL DELETE statement."))
573 (defmethod output-sql ((stmt sql-delete) &optional
574 (database *default-database*))
575 (with-slots (from where)
577 (write-string "DELETE FROM " *sql-stream*)
579 (symbol (write-string (sql-escape from) *sql-stream*))
580 (t (output-sql from database)))
582 (write-string " WHERE " *sql-stream*)
583 (output-sql where database)))
588 (defclass sql-update (%sql-expression)
601 (:documentation "An SQL UPDATE statement."))
603 (defmethod output-sql ((expr sql-update) &optional
604 (database *default-database*))
605 (with-slots (table where attributes values)
607 (flet ((update-assignments ()
608 (mapcar #'(lambda (a b)
609 (make-instance 'sql-assignment-exp
611 :sub-expressions (list a b)))
613 (write-string "UPDATE " *sql-stream*)
614 (output-sql table database)
615 (write-string " SET " *sql-stream*)
616 (output-sql (apply #'vector (update-assignments)) database)
618 (write-string " WHERE " *sql-stream*)
619 (output-sql where database))))
624 (defclass sql-create-table (%sql-expression)
635 "An SQL CREATE TABLE statement."))
637 ;; Here's a real warhorse of a function!
644 (defmethod output-sql ((stmt sql-create-table) &optional
645 (database *default-database*))
646 (flet ((output-column (column-spec)
647 (destructuring-bind (name type &optional db-type &rest constraints)
649 (let ((type (listify type)))
650 (output-sql name database)
651 (write-char #\Space *sql-stream*)
653 (if (stringp db-type) db-type ; override definition
654 (database-get-type-specifier (car type) (cdr type) database))
657 (database-constraint-statement constraints database)))
659 (write-string " " *sql-stream*)
660 (write-string constraints *sql-stream*)))))))
661 (with-slots (name columns modifiers)
663 (write-string "CREATE TABLE " *sql-stream*)
664 (output-sql name database)
665 (write-string " (" *sql-stream*)
666 (do ((column columns (cdr column)))
668 (output-column (car column)))
669 (output-column (car column))
670 (write-string ", " *sql-stream*))
672 (do ((modifier (listify modifiers) (cdr modifier)))
674 (write-string ", " *sql-stream*)
675 (write-string (car modifier) *sql-stream*)))
676 (write-char #\) *sql-stream*)))
682 (defclass sql-create-view (%sql-expression)
683 ((name :initarg :name :initform nil)
684 (column-list :initarg :column-list :initform nil)
685 (query :initarg :query :initform nil)
686 (with-check-option :initarg :with-check-option :initform nil))
687 (:documentation "An SQL CREATE VIEW statement."))
689 (defmethod output-sql ((stmt sql-create-view) &optional database)
690 (with-slots (name column-list query with-check-option) stmt
691 (write-string "CREATE VIEW " *sql-stream*)
692 (output-sql name database)
693 (when column-list (write-string " " *sql-stream*)
694 (output-sql (listify column-list) database))
695 (write-string " AS " *sql-stream*)
696 (output-sql query database)
697 (when with-check-option (write-string " WITH CHECK OPTION" *sql-stream*))))
701 ;; Column constraint types
703 (defparameter *constraint-types*
704 '(("NOT-NULL" . "NOT NULL")
705 ("PRIMARY-KEY" . "PRIMARY KEY")))
708 ;; Convert type spec to sql syntax
711 (defmethod database-constraint-description (constraint database)
712 (declare (ignore database))
713 (let ((output (assoc (symbol-name constraint) *constraint-types*
716 (error 'clsql-sql-syntax-error
717 :reason (format nil "unsupported column constraint '~a'"
721 (defmethod database-constraint-statement (constraint-list database)
722 (declare (ignore database))
723 (make-constraints-description constraint-list))
725 (defun make-constraints-description (constraint-list)
728 (do ((constraint constraint-list (cdr constraint)))
729 ((null constraint) string)
730 (let ((output (assoc (symbol-name (car constraint))
734 (error 'clsql-sql-syntax-error
735 :reason (format nil "unsupported column constraint '~a'"
737 (setq string (concatenate 'string string (cdr output))))
738 (if (< 1 (length constraint))
739 (setq string (concatenate 'string string " "))))))))