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 (progv '(*sql-stream*)
132 `(,(make-string-output-stream))
133 (output-sql sql-expr database)
134 (get-output-stream-string *sql-stream*)))
136 (defmethod output-sql (expr database)
137 (write-string (database-output-sql expr database) *sql-stream*)
141 (defvar *output-hash*
142 (make-weak-hash-table :test #'equal)
143 "For caching generated SQL strings, set to NIL to disable."
146 (defmethod output-sql :around ((sql t) database)
147 (if (null *output-hash*)
149 (let* ((hash-key (output-sql-hash-key sql database))
150 (hash-value (when hash-key (gethash hash-key *output-hash*))))
151 (cond ((and hash-key hash-value)
152 (write-string hash-value *sql-stream*))
154 (let ((*sql-stream* (make-string-output-stream)))
156 (setf hash-value (get-output-stream-string *sql-stream*))
157 (setf (gethash hash-key *output-hash*) hash-value))
158 (write-string hash-value *sql-stream*))
160 (call-next-method))))))
162 (defmethod output-sql-hash-key (expr database)
163 (declare (ignore expr database))
167 (defclass %sql-expression ()
170 (defmethod output-sql ((expr %sql-expression) database)
171 (declare (ignore database))
172 (write-string +null-string+ *sql-stream*))
174 (defmethod print-object ((self %sql-expression) stream)
175 (print-unreadable-object
176 (self stream :type t)
177 (write-string (sql-output self) stream))
180 ;; For straight up strings
182 (defclass sql (%sql-expression)
186 (:documentation "A literal SQL expression."))
188 (defmethod make-load-form ((sql sql) &optional environment)
189 (declare (ignore environment))
192 `(make-instance 'sql :string ',text)))
194 (defmethod output-sql ((expr sql) database)
195 (declare (ignore database))
196 (write-string (slot-value expr 'text) *sql-stream*)
199 (defmethod print-object ((ident sql) stream)
200 (format stream "#<~S \"~A\">"
202 (sql-output ident nil))
205 ;; For SQL Identifiers of generic type
207 (defclass sql-ident (%sql-expression)
210 :initform +null-string+))
211 (:documentation "An SQL identifer."))
213 (defmethod make-load-form ((sql sql-ident) &optional environment)
214 (declare (ignore environment))
217 `(make-instance 'sql-ident :name ',name)))
219 (defmethod output-sql ((expr %database-identifier) database)
220 (write-string (escaped expr) *sql-stream*))
222 (defmethod output-sql ((expr sql-ident) database)
223 (with-slots (name) expr
224 (write-string (escaped-database-identifier name database) *sql-stream*))
227 ;; For SQL Identifiers for attributes
229 (defclass sql-ident-attribute (sql-ident)
232 :initform +null-string+)
235 :initform +null-string+))
236 (:documentation "An SQL Attribute identifier."))
238 (defmethod collect-table-refs (sql)
239 (declare (ignore sql))
242 (defmethod collect-table-refs ((sql sql-ident-attribute))
243 (let ((qual (slot-value sql 'qualifier)))
245 ;; going to be used as a table, search classes
248 :name (database-identifier qual nil t))))))
250 (defmethod make-load-form ((sql sql-ident-attribute) &optional environment)
251 (declare (ignore environment))
252 (with-slots (qualifier type name)
254 `(make-instance 'sql-ident-attribute :name ',name
255 :qualifier ',qualifier
258 (defmethod output-sql-hash-key ((expr sql-ident-attribute) database)
259 (with-slots (qualifier name type)
261 (list (and database (database-underlying-type database))
263 (unescaped-database-identifier qualifier)
264 (unescaped-database-identifier name) type)))
266 ;; For SQL Identifiers for tables
268 (defclass sql-ident-table (sql-ident)
270 :initarg :table-alias :initform nil))
271 (:documentation "An SQL table identifier."))
273 (defmethod make-load-form ((sql sql-ident-table) &optional environment)
274 (declare (ignore environment))
275 (with-slots (alias name)
277 `(make-instance 'sql-ident-table :name ',name :table-alias ',alias)))
279 (defmethod output-sql ((expr sql-ident-table) database)
280 (with-slots (name alias) expr
281 (flet ((p (s) ;; the etypecase is in sql-escape too
283 (escaped-database-identifier s database)
287 (princ #\space *sql-stream*)
291 (defmethod output-sql ((expr sql-ident-attribute) database)
292 ;;; KMR: The TYPE field is used by CommonSQL for type conversion -- it
293 ;;; should not be output in SQL statements
294 (let ((*print-pretty* nil))
295 (with-slots (qualifier name type) expr
296 (format *sql-stream* "~@[~a.~]~a"
299 (escaped-database-identifier qualifier database T))
300 (escaped-database-identifier name database))
303 (defmethod output-sql-hash-key ((expr sql-ident-table) database)
304 (with-slots (name alias)
306 (list (and database (database-underlying-type database))
308 (unescaped-database-identifier name)
309 (unescaped-database-identifier alias))))
311 (defclass sql-relational-exp (%sql-expression)
316 :initarg :sub-expressions
318 (:documentation "An SQL relational expression."))
320 (defmethod make-load-form ((self sql-relational-exp) &optional environment)
321 (make-load-form-saving-slots self
322 :slot-names '(operator sub-expressions)
323 :environment environment))
325 (defmethod collect-table-refs ((sql sql-relational-exp))
327 (dolist (exp (slot-value sql 'sub-expressions))
328 (let ((refs (collect-table-refs exp)))
329 (if refs (setf tabs (append refs tabs)))))
330 (remove-duplicates tabs :test #'database-identifier-equal)))
335 ;; Write SQL for relational operators (like 'AND' and 'OR').
336 ;; should do arity checking of subexpressions
338 (defun %write-operator (operator database)
340 (string (write-string operator *sql-stream*))
341 (symbol (write-string (symbol-name operator) *sql-stream*))
342 (T (output-sql operator database))))
344 (defmethod output-sql ((expr sql-relational-exp) database)
345 (with-slots (operator sub-expressions) expr
346 ;; we do this as two runs so as not to emit confusing superflous parentheses
347 ;; The first loop renders all the child outputs so that we can skip anding with
348 ;; empty output (which causes sql errors)
349 ;; the next loop simply emits each sub-expression with the appropriate number of
350 ;; parens and operators
352 (string-trim +whitespace-chars+
353 (with-output-to-string (*sql-stream*)
354 (output-sql sub database)))))
355 (let ((str-subs (loop for sub in sub-expressions
356 for str-sub = (trim sub)
357 when (and str-sub (> (length str-sub) 0))
359 (case (length str-subs)
361 (1 (write-string (first str-subs) *sql-stream*))
363 (write-char #\( *sql-stream*)
364 (write-string (first str-subs) *sql-stream*)
365 (loop for str-sub in (rest str-subs)
367 (write-char #\Space *sql-stream*)
368 ;; do this so that symbols can be output as database identifiers
369 ;; rather than allowing symbols to inject sql
370 (%write-operator operator database)
371 (write-char #\Space *sql-stream*)
372 (write-string str-sub *sql-stream*))
373 (write-char #\) *sql-stream*))
377 (defclass sql-upcase-like (sql-relational-exp)
379 (:documentation "An SQL 'like' that upcases its arguments."))
381 (defmethod output-sql ((expr sql-upcase-like) database)
382 (flet ((write-term (term)
383 (write-string "upper(" *sql-stream*)
384 (output-sql term database)
385 (write-char #\) *sql-stream*)))
386 (with-slots (sub-expressions)
388 (let ((subs (if (consp (car sub-expressions))
389 (car sub-expressions)
391 (write-char #\( *sql-stream*)
392 (do ((sub subs (cdr sub)))
393 ((null (cdr sub)) (write-term (car sub)))
394 (write-term (car sub))
395 (write-string " LIKE " *sql-stream*))
396 (write-char #\) *sql-stream*))))
399 (defclass sql-assignment-exp (sql-relational-exp)
401 (:documentation "An SQL Assignment expression."))
404 (defmethod output-sql ((expr sql-assignment-exp) database)
405 (with-slots (operator sub-expressions)
407 (do ((sub sub-expressions (cdr sub)))
408 ((null (cdr sub)) (output-sql (car sub) database))
409 (output-sql (car sub) database)
410 (write-char #\Space *sql-stream*)
411 (%write-operator operator database)
412 (write-char #\Space *sql-stream*)))
415 (defclass sql-value-exp (%sql-expression)
423 "An SQL value expression.")
426 (defmethod collect-table-refs ((sql sql-value-exp))
428 (if (listp (slot-value sql 'components))
430 (dolist (exp (slot-value sql 'components))
431 (let ((refs (collect-table-refs exp)))
432 (if refs (setf tabs (append refs tabs)))))
433 (remove-duplicates tabs :test #'database-identifier-equal))
438 (defmethod output-sql ((expr sql-value-exp) database)
439 (with-slots (modifier components)
443 (write-char #\( *sql-stream*)
445 ((sql-operator modifier)
446 (%write-operator modifier database))
447 ((or (stringp modifier) (symbolp modifier))
449 (escaped-database-identifier modifier)
451 (t (output-sql modifier database)))
452 (write-char #\Space *sql-stream*)
453 (output-sql components database)
454 (write-char #\) *sql-stream*))
455 (output-sql components database))))
457 (defclass sql-typecast-exp (sql-value-exp)
459 (:documentation "An SQL typecast expression."))
461 (defmethod output-sql ((expr sql-typecast-exp) database)
462 (with-slots (components)
464 (output-sql components database)))
466 (defmethod collect-table-refs ((sql sql-typecast-exp))
467 (when (slot-value sql 'components)
468 (collect-table-refs (slot-value sql 'components))))
470 (defclass sql-function-exp (%sql-expression)
478 "An SQL function expression."))
480 (defmethod collect-table-refs ((sql sql-function-exp))
482 (dolist (exp (slot-value sql 'args))
483 (let ((refs (collect-table-refs exp)))
484 (if refs (setf tabs (append refs tabs)))))
485 (remove-duplicates tabs :test #'database-identifier-equal)))
486 (defvar *in-subselect* nil)
488 (defmethod output-sql ((expr sql-function-exp) database)
489 (with-slots (name args)
493 (write-string (escaped-database-identifier name) *sql-stream*))
494 (t (output-sql name database)))
495 (let ((*in-subselect* nil)) ;; aboid double parens
496 (when args (output-sql args database))))
500 (defclass sql-between-exp (sql-function-exp)
502 (:documentation "An SQL between expression."))
504 (defmethod output-sql ((expr sql-between-exp) database)
507 (output-sql (first args) database)
508 (write-string " BETWEEN " *sql-stream*)
509 (output-sql (second args) database)
510 (write-string " AND " *sql-stream*)
511 (output-sql (third args) database))
514 (defclass sql-query-modifier-exp (%sql-expression)
515 ((modifier :initarg :modifier :initform nil)
516 (components :initarg :components :initform nil))
517 (:documentation "An SQL query modifier expression."))
519 (defmethod output-sql ((expr sql-query-modifier-exp) database)
520 (with-slots (modifier components)
522 (%write-operator modifier database)
523 (write-string " " *sql-stream*)
524 (%write-operator (car components) database)
526 (mapc #'(lambda (comp)
527 (write-string ", " *sql-stream*)
528 (output-sql comp database))
532 (defclass sql-set-exp (%sql-expression)
537 :initarg :sub-expressions
539 (:documentation "An SQL set expression."))
541 (defmethod collect-table-refs ((sql sql-set-exp))
543 (dolist (exp (slot-value sql 'sub-expressions))
544 (let ((refs (collect-table-refs exp)))
545 (if refs (setf tabs (append refs tabs)))))
546 (remove-duplicates tabs :test #'database-identifier-equal)))
548 (defmethod output-sql ((expr sql-set-exp) database)
549 (with-slots (operator sub-expressions)
551 (let ((subs (if (consp (car sub-expressions))
552 (car sub-expressions)
554 (when (= (length subs) 1)
555 (%write-operator operator database)
556 (write-char #\Space *sql-stream*))
557 (do ((sub subs (cdr sub)))
558 ((null (cdr sub)) (output-sql (car sub) database))
559 (output-sql (car sub) database)
560 (write-char #\Space *sql-stream*)
561 (%write-operator operator database)
562 (write-char #\Space *sql-stream*))))
565 (defclass sql-query (%sql-expression)
576 :initarg :set-operation
608 (:documentation "An SQL SELECT query."))
610 (defclass sql-object-query (%sql-expression)
624 (defmethod collect-table-refs ((sql sql-query))
626 (collect-table-refs (slot-value sql 'where))
627 :test #'database-identifier-equal))
629 (defvar *select-arguments*
630 '(:all :database :distinct :flatp :from :group-by :having :order-by
631 :set-operation :where :offset :limit :inner-join :on
632 ;; below keywords are not a SQL argument, but these keywords may terminate select
635 (defun query-arg-p (sym)
636 (member sym *select-arguments*))
638 (defun query-get-selections (select-args)
639 "Return two values: the list of select-args up to the first keyword,
640 uninclusive, and the args from that keyword to the end."
641 (let ((first-key-arg (position-if #'query-arg-p select-args)))
643 (values (subseq select-args 0 first-key-arg)
644 (subseq select-args first-key-arg))
647 (defun make-query (&rest args)
648 (flet ((select-objects (target-args)
650 (every #'(lambda (arg)
652 (find-class arg nil)))
654 (multiple-value-bind (selections arglist)
655 (query-get-selections args)
656 (if (select-objects selections)
657 (destructuring-bind (&key flatp refresh &allow-other-keys) arglist
658 (make-instance 'sql-object-query :objects selections
659 :flatp flatp :refresh refresh
661 (destructuring-bind (&key all flatp set-operation distinct from where
662 group-by having order-by
663 offset limit inner-join on &allow-other-keys)
665 (if (null selections)
666 (error "No target columns supplied to select statement."))
668 (error "No source tables supplied to select statement."))
669 (make-instance 'sql-query :selections selections
670 :all all :flatp flatp :set-operation set-operation
671 :distinct distinct :from from :where where
672 :limit limit :offset offset
673 :group-by group-by :having having :order-by order-by
674 :inner-join inner-join :on on))))))
676 (defmethod output-sql ((query sql-query) database)
677 (with-slots (distinct selections from where group-by having order-by
678 limit offset inner-join on all set-operation)
681 (write-string "(" *sql-stream*))
682 (write-string "SELECT " *sql-stream*)
684 (write-string " ALL " *sql-stream*))
685 (when (and distinct (not all))
686 (write-string " DISTINCT " *sql-stream*)
687 (unless (eql t distinct)
688 (write-string " ON " *sql-stream*)
689 (output-sql distinct database)
690 (write-char #\Space *sql-stream*)))
691 (when (and limit (eql :mssql (database-underlying-type database)))
692 (write-string " TOP " *sql-stream*)
693 (output-sql limit database)
694 (write-string " " *sql-stream*))
695 (let ((*in-subselect* t))
696 (output-sql (apply #'vector selections) database))
698 (write-string " FROM " *sql-stream*)
702 (remove-duplicates from :test #'database-identifier-equal))
704 (string (write-string
705 (escaped-database-identifier from database)
707 (t (let ((*in-subselect* t))
708 (output-sql from database)))))
710 (write-string " INNER JOIN " *sql-stream*)
711 (output-sql inner-join database))
713 (write-string " ON " *sql-stream*)
714 (output-sql on database))
716 (let ((where-out (string-trim
717 '(#\newline #\space #\tab #\return)
718 (with-output-to-string (*sql-stream*)
719 (let ((*in-subselect* t))
720 (output-sql where database))))))
721 (when (> (length where-out) 0)
722 (write-string " WHERE " *sql-stream*)
723 (write-string where-out *sql-stream*))))
725 (write-string " GROUP BY " *sql-stream*)
727 (do ((order group-by (cdr order)))
729 (let ((item (car order)))
732 (output-sql (car item) database)
733 (format *sql-stream* " ~A" (cadr item)))
735 (output-sql item database)))
737 (write-char #\, *sql-stream*))))
738 (output-sql group-by database)))
740 (write-string " HAVING " *sql-stream*)
741 (output-sql having database))
743 (write-string " ORDER BY " *sql-stream*)
745 (do ((order order-by (cdr order)))
747 (let ((item (car order)))
750 (output-sql (car item) database)
751 (format *sql-stream* " ~A" (cadr item)))
753 (output-sql item database)))
755 (write-char #\, *sql-stream*))))
756 (output-sql order-by database)))
757 (when (and limit (not (eql :mssql (database-underlying-type database))))
758 (write-string " LIMIT " *sql-stream*)
759 (output-sql limit database))
761 (write-string " OFFSET " *sql-stream*)
762 (output-sql offset database))
764 (write-string ")" *sql-stream*))
766 (write-char #\Space *sql-stream*)
767 (output-sql set-operation database)))
770 (defmethod output-sql ((query sql-object-query) database)
771 (declare (ignore database))
772 (with-slots (objects)
775 (format *sql-stream* "(~{~A~^ ~})" objects))))
780 (defclass sql-insert (%sql-expression)
794 "An SQL INSERT statement."))
796 (defmethod output-sql ((ins sql-insert) database)
797 (with-slots (into attributes values query)
799 (write-string "INSERT INTO " *sql-stream*)
802 (string (sql-expression :table into))
806 (write-char #\Space *sql-stream*)
807 (output-sql attributes database))
809 (write-string " VALUES " *sql-stream*)
810 (output-sql values database))
812 (write-char #\Space *sql-stream*)
813 (output-sql query database)))
818 (defclass sql-delete (%sql-expression)
826 "An SQL DELETE statement."))
828 (defmethod output-sql ((stmt sql-delete) database)
829 (with-slots (from where)
831 (write-string "DELETE FROM " *sql-stream*)
833 ((or symbol string) (write-string (sql-escape from) *sql-stream*))
834 (t (output-sql from database)))
836 (write-string " WHERE " *sql-stream*)
837 (output-sql where database)))
842 (defclass sql-update (%sql-expression)
855 (:documentation "An SQL UPDATE statement."))
857 (defmethod output-sql ((expr sql-update) database)
858 (with-slots (table where attributes values)
860 (flet ((update-assignments ()
861 (mapcar #'(lambda (a b)
862 (make-instance 'sql-assignment-exp
864 :sub-expressions (list a b)))
866 (write-string "UPDATE " *sql-stream*)
867 (output-sql table database)
868 (write-string " SET " *sql-stream*)
869 (output-sql (apply #'vector (update-assignments)) database)
871 (write-string " WHERE " *sql-stream*)
872 (output-sql where database))))
877 (defclass sql-create-table (%sql-expression)
888 :initarg :transactions
891 "An SQL CREATE TABLE statement."))
893 ;; Here's a real warhorse of a function!
895 (declaim (inline listify))
901 (defmethod output-sql ((stmt sql-create-table) database)
902 (flet ((output-column (column-spec)
903 (destructuring-bind (name type &optional db-type &rest constraints)
905 (let ((type (listify type)))
906 (output-sql name database)
907 (write-char #\Space *sql-stream*)
909 (if (stringp db-type) db-type ; override definition
910 (database-get-type-specifier (car type) (cdr type) database
911 (database-underlying-type database)))
913 (let ((constraints (database-constraint-statement
914 (if (and db-type (symbolp db-type))
915 (cons db-type constraints)
919 (write-string " " *sql-stream*)
920 (write-string constraints *sql-stream*)))))))
921 (with-slots (name columns modifiers transactions)
923 (write-string "CREATE TABLE " *sql-stream*)
924 (write-string (escaped-database-identifier name database) *sql-stream*)
925 (write-string " (" *sql-stream*)
926 (do ((column columns (cdr column)))
928 (output-column (car column)))
929 (output-column (car column))
930 (write-string ", " *sql-stream*))
932 (do ((modifier (listify modifiers) (cdr modifier)))
934 (write-string ", " *sql-stream*)
935 (write-string (car modifier) *sql-stream*)))
936 (write-char #\) *sql-stream*)
937 (when (and (eq :mysql (database-underlying-type database))
939 (db-type-transaction-capable? :mysql database))
940 (write-string " Type=InnoDB" *sql-stream*))))
946 (defclass sql-create-view (%sql-expression)
947 ((name :initarg :name :initform nil)
948 (column-list :initarg :column-list :initform nil)
949 (query :initarg :query :initform nil)
950 (with-check-option :initarg :with-check-option :initform nil))
951 (:documentation "An SQL CREATE VIEW statement."))
953 (defmethod output-sql ((stmt sql-create-view) database)
954 (with-slots (name column-list query with-check-option) stmt
955 (write-string "CREATE VIEW " *sql-stream*)
956 (output-sql name database)
957 (when column-list (write-string " " *sql-stream*)
958 (output-sql (listify column-list) database))
959 (write-string " AS " *sql-stream*)
960 (output-sql query database)
961 (when with-check-option (write-string " WITH CHECK OPTION" *sql-stream*))))
965 ;; DATABASE-OUTPUT-SQL
968 (defmethod database-output-sql ((str string) database)
969 (declare (optimize (speed 3) (safety 1)
970 #+cmu (extensions:inhibit-warnings 3)))
971 (let ((len (length str)))
972 (declare (type fixnum len))
975 ((and (null (position #\' str))
976 (null (position #\\ str)))
977 (concatenate 'string "'" str "'"))
979 (let ((buf (make-string (+ (* len 2) 2) :initial-element #\')))
980 (declare (simple-string buf))
983 ((= i len) (subseq buf 0 (1+ j)))
984 (declare (type fixnum i j))
985 (let ((char (aref str i)))
986 (declare (character char))
987 (cond ((char= char #\')
988 (setf (aref buf j) #\')
990 (setf (aref buf j) #\'))
991 ((and (char= char #\\)
992 ;; MTP: only escape backslash with pgsql/mysql
993 (member (database-underlying-type database)
994 '(:postgresql :mysql)
996 (setf (aref buf j) #\\)
998 (setf (aref buf j) #\\))
1000 (setf (aref buf j) char))))))))))
1002 (let ((keyword-package (symbol-package :foo)))
1003 (defmethod database-output-sql ((sym symbol) database)
1006 (if (equal (symbol-package sym) keyword-package)
1007 (database-output-sql (symbol-name sym) database)
1008 (escaped-database-identifier sym)))))
1010 (defmethod database-output-sql ((tee (eql t)) database)
1012 (let ((val (database-output-sql-as-type 'boolean t database (database-type database))))
1015 (string (format nil "'~A'" val))
1016 (integer (format nil "~A" val)))))
1019 #+nil(defmethod database-output-sql ((tee (eql t)) database)
1020 (declare (ignore database))
1023 (defmethod database-output-sql ((num number) database)
1024 (declare (ignore database))
1025 (number-to-sql-string num))
1027 (defmethod database-output-sql ((arg list) database)
1030 (format nil "(~{~A~^,~})" (mapcar #'(lambda (val)
1031 (sql-output val database))
1034 (defmethod database-output-sql ((arg vector) database)
1035 (format nil "~{~A~^,~}" (map 'list #'(lambda (val)
1036 (sql-output val database))
1039 (defmethod output-sql-hash-key ((arg vector) database)
1040 (list 'vector (map 'list (lambda (arg)
1041 (or (output-sql-hash-key arg database)
1042 (return-from output-sql-hash-key nil)))
1045 (defmethod database-output-sql ((self wall-time) database)
1046 (declare (ignore database))
1047 (db-timestring self))
1049 (defmethod database-output-sql ((self date) database)
1050 (declare (ignore database))
1051 (db-datestring self))
1053 (defmethod database-output-sql ((self duration) database)
1054 (declare (ignore database))
1055 (format nil "'~a'" (duration-timestring self)))
1058 (defmethod database-output-sql ((self money) database)
1059 (database-output-sql (slot-value self 'odcl::units) database))
1061 (defmethod database-output-sql (thing database)
1062 (if (or (null thing)
1065 (error 'sql-user-error
1068 "No type conversion to SQL for ~A is defined for DB ~A."
1069 (type-of thing) (type-of database)))))
1073 ;; Column constraint types and conversion to SQL
1076 (defparameter *constraint-types*
1078 (cons (symbol-name-default-case "NOT-NULL") "NOT NULL")
1079 (cons (symbol-name-default-case "PRIMARY-KEY") "PRIMARY KEY")
1080 (cons (symbol-name-default-case "NOT") "NOT")
1081 (cons (symbol-name-default-case "NULL") "NULL")
1082 (cons (symbol-name-default-case "PRIMARY") "PRIMARY")
1083 (cons (symbol-name-default-case "KEY") "KEY")
1084 (cons (symbol-name-default-case "UNSIGNED") "UNSIGNED")
1085 (cons (symbol-name-default-case "ZEROFILL") "ZEROFILL")
1086 (cons (symbol-name-default-case "AUTO-INCREMENT") "AUTO_INCREMENT")
1087 (cons (symbol-name-default-case "DEFAULT") "DEFAULT")
1088 (cons (symbol-name-default-case "UNIQUE") "UNIQUE")
1089 (cons (symbol-name-default-case "IDENTITY") "IDENTITY (1,1)") ;; added for sql-server support
1092 (defmethod database-constraint-statement (constraint-list database)
1093 (declare (ignore database))
1094 (make-constraints-description constraint-list))
1096 (defun make-constraints-description (constraint-list)
1099 (do ((constraint constraint-list (cdr constraint)))
1100 ((null constraint) string)
1101 (let ((output (assoc (symbol-name (car constraint))
1105 (error 'sql-user-error
1106 :message (format nil "unsupported column constraint '~A'"
1108 (setq string (concatenate 'string string (cdr output))))
1109 (when (equal (symbol-name (car constraint)) "DEFAULT")
1110 (setq constraint (cdr constraint))
1111 (setq string (concatenate 'string string " " (car constraint))))
1112 (if (< 1 (length constraint))
1113 (setq string (concatenate 'string string " "))))))))
1115 (defmethod database-identifier ( name &optional database find-class-p
1117 "A function that takes whatever you give it, recurively coerces it,
1118 and returns a database-identifier.
1120 (escaped-database-identifiers *any-reasonable-object*) should be called to
1121 produce a string that is safe to splice directly into sql strings.
1123 This function should NOT throw errors when database is nil
1125 find-class-p should be T if we want to search for classes
1126 and check their use their view table. Should be used
1127 on symbols we are sure indicate tables
1130 ;; metaclasses has further typecases of this, so that it will
1131 ;; load less painfully (try-recompiles) in SBCL
1134 (flet ((flatten-id (id)
1135 "if we have multiple pieces that we need to represent as
1136 db-id lets do that by rendering out the id, then creating
1137 a new db-id with that string as escaped"
1138 (let ((s (sql-output id database)))
1139 (make-instance '%database-identifier :escaped s :unescaped s))))
1142 (string (%make-database-identifier name database))
1144 ;; if this is being used as a table, we should check
1145 ;; for a class with this name and use the identifier specified
1147 (if (and find-class-p (setf cls (find-standard-db-class name)))
1148 (database-identifier cls)
1149 (%make-database-identifier name database)))
1150 (%database-identifier name)
1151 ;; we know how to deref this without further escaping
1153 (with-slots ((inner-name name) alias) name
1156 (database-identifier inner-name))))
1157 ;; if this is a single name we can derefence it
1158 (sql-ident-attribute
1159 (with-slots (qualifier (inner-name name)) name
1162 (database-identifier inner-name))))
1164 (with-slots ((inner-name name)) name
1165 (database-identifier inner-name)))
1166 ;; dont know how to handle this really :/
1167 (%sql-expression (flatten-id name))