1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
4 ;;;; Classes defining SQL expressions and methods for formatting the
5 ;;;; appropriate SQL commands.
7 ;;;; This file is part of CLSQL.
9 ;;;; CLSQL users are granted the rights to distribute and use this software
10 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
11 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
12 ;;;; *************************************************************************
14 (in-package #:clsql-sys)
16 (defvar +empty-string+ "''")
18 (defvar +null-string+ "NULL")
20 (defvar *sql-stream* nil
21 "stream which accumulates SQL output")
23 (defclass %database-identifier ()
24 ((escaped :accessor escaped :initarg :escaped :initform nil)
25 (unescaped :accessor unescaped :initarg :unescaped :initform nil))
27 "A database identifier represents a string/symbol ready to be spliced
28 into a sql string. It keeps references to both the escaped and
29 unescaped versions so that unescaped versions can be compared to the
30 results of list-tables/views/attributes etc. It also allows you to be
31 sure that an identifier is escaped only once.
33 (escaped-database-identifiers *any-reasonable-object*) should be called to
34 produce a string that is safe to splice directly into sql strings.
36 (unescaped-database-identifier *any-reasonable-object*) is generally what
37 you pass to it with the exception that symbols have been
38 clsql-sys:sql-escape which converts to a string and changes - to _ (so
39 that unescaped can be compared to the results of eg: list-tables)
42 (defmethod escaped ((it null)) it)
43 (defmethod unescaped ((it null)) it)
45 (defun database-identifier-equal (i1 i2 &optional (database clsql-sys:*default-database*))
46 (setf i1 (database-identifier i1 database)
47 i2 (database-identifier i2 database))
49 (if (symbolp (unescaped i))
50 (sql-escape (unescaped i))
52 (or ;; check for an exact match
53 (equal (escaped-database-identifier i1)
54 (escaped-database-identifier i2))
55 ;; check for an inexact match if we had symbols in the mix
56 (string-equal (cast i1) (cast i2)))))
58 (defun delistify-dsd (list)
59 "Some MOPs, like openmcl 0.14.2, cons attribute values in a list."
60 (if (and (listp list) (null (cdr list)))
64 (defun special-char-p (s)
65 "Check if a string has any special characters"
66 (loop for char across s
67 thereis (find char '(#\space #\, #\. #\! #\@ #\# #\$ #\% #\' #\"
68 #\^ #\& #\* #\| #\( #\) #\- #\+ #\< #\>
71 (defun %make-database-identifier (inp &optional database)
72 "We want to quote an identifier if it came to us as a string or if it has special characters
74 (labels ((%escape-identifier (inp &optional orig)
75 "Quote an identifier unless it is already quoted"
78 ((and (eql #\" (elt inp 0))
79 (eql #\" (elt inp (- (length inp) 1))))
80 (make-instance '%database-identifier :unescaped (or orig inp) :escaped inp))
82 '%database-identifier :unescaped (or orig inp) :escaped
84 'string "\"" (replace-all inp "\"" "\\\"") "\""))))))
86 (string (%escape-identifier inp))
87 (%database-identifier inp)
89 (let ((s (sql-escape inp)))
90 (if (and (not (eql '* inp)) (special-char-p s))
91 (%escape-identifier (convert-to-db-default-case s database) inp)
92 (make-instance '%database-identifier :escaped s :unescaped inp)))))))
94 (defun combine-database-identifiers (ids &optional (database clsql-sys:*default-database*)
95 &aux res all-sym? pkg)
96 "Create a new database identifier by combining parts in a reasonable way
98 (setf ids (mapcar #'database-identifier ids)
99 all-sym? (every (lambda (i) (symbolp (unescaped i))) ids)
100 pkg (when all-sym? (symbol-package (unescaped (first ids)))))
104 (%database-identifier (cast (unescaped i)))
108 (convert-to-db-default-case (sql-escape i) database)))
114 (concatenate 'string (cast i1) "_" (cast i2))
116 (setf res (reduce #'comb ids))
118 (if all-sym? (intern res pkg) res)
121 (defun escaped-database-identifier (name &optional database find-class-p)
122 (escaped (database-identifier name database find-class-p)))
124 (defun unescaped-database-identifier (name &optional database find-class-p)
125 (unescaped (database-identifier name database find-class-p)))
127 (defun sql-output (sql-expr &optional (database *default-database*))
128 "Top-level call for generating SQL strings. Returns an SQL
129 string appropriate for DATABASE which corresponds to the
130 supplied lisp expression SQL-EXPR."
131 (with-output-to-string (*sql-stream*)
132 (output-sql sql-expr database)))
134 (defmethod output-sql (expr database)
135 (write-string (database-output-sql expr database) *sql-stream*)
139 (defvar *output-hash*
140 (make-weak-hash-table :test #'equal)
141 "For caching generated SQL strings, set to NIL to disable."
144 (defmethod output-sql :around ((sql t) database)
145 (if (null *output-hash*)
147 (let* ((hash-key (output-sql-hash-key sql database))
148 (hash-value (when hash-key (gethash hash-key *output-hash*))))
149 (cond ((and hash-key hash-value)
150 (write-string hash-value *sql-stream*))
152 (let ((*sql-stream* (make-string-output-stream)))
154 (setf hash-value (get-output-stream-string *sql-stream*))
155 (setf (gethash hash-key *output-hash*) hash-value))
156 (write-string hash-value *sql-stream*))
158 (call-next-method))))))
160 (defmethod output-sql-hash-key (expr database)
161 (declare (ignore expr database))
165 (defclass %sql-expression ()
168 (defmethod output-sql ((expr %sql-expression) database)
169 (declare (ignore database))
170 (write-string +null-string+ *sql-stream*))
172 (defmethod print-object ((self %sql-expression) stream)
173 (print-unreadable-object
174 (self stream :type t)
175 (write-string (sql-output self) stream))
178 ;; For straight up strings
180 (defclass sql (%sql-expression)
184 (:documentation "A literal SQL expression."))
186 (defmethod make-load-form ((sql sql) &optional environment)
187 (declare (ignore environment))
190 `(make-instance 'sql :string ',text)))
192 (defmethod output-sql ((expr sql) database)
193 (declare (ignore database))
194 (write-string (slot-value expr 'text) *sql-stream*)
197 (defmethod print-object ((ident sql) stream)
198 (format stream "#<~S \"~A\">"
200 (sql-output ident nil))
203 ;; For SQL Identifiers of generic type
205 (defclass sql-ident (%sql-expression)
208 :initform +null-string+))
209 (:documentation "An SQL identifer."))
211 (defmethod make-load-form ((sql sql-ident) &optional environment)
212 (declare (ignore environment))
215 `(make-instance 'sql-ident :name ',name)))
217 (defmethod output-sql ((expr %database-identifier) database)
218 (write-string (escaped expr) *sql-stream*))
220 (defmethod output-sql ((expr sql-ident) database)
221 (with-slots (name) expr
222 (write-string (escaped-database-identifier name database) *sql-stream*))
225 ;; For SQL Identifiers for attributes
227 (defclass sql-ident-attribute (sql-ident)
230 :initform +null-string+)
233 :initform +null-string+))
234 (:documentation "An SQL Attribute identifier."))
236 (defmethod collect-table-refs (sql)
237 (declare (ignore sql))
240 (defmethod collect-table-refs ((sql sql-ident-attribute))
241 (let ((qual (slot-value sql 'qualifier)))
243 ;; going to be used as a table, search classes
246 :name (database-identifier qual nil t))))))
248 (defmethod make-load-form ((sql sql-ident-attribute) &optional environment)
249 (declare (ignore environment))
250 (with-slots (qualifier type name)
252 `(make-instance 'sql-ident-attribute :name ',name
253 :qualifier ',qualifier
256 (defmethod output-sql-hash-key ((expr sql-ident-attribute) database)
257 (with-slots (qualifier name type)
259 (list (and database (database-underlying-type database))
261 (unescaped-database-identifier qualifier)
262 (unescaped-database-identifier name) type)))
264 ;; For SQL Identifiers for tables
266 (defclass sql-ident-table (sql-ident)
268 :initarg :table-alias :initform nil))
269 (:documentation "An SQL table identifier."))
271 (defmethod make-load-form ((sql sql-ident-table) &optional environment)
272 (declare (ignore environment))
273 (with-slots (alias name)
275 `(make-instance 'sql-ident-table :name ',name :table-alias ',alias)))
277 (defmethod output-sql ((expr sql-ident-table) database)
278 (with-slots (name alias) expr
279 (flet ((p (s) ;; the etypecase is in sql-escape too
281 (escaped-database-identifier s database)
285 (princ #\space *sql-stream*)
289 (defmethod output-sql ((expr sql-ident-attribute) database)
290 ;;; KMR: The TYPE field is used by CommonSQL for type conversion -- it
291 ;;; should not be output in SQL statements
292 (let ((*print-pretty* nil))
293 (with-slots (qualifier name type) expr
294 (format *sql-stream* "~@[~a.~]~a"
297 (escaped-database-identifier qualifier database T))
298 (escaped-database-identifier name database))
301 (defmethod output-sql-hash-key ((expr sql-ident-table) database)
302 (with-slots (name alias)
304 (list (and database (database-underlying-type database))
306 (unescaped-database-identifier name)
307 (unescaped-database-identifier alias))))
309 (defclass sql-relational-exp (%sql-expression)
314 :initarg :sub-expressions
316 (:documentation "An SQL relational expression."))
318 (defmethod make-load-form ((self sql-relational-exp) &optional environment)
319 (make-load-form-saving-slots self
320 :slot-names '(operator sub-expressions)
321 :environment environment))
323 (defmethod collect-table-refs ((sql sql-relational-exp))
325 (dolist (exp (slot-value sql 'sub-expressions))
326 (let ((refs (collect-table-refs exp)))
327 (if refs (setf tabs (append refs tabs)))))
328 (remove-duplicates tabs :test #'database-identifier-equal)))
333 ;; Write SQL for relational operators (like 'AND' and 'OR').
334 ;; should do arity checking of subexpressions
336 (defun %write-operator (operator database)
338 (string (write-string operator *sql-stream*))
339 (symbol (write-string (symbol-name operator) *sql-stream*))
340 (T (output-sql operator database))))
342 (defmethod output-sql ((expr sql-relational-exp) database)
343 (with-slots (operator sub-expressions) expr
344 ;; we do this as two runs so as not to emit confusing superflous parentheses
345 ;; The first loop renders all the child outputs so that we can skip anding with
346 ;; empty output (which causes sql errors)
347 ;; the next loop simply emits each sub-expression with the appropriate number of
348 ;; parens and operators
350 (string-trim +whitespace-chars+
351 (with-output-to-string (*sql-stream*)
352 (output-sql sub database)))))
353 (let ((str-subs (loop for sub in sub-expressions
354 for str-sub = (trim sub)
355 when (and str-sub (> (length str-sub) 0))
357 (case (length str-subs)
359 (1 (write-string (first str-subs) *sql-stream*))
361 (write-char #\( *sql-stream*)
362 (write-string (first str-subs) *sql-stream*)
363 (loop for str-sub in (rest str-subs)
365 (write-char #\Space *sql-stream*)
366 ;; do this so that symbols can be output as database identifiers
367 ;; rather than allowing symbols to inject sql
368 (%write-operator operator database)
369 (write-char #\Space *sql-stream*)
370 (write-string str-sub *sql-stream*))
371 (write-char #\) *sql-stream*))
375 (defclass sql-upcase-like (sql-relational-exp)
377 (:documentation "An SQL 'like' that upcases its arguments."))
379 (defmethod output-sql ((expr sql-upcase-like) database)
380 (flet ((write-term (term)
381 (write-string "upper(" *sql-stream*)
382 (output-sql term database)
383 (write-char #\) *sql-stream*)))
384 (with-slots (sub-expressions)
386 (let ((subs (if (consp (car sub-expressions))
387 (car sub-expressions)
389 (write-char #\( *sql-stream*)
390 (do ((sub subs (cdr sub)))
391 ((null (cdr sub)) (write-term (car sub)))
392 (write-term (car sub))
393 (write-string " LIKE " *sql-stream*))
394 (write-char #\) *sql-stream*))))
397 (defclass sql-assignment-exp (sql-relational-exp)
399 (:documentation "An SQL Assignment expression."))
402 (defmethod output-sql ((expr sql-assignment-exp) database)
403 (with-slots (operator sub-expressions)
405 (do ((sub sub-expressions (cdr sub)))
406 ((null (cdr sub)) (output-sql (car sub) database))
407 (output-sql (car sub) database)
408 (write-char #\Space *sql-stream*)
409 (%write-operator operator database)
410 (write-char #\Space *sql-stream*)))
413 (defclass sql-value-exp (%sql-expression)
421 "An SQL value expression.")
424 (defmethod collect-table-refs ((sql sql-value-exp))
426 (if (listp (slot-value sql 'components))
428 (dolist (exp (slot-value sql 'components))
429 (let ((refs (collect-table-refs exp)))
430 (if refs (setf tabs (append refs tabs)))))
431 (remove-duplicates tabs :test #'database-identifier-equal))
436 (defmethod output-sql ((expr sql-value-exp) database)
437 (with-slots (modifier components)
441 (write-char #\( *sql-stream*)
443 ((sql-operator modifier)
444 (%write-operator modifier database))
445 ((or (stringp modifier) (symbolp modifier))
447 (escaped-database-identifier modifier)
449 (t (output-sql modifier database)))
450 (write-char #\Space *sql-stream*)
451 (output-sql components database)
452 (write-char #\) *sql-stream*))
453 (output-sql components database))))
455 (defclass sql-typecast-exp (sql-value-exp)
457 (:documentation "An SQL typecast expression."))
459 (defmethod output-sql ((expr sql-typecast-exp) database)
460 (with-slots (components)
462 (output-sql components database)))
464 (defmethod collect-table-refs ((sql sql-typecast-exp))
465 (when (slot-value sql 'components)
466 (collect-table-refs (slot-value sql 'components))))
468 (defclass sql-function-exp (%sql-expression)
476 "An SQL function expression."))
478 (defmethod collect-table-refs ((sql sql-function-exp))
480 (dolist (exp (slot-value sql 'args))
481 (let ((refs (collect-table-refs exp)))
482 (if refs (setf tabs (append refs tabs)))))
483 (remove-duplicates tabs :test #'database-identifier-equal)))
484 (defvar *in-subselect* nil)
486 (defmethod output-sql ((expr sql-function-exp) database)
487 (with-slots (name args)
491 (write-string (escaped-database-identifier name) *sql-stream*))
492 (t (output-sql name database)))
493 (let ((*in-subselect* nil)) ;; aboid double parens
494 (when args (output-sql args database))))
498 (defclass sql-between-exp (sql-function-exp)
500 (:documentation "An SQL between expression."))
502 (defmethod output-sql ((expr sql-between-exp) database)
505 (output-sql (first args) database)
506 (write-string " BETWEEN " *sql-stream*)
507 (output-sql (second args) database)
508 (write-string " AND " *sql-stream*)
509 (output-sql (third args) database))
512 (defclass sql-query-modifier-exp (%sql-expression)
513 ((modifier :initarg :modifier :initform nil)
514 (components :initarg :components :initform nil))
515 (:documentation "An SQL query modifier expression."))
517 (defmethod output-sql ((expr sql-query-modifier-exp) database)
518 (with-slots (modifier components)
520 (%write-operator modifier database)
521 (write-string " " *sql-stream*)
522 (%write-operator (car components) database)
524 (mapc #'(lambda (comp)
525 (write-string ", " *sql-stream*)
526 (output-sql comp database))
530 (defclass sql-set-exp (%sql-expression)
535 :initarg :sub-expressions
537 (:documentation "An SQL set expression."))
539 (defmethod collect-table-refs ((sql sql-set-exp))
541 (dolist (exp (slot-value sql 'sub-expressions))
542 (let ((refs (collect-table-refs exp)))
543 (if refs (setf tabs (append refs tabs)))))
544 (remove-duplicates tabs :test #'database-identifier-equal)))
546 (defmethod output-sql ((expr sql-set-exp) database)
547 (with-slots (operator sub-expressions)
549 (let ((subs (if (consp (car sub-expressions))
550 (car sub-expressions)
552 (when (= (length subs) 1)
553 (%write-operator operator database)
554 (write-char #\Space *sql-stream*))
555 (do ((sub subs (cdr sub)))
556 ((null (cdr sub)) (output-sql (car sub) database))
557 (output-sql (car sub) database)
558 (write-char #\Space *sql-stream*)
559 (%write-operator operator database)
560 (write-char #\Space *sql-stream*))))
563 (defclass sql-query (%sql-expression)
574 :initarg :set-operation
606 (:documentation "An SQL SELECT query."))
608 (defclass sql-object-query (%sql-expression)
622 (defmethod collect-table-refs ((sql sql-query))
624 (collect-table-refs (slot-value sql 'where))
625 :test #'database-identifier-equal))
627 (defvar *select-arguments*
628 '(:all :database :distinct :flatp :from :group-by :having :order-by
629 :set-operation :where :offset :limit :inner-join :on
630 ;; below keywords are not a SQL argument, but these keywords may terminate select
633 (defun query-arg-p (sym)
634 (member sym *select-arguments*))
636 (defun query-get-selections (select-args)
637 "Return two values: the list of select-args up to the first keyword,
638 uninclusive, and the args from that keyword to the end."
639 (let ((first-key-arg (position-if #'query-arg-p select-args)))
641 (values (subseq select-args 0 first-key-arg)
642 (subseq select-args first-key-arg))
645 (defun make-query (&rest args)
646 (flet ((select-objects (target-args)
648 (every #'(lambda (arg)
650 (find-class arg nil)))
652 (multiple-value-bind (selections arglist)
653 (query-get-selections args)
654 (if (select-objects selections)
655 (destructuring-bind (&key flatp refresh &allow-other-keys) arglist
656 (make-instance 'sql-object-query :objects selections
657 :flatp flatp :refresh refresh
659 (destructuring-bind (&key all flatp set-operation distinct from where
660 group-by having order-by
661 offset limit inner-join on &allow-other-keys)
663 (if (null selections)
664 (error "No target columns supplied to select statement."))
666 (error "No source tables supplied to select statement."))
667 (make-instance 'sql-query :selections selections
668 :all all :flatp flatp :set-operation set-operation
669 :distinct distinct :from from :where where
670 :limit limit :offset offset
671 :group-by group-by :having having :order-by order-by
672 :inner-join inner-join :on on))))))
674 (defun output-sql-where-clause (where database)
675 "ensure that we do not output a \"where\" sql keyword when we will
676 not output a clause. Also sets *in-subselect* to use SQL
677 parentheticals as needed."
679 (let ((where-out (string-trim
680 '(#\newline #\space #\tab #\return)
681 (with-output-to-string (*sql-stream*)
682 (let ((*in-subselect* t))
683 (output-sql where database))))))
684 (when (> (length where-out) 0)
685 (write-string " WHERE " *sql-stream*)
686 (write-string where-out *sql-stream*)))))
688 (defmethod output-sql ((query sql-query) database)
689 (with-slots (distinct selections from where group-by having order-by
690 limit offset inner-join on all set-operation)
693 (write-string "(" *sql-stream*))
694 (write-string "SELECT " *sql-stream*)
696 (write-string " ALL " *sql-stream*))
697 (when (and distinct (not all))
698 (write-string " DISTINCT " *sql-stream*)
699 (unless (eql t distinct)
700 (write-string " ON " *sql-stream*)
701 (output-sql distinct database)
702 (write-char #\Space *sql-stream*)))
703 (when (and limit (eql :mssql (database-underlying-type database)))
704 (write-string " TOP " *sql-stream*)
705 (output-sql limit database)
706 (write-string " " *sql-stream*))
707 (let ((*in-subselect* t))
708 (output-sql (apply #'vector selections) database))
710 (write-string " FROM " *sql-stream*)
714 (remove-duplicates from :test #'database-identifier-equal))
716 (string (write-string
717 (escaped-database-identifier from database)
719 (t (let ((*in-subselect* t))
720 (output-sql from database)))))
722 (write-string " INNER JOIN " *sql-stream*)
723 (output-sql inner-join database))
725 (write-string " ON " *sql-stream*)
726 (output-sql on database))
727 (output-sql-where-clause where database)
729 (write-string " GROUP BY " *sql-stream*)
731 (do ((order group-by (cdr order)))
733 (let ((item (car order)))
736 (output-sql (car item) database)
737 (format *sql-stream* " ~A" (cadr item)))
739 (output-sql item database)))
741 (write-char #\, *sql-stream*))))
742 (output-sql group-by database)))
744 (write-string " HAVING " *sql-stream*)
745 (output-sql having database))
747 (write-string " ORDER BY " *sql-stream*)
749 (do ((order order-by (cdr order)))
751 (let ((item (car order)))
754 (output-sql (car item) database)
755 (format *sql-stream* " ~A" (cadr item)))
757 (output-sql item database)))
759 (write-char #\, *sql-stream*))))
760 (output-sql order-by database)))
761 (when (and limit (not (eql :mssql (database-underlying-type database))))
762 (write-string " LIMIT " *sql-stream*)
763 (output-sql limit database))
765 (write-string " OFFSET " *sql-stream*)
766 (output-sql offset database))
768 (write-string ")" *sql-stream*))
770 (write-char #\Space *sql-stream*)
771 (output-sql set-operation database)))
774 (defmethod output-sql ((query sql-object-query) database)
775 (declare (ignore database))
776 (with-slots (objects)
779 (format *sql-stream* "(~{~A~^ ~})" objects))))
784 (defclass sql-insert (%sql-expression)
798 "An SQL INSERT statement."))
800 (defmethod output-sql ((ins sql-insert) database)
801 (with-slots (into attributes values query)
803 (write-string "INSERT INTO " *sql-stream*)
806 (string (sql-expression :table into))
810 (write-char #\Space *sql-stream*)
811 (output-sql attributes database))
813 (write-string " VALUES " *sql-stream*)
814 (let ((clsql-sys::*in-subselect* t))
815 (output-sql values database)))
817 (write-char #\Space *sql-stream*)
818 (output-sql query database)))
823 (defclass sql-delete (%sql-expression)
831 "An SQL DELETE statement."))
833 (defmethod output-sql ((stmt sql-delete) database)
834 (with-slots (from where)
836 (write-string "DELETE FROM " *sql-stream*)
838 ((or symbol string) (write-string (sql-escape from) *sql-stream*))
839 (t (output-sql from database)))
840 (output-sql-where-clause where database))
845 (defclass sql-update (%sql-expression)
858 (:documentation "An SQL UPDATE statement."))
860 (defmethod output-sql ((expr sql-update) database)
861 (with-slots (table where attributes values)
863 (flet ((update-assignments ()
864 (mapcar #'(lambda (a b)
865 (make-instance 'sql-assignment-exp
867 :sub-expressions (list a b)))
869 (write-string "UPDATE " *sql-stream*)
870 (output-sql table database)
871 (write-string " SET " *sql-stream*)
872 (let ((clsql-sys::*in-subselect* t))
873 (output-sql (apply #'vector (update-assignments)) database))
874 (output-sql-where-clause where database)))
879 (defclass sql-create-table (%sql-expression)
890 :initarg :transactions
893 "An SQL CREATE TABLE statement."))
895 ;; Here's a real warhorse of a function!
897 (declaim (inline listify))
903 (defmethod output-sql ((stmt sql-create-table) database)
904 (flet ((output-column (column-spec)
905 (destructuring-bind (name type &optional db-type &rest constraints)
907 (let ((type (listify type)))
908 (output-sql name database)
909 (write-char #\Space *sql-stream*)
911 (if (stringp db-type) db-type ; override definition
912 (database-get-type-specifier (car type) (cdr type) database
913 (database-underlying-type database)))
915 (let ((constraints (database-constraint-statement
916 (if (and db-type (symbolp db-type))
917 (cons db-type constraints)
921 (write-string " " *sql-stream*)
922 (write-string constraints *sql-stream*)))))))
923 (with-slots (name columns modifiers transactions)
925 (write-string "CREATE TABLE " *sql-stream*)
926 (write-string (escaped-database-identifier name database) *sql-stream*)
927 (write-string " (" *sql-stream*)
928 (do ((column columns (cdr column)))
930 (output-column (car column)))
931 (output-column (car column))
932 (write-string ", " *sql-stream*))
934 (do ((modifier (listify modifiers) (cdr modifier)))
936 (write-string ", " *sql-stream*)
937 (write-string (car modifier) *sql-stream*)))
938 (write-char #\) *sql-stream*)
939 (when (and (eq :mysql (database-underlying-type database))
941 (db-type-transaction-capable? :mysql database))
942 (write-string " ENGINE=innodb" *sql-stream*))))
948 (defclass sql-create-view (%sql-expression)
949 ((name :initarg :name :initform nil)
950 (column-list :initarg :column-list :initform nil)
951 (query :initarg :query :initform nil)
952 (with-check-option :initarg :with-check-option :initform nil))
953 (:documentation "An SQL CREATE VIEW statement."))
955 (defmethod output-sql ((stmt sql-create-view) database)
956 (with-slots (name column-list query with-check-option) stmt
957 (write-string "CREATE VIEW " *sql-stream*)
958 (output-sql name database)
959 (when column-list (write-string " " *sql-stream*)
960 (output-sql (listify column-list) database))
961 (write-string " AS " *sql-stream*)
962 (output-sql query database)
963 (when with-check-option (write-string " WITH CHECK OPTION" *sql-stream*))))
967 ;; DATABASE-OUTPUT-SQL
970 (defmethod database-output-sql ((str string) database)
971 (declare (optimize (speed 3) (safety 1)
972 #+cmu (extensions:inhibit-warnings 3)))
973 (let ((len (length str)))
974 (declare (type fixnum len))
977 ((and (null (position #\' str))
978 (null (position #\\ str)))
979 (concatenate 'string "'" str "'"))
981 (let ((buf (make-string (+ (* len 2) 2) :initial-element #\')))
982 (declare (simple-string buf))
985 ((= i len) (subseq buf 0 (1+ j)))
986 (declare (type fixnum i j))
987 (let ((char (aref str i)))
988 (declare (character char))
989 (cond ((char= char #\')
990 (setf (aref buf j) #\')
992 (setf (aref buf j) #\'))
993 ((and (char= char #\\)
994 ;; MTP: only escape backslash with pgsql/mysql
995 (member (database-underlying-type database)
996 '(:postgresql :mysql)
998 (setf (aref buf j) #\\)
1000 (setf (aref buf j) #\\))
1002 (setf (aref buf j) char))))))))))
1004 (let ((keyword-package (symbol-package :foo)))
1005 (defmethod database-output-sql ((sym symbol) database)
1008 (if (equal (symbol-package sym) keyword-package)
1009 (database-output-sql (symbol-name sym) database)
1010 (escaped-database-identifier sym)))))
1012 (defmethod database-output-sql ((tee (eql t)) database)
1014 (let ((val (database-output-sql-as-type 'boolean t database (database-type database))))
1017 (string (format nil "'~A'" val))
1018 (integer (format nil "~A" val)))))
1021 #+nil(defmethod database-output-sql ((tee (eql t)) database)
1022 (declare (ignore database))
1025 (defmethod database-output-sql ((num number) database)
1026 (declare (ignore database))
1027 (number-to-sql-string num))
1029 (defmethod database-output-sql ((arg list) database)
1032 (format nil "(~{~A~^,~})" (mapcar #'(lambda (val)
1033 (sql-output val database))
1036 (defmethod database-output-sql ((arg vector) database)
1037 (format nil "~{~A~^,~}" (map 'list #'(lambda (val)
1038 (sql-output val database))
1041 (defmethod output-sql-hash-key ((arg vector) database)
1042 (list 'vector (map 'list (lambda (arg)
1043 (or (output-sql-hash-key arg database)
1044 (return-from output-sql-hash-key nil)))
1047 (defmethod database-output-sql ((self wall-time) database)
1048 (declare (ignore database))
1049 (db-timestring self))
1051 (defmethod database-output-sql ((self date) database)
1052 (declare (ignore database))
1053 (db-datestring self))
1055 (defmethod database-output-sql ((self duration) database)
1056 (declare (ignore database))
1057 (format nil "'~a'" (duration-timestring self)))
1060 (defmethod database-output-sql ((self money) database)
1061 (database-output-sql (slot-value self 'odcl::units) database))
1063 (defmethod database-output-sql (thing database)
1064 (if (or (null thing)
1067 (error 'sql-user-error
1070 "No type conversion to SQL for ~A is defined for DB ~A."
1071 (type-of thing) (type-of database)))))
1075 ;; Column constraint types and conversion to SQL
1078 (defparameter *constraint-types*
1080 (cons (symbol-name-default-case "NOT-NULL") "NOT NULL")
1081 (cons (symbol-name-default-case "PRIMARY-KEY") "PRIMARY KEY")
1082 (cons (symbol-name-default-case "NOT") "NOT")
1083 (cons (symbol-name-default-case "NULL") "NULL")
1084 (cons (symbol-name-default-case "PRIMARY") "PRIMARY")
1085 (cons (symbol-name-default-case "KEY") "KEY")
1086 (cons (symbol-name-default-case "UNSIGNED") "UNSIGNED")
1087 (cons (symbol-name-default-case "ZEROFILL") "ZEROFILL")
1088 (cons (symbol-name-default-case "AUTO-INCREMENT") "AUTO_INCREMENT")
1089 (cons (symbol-name-default-case "DEFAULT") "DEFAULT")
1090 (cons (symbol-name-default-case "UNIQUE") "UNIQUE")
1091 (cons (symbol-name-default-case "IDENTITY") "IDENTITY (1,1)") ;; added for sql-server support
1094 (defmethod database-constraint-statement (constraint-list database)
1095 (declare (ignore database))
1096 (make-constraints-description constraint-list))
1098 (defun make-constraints-description (constraint-list)
1101 (do ((constraint constraint-list (cdr constraint)))
1102 ((null constraint) string)
1103 (let ((output (assoc (symbol-name (car constraint))
1107 (error 'sql-user-error
1108 :message (format nil "unsupported column constraint '~A'"
1110 (setq string (concatenate 'string string (cdr output))))
1111 (when (equal (symbol-name (car constraint)) "DEFAULT")
1112 (setq constraint (cdr constraint))
1113 (setq string (concatenate 'string string " " (car constraint))))
1114 (if (< 1 (length constraint))
1115 (setq string (concatenate 'string string " "))))))))
1117 (defmethod database-identifier ( name &optional database find-class-p
1119 "A function that takes whatever you give it, recurively coerces it,
1120 and returns a database-identifier.
1122 (escaped-database-identifiers *any-reasonable-object*) should be called to
1123 produce a string that is safe to splice directly into sql strings.
1125 This function should NOT throw errors when database is nil
1127 find-class-p should be T if we want to search for classes
1128 and check their use their view table. Should be used
1129 on symbols we are sure indicate tables
1132 ;; metaclasses has further typecases of this, so that it will
1133 ;; load less painfully (try-recompiles) in SBCL
1136 (flet ((flatten-id (id)
1137 "if we have multiple pieces that we need to represent as
1138 db-id lets do that by rendering out the id, then creating
1139 a new db-id with that string as escaped"
1140 (let ((s (sql-output id database)))
1141 (make-instance '%database-identifier :escaped s :unescaped s))))
1144 (string (%make-database-identifier name database))
1146 ;; if this is being used as a table, we should check
1147 ;; for a class with this name and use the identifier specified
1149 (if (and find-class-p (setf cls (find-standard-db-class name)))
1150 (database-identifier cls)
1151 (%make-database-identifier name database)))
1152 (%database-identifier name)
1153 ;; we know how to deref this without further escaping
1155 (with-slots ((inner-name name) alias) name
1158 (database-identifier inner-name))))
1159 ;; if this is a single name we can derefence it
1160 (sql-ident-attribute
1161 (with-slots (qualifier (inner-name name)) name
1164 (database-identifier inner-name))))
1166 (with-slots ((inner-name name)) name
1167 (database-identifier inner-name)))
1168 ;; dont know how to handle this really :/
1169 (%sql-expression (flatten-id name))