/usr/share/common-lisp/source/clsql/sql/expressions.lisp is in cl-sql 6.7.0-1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 | ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
;;;; *************************************************************************
;;;;
;;;; Classes defining SQL expressions and methods for formatting the
;;;; appropriate SQL commands.
;;;;
;;;; This file is part of CLSQL.
;;;;
;;;; CLSQL users are granted the rights to distribute and use this software
;;;; as governed by the terms of the Lisp Lesser GNU Public License
;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
;;;; *************************************************************************
(in-package #:clsql-sys)
(defvar +empty-string+ "''")
(defvar +null-string+ "NULL")
(defvar *sql-stream* nil
"stream which accumulates SQL output")
(defclass %database-identifier ()
((escaped :accessor escaped :initarg :escaped :initform nil)
(unescaped :accessor unescaped :initarg :unescaped :initform nil))
(:documentation
"A database identifier represents a string/symbol ready to be spliced
into a sql string. It keeps references to both the escaped and
unescaped versions so that unescaped versions can be compared to the
results of list-tables/views/attributes etc. It also allows you to be
sure that an identifier is escaped only once.
(escaped-database-identifiers *any-reasonable-object*) should be called to
produce a string that is safe to splice directly into sql strings.
(unescaped-database-identifier *any-reasonable-object*) is generally what
you pass to it with the exception that symbols have been
clsql-sys:sql-escape which converts to a string and changes - to _ (so
that unescaped can be compared to the results of eg: list-tables)
"))
(defmethod escaped ((it null)) it)
(defmethod unescaped ((it null)) it)
(defun database-identifier-equal (i1 i2 &optional (database clsql-sys:*default-database*))
(setf i1 (database-identifier i1 database)
i2 (database-identifier i2 database))
(flet ((cast (i)
(if (symbolp (unescaped i))
(sql-escape (unescaped i))
(unescaped i))))
(or ;; check for an exact match
(equal (escaped-database-identifier i1)
(escaped-database-identifier i2))
;; check for an inexact match if we had symbols in the mix
(string-equal (cast i1) (cast i2)))))
(defun delistify-dsd (list)
"Some MOPs, like openmcl 0.14.2, cons attribute values in a list."
(if (and (listp list) (null (cdr list)))
(car list)
list))
(defun special-char-p (s)
"Check if a string has any special characters"
(loop for char across s
thereis (find char '(#\space #\, #\. #\! #\@ #\# #\$ #\% #\' #\"
#\^ #\& #\* #\| #\( #\) #\- #\+ #\< #\>
#\{ #\}))))
(defun special-cased-symbol-p (sym)
"Should the symbols case be preserved, or should we convert to default casing"
(let ((name (symbol-name sym)))
(case (readtable-case *readtable*)
(:upcase (not (string= (string-upcase name) name)))
(:downcase (not (string= (string-downcase name) name)))
(t t))))
(defun %make-database-identifier (inp &optional database)
"We want to quote an identifier if it came to us as a string or if it has special characters
in it."
(labels ((%escape-identifier (inp &optional orig)
"Quote an identifier unless it is already quoted"
(cond
;; already quoted
((and (eql #\" (elt inp 0))
(eql #\" (elt inp (- (length inp) 1))))
(make-instance '%database-identifier :unescaped (or orig inp) :escaped inp))
(T (make-instance
'%database-identifier :unescaped (or orig inp) :escaped
(concatenate
'string "\"" (replace-all inp "\"" "\\\"") "\""))))))
(typecase inp
(string (%escape-identifier inp))
(%database-identifier inp)
(symbol
(let ((s (sql-escape inp)))
(if (and (not (eql '* inp)) (special-char-p s))
(%escape-identifier
(if (special-cased-symbol-p inp)
s
(convert-to-db-default-case s database)) inp)
(make-instance '%database-identifier :escaped s :unescaped inp))
)))))
(defun combine-database-identifiers (ids &optional (database clsql-sys:*default-database*)
&aux res all-sym? pkg)
"Create a new database identifier by combining parts in a reasonable way
"
(setf ids (mapcar #'database-identifier ids)
all-sym? (every (lambda (i) (symbolp (unescaped i))) ids)
pkg (when all-sym? (symbol-package (unescaped (first ids)))))
(labels ((cast ( i )
(typecase i
(null nil)
(%database-identifier (cast (unescaped i)))
(symbol
(if all-sym?
(sql-escape i)
(convert-to-db-default-case (sql-escape i) database)))
(string i)))
(comb (i1 i2)
(setf i1 (cast i1)
i2 (cast i2))
(if (and i1 i2)
(concatenate 'string (cast i1) "_" (cast i2))
(or i1 i2))))
(setf res (reduce #'comb ids))
(database-identifier
(if all-sym? (intern res pkg) res)
database)))
(defun escaped-database-identifier (name &optional database find-class-p)
(escaped (database-identifier name database find-class-p)))
(defun unescaped-database-identifier (name &optional database find-class-p)
(unescaped (database-identifier name database find-class-p)))
(defun sql-output (sql-expr &optional (database *default-database*))
"Top-level call for generating SQL strings. Returns an SQL
string appropriate for DATABASE which corresponds to the
supplied lisp expression SQL-EXPR."
(with-output-to-string (*sql-stream*)
(output-sql sql-expr database)))
(defmethod output-sql (expr database)
(write-string (database-output-sql expr database) *sql-stream*)
(values))
(defvar *output-hash*
(make-weak-hash-table :test #'equal)
"For caching generated SQL strings, set to NIL to disable."
)
(defmethod output-sql :around ((sql t) database)
(if (null *output-hash*)
(call-next-method)
(let* ((hash-key (output-sql-hash-key sql database))
(hash-value (when hash-key (gethash hash-key *output-hash*))))
(cond ((and hash-key hash-value)
(write-string hash-value *sql-stream*))
(hash-key
(let ((*sql-stream* (make-string-output-stream)))
(call-next-method)
(setf hash-value (get-output-stream-string *sql-stream*))
(setf (gethash hash-key *output-hash*) hash-value))
(write-string hash-value *sql-stream*))
(t
(call-next-method))))))
(defmethod output-sql-hash-key (expr database)
(declare (ignore expr database))
nil)
(defclass %sql-expression ()
())
(defmethod output-sql ((expr %sql-expression) database)
(declare (ignore database))
(write-string +null-string+ *sql-stream*))
(defmethod print-object ((self %sql-expression) stream)
(print-unreadable-object
(self stream :type t)
(write-string (sql-output self) stream))
self)
;; For straight up strings
(defclass sql (%sql-expression)
((text
:initarg :string
:initform ""))
(:documentation "A literal SQL expression."))
(defmethod make-load-form ((sql sql) &optional environment)
(declare (ignore environment))
(with-slots (text)
sql
`(make-instance 'sql :string ',text)))
(defmethod output-sql ((expr sql) database)
(declare (ignore database))
(write-string (slot-value expr 'text) *sql-stream*)
t)
(defmethod print-object ((ident sql) stream)
(format stream "#<~S \"~A\">"
(type-of ident)
(sql-output ident nil))
ident)
;; For SQL Identifiers of generic type
(defclass sql-ident (%sql-expression)
((name
:initarg :name
:initform +null-string+))
(:documentation "An SQL identifer."))
(defmethod make-load-form ((sql sql-ident) &optional environment)
(declare (ignore environment))
(with-slots (name)
sql
`(make-instance 'sql-ident :name ',name)))
(defmethod output-sql ((expr %database-identifier) database)
(write-string (escaped expr) *sql-stream*))
(defmethod output-sql ((expr sql-ident) database)
(with-slots (name) expr
(write-string (escaped-database-identifier name database) *sql-stream*))
t)
;; For SQL Identifiers for attributes
(defclass sql-ident-attribute (sql-ident)
((qualifier
:initarg :qualifier
:initform +null-string+)
(type
:initarg :type
:initform +null-string+))
(:documentation "An SQL Attribute identifier."))
(defmethod collect-table-refs (sql)
(declare (ignore sql))
nil)
(defmethod collect-table-refs ((sql list))
(loop for i in sql
appending (listify (collect-table-refs i))))
(defmethod collect-table-refs ((sql sql-ident-attribute))
(let ((qual (slot-value sql 'qualifier)))
(when qual
;; going to be used as a table, search classes
(list (make-instance
'sql-ident-table
:name (database-identifier qual nil t))))))
(defmethod make-load-form ((sql sql-ident-attribute) &optional environment)
(declare (ignore environment))
(with-slots (qualifier type name)
sql
`(make-instance 'sql-ident-attribute :name ',name
:qualifier ',qualifier
:type ',type)))
(defmethod output-sql-hash-key ((expr sql-ident-attribute) database)
(with-slots (qualifier name type)
expr
(list (and database (database-underlying-type database))
'sql-ident-attribute
(unescaped-database-identifier qualifier)
(unescaped-database-identifier name) type)))
;; For SQL Identifiers for tables
(defclass sql-ident-table (sql-ident)
((alias
:initarg :table-alias :initform nil))
(:documentation "An SQL table identifier."))
(defmethod make-load-form ((sql sql-ident-table) &optional environment)
(declare (ignore environment))
(with-slots (alias name)
sql
`(make-instance 'sql-ident-table :name ',name :table-alias ',alias)))
(defmethod collect-table-refs ((sql sql-ident-table))
(list sql))
(defmethod output-sql ((expr sql-ident-table) database)
(with-slots (name alias) expr
(flet ((p (s) ;; the etypecase is in sql-escape too
(write-string
(escaped-database-identifier s database)
*sql-stream*)))
(p name)
(when alias
(princ #\space *sql-stream*)
(p alias))))
t)
(defmethod output-sql ((expr sql-ident-attribute) database)
;;; KMR: The TYPE field is used by CommonSQL for type conversion -- it
;;; should not be output in SQL statements
(let ((*print-pretty* nil))
(with-slots (qualifier name type) expr
(format *sql-stream* "~@[~a.~]~a"
(when qualifier
;; check for classes
(escaped-database-identifier qualifier database T))
(escaped-database-identifier name database))
t)))
(defmethod output-sql-hash-key ((expr sql-ident-table) database)
(with-slots (name alias)
expr
(list (and database (database-underlying-type database))
'sql-ident-table
(unescaped-database-identifier name)
(unescaped-database-identifier alias))))
(defclass sql-relational-exp (%sql-expression)
((operator
:initarg :operator
:initform nil)
(sub-expressions
:initarg :sub-expressions
:initform nil))
(:documentation "An SQL relational expression."))
(defmethod make-load-form ((self sql-relational-exp) &optional environment)
(make-load-form-saving-slots self
:slot-names '(operator sub-expressions)
:environment environment))
(defmethod collect-table-refs ((sql sql-relational-exp))
(let ((tabs nil))
(dolist (exp (slot-value sql 'sub-expressions))
(let ((refs (collect-table-refs exp)))
(if refs (setf tabs (append refs tabs)))))
(remove-duplicates tabs :test #'database-identifier-equal)))
;; Write SQL for relational operators (like 'AND' and 'OR').
;; should do arity checking of subexpressions
(defun %write-operator (operator database)
(typecase operator
(string (write-string operator *sql-stream*))
(symbol (write-string (symbol-name operator) *sql-stream*))
(T (output-sql operator database))))
(defmethod output-sql ((expr sql-relational-exp) database)
(with-slots (operator sub-expressions) expr
;; we do this as two runs so as not to emit confusing superflous parentheses
;; The first loop renders all the child outputs so that we can skip anding with
;; empty output (which causes sql errors)
;; the next loop simply emits each sub-expression with the appropriate number of
;; parens and operators
(flet ((trim (sub)
(string-trim +whitespace-chars+
(with-output-to-string (*sql-stream*)
(output-sql sub database)))))
(let ((str-subs (loop for sub in sub-expressions
for str-sub = (trim sub)
when (and str-sub (> (length str-sub) 0))
collect str-sub)))
(case (length str-subs)
(0 nil)
(1 (write-string (first str-subs) *sql-stream*))
(t
(write-char #\( *sql-stream*)
(write-string (first str-subs) *sql-stream*)
(loop for str-sub in (rest str-subs)
do
(write-char #\Space *sql-stream*)
;; do this so that symbols can be output as database identifiers
;; rather than allowing symbols to inject sql
(%write-operator operator database)
(write-char #\Space *sql-stream*)
(write-string str-sub *sql-stream*))
(write-char #\) *sql-stream*))
))))
t)
(defclass sql-upcase-like (sql-relational-exp)
()
(:documentation "An SQL 'like' that upcases its arguments."))
(defmethod output-sql ((expr sql-upcase-like) database)
(flet ((write-term (term)
(write-string "upper(" *sql-stream*)
(output-sql term database)
(write-char #\) *sql-stream*)))
(with-slots (sub-expressions)
expr
(let ((subs (if (consp (car sub-expressions))
(car sub-expressions)
sub-expressions)))
(write-char #\( *sql-stream*)
(do ((sub subs (cdr sub)))
((null (cdr sub)) (write-term (car sub)))
(write-term (car sub))
(write-string " LIKE " *sql-stream*))
(write-char #\) *sql-stream*))))
t)
(defclass sql-assignment-exp (sql-relational-exp)
()
(:documentation "An SQL Assignment expression."))
(defmethod output-sql ((expr sql-assignment-exp) database)
(with-slots (operator sub-expressions)
expr
(do ((sub sub-expressions (cdr sub)))
((null (cdr sub)) (output-sql (car sub) database))
(output-sql (car sub) database)
(write-char #\Space *sql-stream*)
(%write-operator operator database)
(write-char #\Space *sql-stream*)))
t)
(defclass sql-value-exp (%sql-expression)
((modifier
:initarg :modifier
:initform nil)
(components
:initarg :components
:initform nil))
(:documentation
"An SQL value expression.")
)
(defmethod collect-table-refs ((sql sql-value-exp))
(let ((tabs nil))
(if (listp (slot-value sql 'components))
(progn
(dolist (exp (slot-value sql 'components))
(let ((refs (collect-table-refs exp)))
(if refs (setf tabs (append refs tabs)))))
(remove-duplicates tabs :test #'database-identifier-equal))
nil)))
(defmethod output-sql ((expr sql-value-exp) database)
(with-slots (modifier components)
expr
(if modifier
(progn
(write-char #\( *sql-stream*)
(cond
((sql-operator modifier)
(%write-operator modifier database))
((or (stringp modifier) (symbolp modifier))
(write-string
(escaped-database-identifier modifier)
*sql-stream*))
(t (output-sql modifier database)))
(write-char #\Space *sql-stream*)
(output-sql components database)
(write-char #\) *sql-stream*))
(output-sql components database))))
(defclass sql-typecast-exp (sql-value-exp)
()
(:documentation "An SQL typecast expression."))
(defmethod output-sql ((expr sql-typecast-exp) database)
(with-slots (components)
expr
(output-sql components database)))
(defmethod collect-table-refs ((sql sql-typecast-exp))
(when (slot-value sql 'components)
(collect-table-refs (slot-value sql 'components))))
(defclass sql-function-exp (%sql-expression)
((name
:initarg :name
:initform nil)
(args
:initarg :args
:initform nil))
(:documentation
"An SQL function expression."))
(defmethod collect-table-refs ((sql sql-function-exp))
(let ((tabs nil))
(dolist (exp (slot-value sql 'args))
(let ((refs (collect-table-refs exp)))
(if refs (setf tabs (append refs tabs)))))
(remove-duplicates tabs :test #'database-identifier-equal)))
(defvar *in-subselect* nil)
(defmethod output-sql ((expr sql-function-exp) database)
(with-slots (name args)
expr
(typecase name
((or string symbol)
(write-string (escaped-database-identifier name) *sql-stream*))
(t (output-sql name database)))
(let ((*in-subselect* nil)) ;; aboid double parens
(when args (output-sql args database))))
t)
(defclass sql-between-exp (sql-function-exp)
()
(:documentation "An SQL between expression."))
(defmethod output-sql ((expr sql-between-exp) database)
(with-slots (args)
expr
(output-sql (first args) database)
(write-string " BETWEEN " *sql-stream*)
(output-sql (second args) database)
(write-string " AND " *sql-stream*)
(output-sql (third args) database))
t)
(defclass sql-query-modifier-exp (%sql-expression)
((modifier :initarg :modifier :initform nil)
(components :initarg :components :initform nil))
(:documentation "An SQL query modifier expression."))
(defmethod output-sql ((expr sql-query-modifier-exp) database)
(with-slots (modifier components)
expr
(%write-operator modifier database)
(write-string " " *sql-stream*)
(%write-operator (car components) database)
(when components
(mapc #'(lambda (comp)
(write-string ", " *sql-stream*)
(output-sql comp database))
(cdr components))))
t)
(defclass sql-set-exp (%sql-expression)
((operator
:initarg :operator
:initform nil)
(sub-expressions
:initarg :sub-expressions
:initform nil))
(:documentation "An SQL set expression."))
(defmethod collect-table-refs ((sql sql-set-exp))
(let ((tabs nil))
(dolist (exp (slot-value sql 'sub-expressions))
(let ((refs (collect-table-refs exp)))
(if refs (setf tabs (append refs tabs)))))
(remove-duplicates tabs :test #'database-identifier-equal)))
(defmethod output-sql ((expr sql-set-exp) database)
(with-slots (operator sub-expressions)
expr
(let ((subs (if (consp (car sub-expressions))
(car sub-expressions)
sub-expressions)))
(when (= (length subs) 1)
(%write-operator operator database)
(write-char #\Space *sql-stream*))
(do ((sub subs (cdr sub)))
((null (cdr sub)) (output-sql (car sub) database))
(output-sql (car sub) database)
(write-char #\Space *sql-stream*)
(%write-operator operator database)
(write-char #\Space *sql-stream*))))
t)
(defclass sql-query (%sql-expression)
((selections
:initarg :selections
:initform nil)
(all
:initarg :all
:initform nil)
(flatp
:initarg :flatp
:initform nil)
(set-operation
:initarg :set-operation
:initform nil)
(distinct
:initarg :distinct
:initform nil)
(from
:initarg :from
:initform nil)
(where
:initarg :where
:initform nil)
(group-by
:initarg :group-by
:initform nil)
(having
:initarg :having
:initform nil)
(limit
:initarg :limit
:initform nil)
(offset
:initarg :offset
:initform nil)
(order-by
:initarg :order-by
:initform nil)
(inner-join
:initarg :inner-join
:initform nil)
(on
:initarg :on
:initform nil))
(:documentation "An SQL SELECT query."))
(defclass sql-object-query (%sql-expression)
((objects
:initarg :objects
:initform nil)
(flatp
:initarg :flatp
:initform nil)
(exp
:initarg :exp
:initform nil)
(refresh
:initarg :refresh
:initform nil)))
(defmethod collect-table-refs ((sql sql-query))
(remove-duplicates
(collect-table-refs (slot-value sql 'where))
:test #'database-identifier-equal))
(defvar *select-arguments*
'(:all :database :distinct :flatp :from :group-by :having :order-by
:set-operation :where :offset :limit :inner-join :on
;; below keywords are not a SQL argument, but these keywords may terminate select
:caching :refresh))
(defun query-arg-p (sym)
(member sym *select-arguments*))
(defun query-get-selections (select-args)
"Return two values: the list of select-args up to the first keyword,
uninclusive, and the args from that keyword to the end."
(let ((first-key-arg (position-if #'query-arg-p select-args)))
(if first-key-arg
(values (subseq select-args 0 first-key-arg)
(subseq select-args first-key-arg))
select-args)))
(defun make-query (&rest args)
(flet ((select-objects (target-args)
(and target-args
(every #'(lambda (arg)
(and (symbolp arg)
(find-class arg nil)))
target-args))))
(multiple-value-bind (selections arglist)
(query-get-selections args)
(if (select-objects selections)
(destructuring-bind (&key flatp refresh &allow-other-keys) arglist
(make-instance 'sql-object-query :objects selections
:flatp flatp :refresh refresh
:exp arglist))
(destructuring-bind (&key all flatp set-operation distinct from where
group-by having order-by
offset limit inner-join on &allow-other-keys)
arglist
(if (null selections)
(error "No target columns supplied to select statement."))
(if (null from)
(error "No source tables supplied to select statement."))
(make-instance 'sql-query :selections selections
:all all :flatp flatp :set-operation set-operation
:distinct distinct :from from :where where
:limit limit :offset offset
:group-by group-by :having having :order-by order-by
:inner-join inner-join :on on))))))
(defun output-sql-where-clause (where database)
"ensure that we do not output a \"where\" sql keyword when we will
not output a clause. Also sets *in-subselect* to use SQL
parentheticals as needed."
(when where
(let ((where-out (string-trim
'(#\newline #\space #\tab #\return)
(with-output-to-string (*sql-stream*)
(let ((*in-subselect* t))
(output-sql where database))))))
(when (> (length where-out) 0)
(write-string " WHERE " *sql-stream*)
(write-string where-out *sql-stream*)))))
(defmethod output-sql ((query sql-query) database)
(with-slots (distinct selections from where group-by having order-by
limit offset inner-join on all set-operation)
query
(when *in-subselect*
(write-string "(" *sql-stream*))
(write-string "SELECT " *sql-stream*)
(when all
(write-string " ALL " *sql-stream*))
(when (and distinct (not all))
(write-string " DISTINCT " *sql-stream*)
(unless (eql t distinct)
(write-string " ON " *sql-stream*)
(output-sql distinct database)
(write-char #\Space *sql-stream*)))
(when (and limit (eql :mssql (database-underlying-type database)))
(write-string " TOP " *sql-stream*)
(output-sql limit database)
(write-string " " *sql-stream*))
(let ((*in-subselect* t))
(output-sql (apply #'vector selections) database))
(when from
(write-string " FROM " *sql-stream*)
(typecase from
(list (output-sql
(apply #'vector
(remove-duplicates from :test #'database-identifier-equal))
database))
(string (write-string
(escaped-database-identifier from database)
*sql-stream*))
(t (let ((*in-subselect* t))
(output-sql from database)))))
(when inner-join
(write-string " INNER JOIN " *sql-stream*)
(output-sql inner-join database))
(when on
(write-string " ON " *sql-stream*)
(output-sql on database))
(output-sql-where-clause where database)
(when group-by
(write-string " GROUP BY " *sql-stream*)
(if (listp group-by)
(do ((order group-by (cdr order)))
((null order))
(let ((item (car order)))
(typecase item
(cons
(output-sql (car item) database)
(format *sql-stream* " ~A" (cadr item)))
(t
(output-sql item database)))
(when (cdr order)
(write-char #\, *sql-stream*))))
(output-sql group-by database)))
(when having
(write-string " HAVING " *sql-stream*)
(output-sql having database))
(when order-by
(write-string " ORDER BY " *sql-stream*)
(if (listp order-by)
(do ((order order-by (cdr order)))
((null order))
(let ((item (car order)))
(typecase item
(cons
(output-sql (car item) database)
(format *sql-stream* " ~A" (cadr item)))
(t
(output-sql item database)))
(when (cdr order)
(write-char #\, *sql-stream*))))
(output-sql order-by database)))
(when (and limit (not (eql :mssql (database-underlying-type database))))
(write-string " LIMIT " *sql-stream*)
(output-sql limit database))
(when offset
(write-string " OFFSET " *sql-stream*)
(output-sql offset database))
(when *in-subselect*
(write-string ")" *sql-stream*))
(when set-operation
(write-char #\Space *sql-stream*)
(output-sql set-operation database)))
t)
(defmethod output-sql ((query sql-object-query) database)
(declare (ignore database))
(with-slots (objects)
query
(when objects
(format *sql-stream* "(~{~A~^ ~})" objects))))
;; INSERT
(defclass sql-insert (%sql-expression)
((into
:initarg :into
:initform nil)
(attributes
:initarg :attributes
:initform nil)
(values
:initarg :values
:initform nil)
(query
:initarg :query
:initform nil))
(:documentation
"An SQL INSERT statement."))
(defmethod output-sql ((ins sql-insert) database)
(with-slots (into attributes values query)
ins
(write-string "INSERT INTO " *sql-stream*)
(output-sql
(typecase into
(string (sql-expression :table into))
(t into))
database)
(when attributes
(write-char #\Space *sql-stream*)
(output-sql attributes database))
(when values
(write-string " VALUES " *sql-stream*)
(let ((clsql-sys::*in-subselect* t))
(output-sql values database)))
(when query
(write-char #\Space *sql-stream*)
(output-sql query database)))
t)
;; DELETE
(defclass sql-delete (%sql-expression)
((from
:initarg :from
:initform nil)
(where
:initarg :where
:initform nil))
(:documentation
"An SQL DELETE statement."))
(defmethod output-sql ((stmt sql-delete) database)
(with-slots (from where)
stmt
(write-string "DELETE FROM " *sql-stream*)
(typecase from
((or symbol string) (write-string (sql-escape from) *sql-stream*))
(t (output-sql from database)))
(output-sql-where-clause where database))
t)
;; UPDATE
(defclass sql-update (%sql-expression)
((table
:initarg :table
:initform nil)
(attributes
:initarg :attributes
:initform nil)
(values
:initarg :values
:initform nil)
(where
:initarg :where
:initform nil))
(:documentation "An SQL UPDATE statement."))
(defmethod output-sql ((expr sql-update) database)
(with-slots (table where attributes values)
expr
(flet ((update-assignments ()
(mapcar #'(lambda (a b)
(make-instance 'sql-assignment-exp
:operator '=
:sub-expressions (list a b)))
attributes values)))
(write-string "UPDATE " *sql-stream*)
(output-sql table database)
(write-string " SET " *sql-stream*)
(let ((clsql-sys::*in-subselect* t))
(output-sql (apply #'vector (update-assignments)) database))
(output-sql-where-clause where database)))
t)
;; CREATE TABLE
(defclass sql-create-table (%sql-expression)
((name
:initarg :name
:initform nil)
(columns
:initarg :columns
:initform nil)
(modifiers
:initarg :modifiers
:initform nil)
(transactions
:initarg :transactions
:initform nil))
(:documentation
"An SQL CREATE TABLE statement."))
;; Here's a real warhorse of a function!
(declaim (inline listify))
(defun listify (x)
(if (listp x)
x
(list x)))
(defmethod output-sql ((stmt sql-create-table) database)
(flet ((output-column (column-spec)
(destructuring-bind (name type &optional db-type &rest constraints)
column-spec
(let ((type (listify type)))
(output-sql name database)
(write-char #\Space *sql-stream*)
(write-string
(if (stringp db-type) db-type ; override definition
(database-get-type-specifier (car type) (cdr type) database
(database-underlying-type database)))
*sql-stream*)
(let ((constraints (database-constraint-statement
(if (and db-type (symbolp db-type))
(cons db-type constraints)
constraints)
database)))
(when constraints
(write-string " " *sql-stream*)
(write-string constraints *sql-stream*)))))))
(with-slots (name columns modifiers transactions)
stmt
(write-string "CREATE TABLE " *sql-stream*)
(write-string (escaped-database-identifier name database) *sql-stream*)
(write-string " (" *sql-stream*)
(do ((column columns (cdr column)))
((null (cdr column))
(output-column (car column)))
(output-column (car column))
(write-string ", " *sql-stream*))
(when modifiers
(do ((modifier (listify modifiers) (cdr modifier)))
((null modifier))
(write-string ", " *sql-stream*)
(write-string (car modifier) *sql-stream*)))
(write-char #\) *sql-stream*)
(when (and (eq :mysql (database-underlying-type database))
transactions
(db-type-transaction-capable? :mysql database))
(write-string " ENGINE=innodb" *sql-stream*))))
t)
;; CREATE VIEW
(defclass sql-create-view (%sql-expression)
((name :initarg :name :initform nil)
(column-list :initarg :column-list :initform nil)
(query :initarg :query :initform nil)
(with-check-option :initarg :with-check-option :initform nil))
(:documentation "An SQL CREATE VIEW statement."))
(defmethod output-sql ((stmt sql-create-view) database)
(with-slots (name column-list query with-check-option) stmt
(write-string "CREATE VIEW " *sql-stream*)
(output-sql name database)
(when column-list (write-string " " *sql-stream*)
(output-sql (listify column-list) database))
(write-string " AS " *sql-stream*)
(output-sql query database)
(when with-check-option (write-string " WITH CHECK OPTION" *sql-stream*))))
;;
;; DATABASE-OUTPUT-SQL
;;
(defmethod database-output-sql ((str string) database)
(declare (optimize (speed 3) (safety 1)
#+cmu (extensions:inhibit-warnings 3)))
(let ((len (length str)))
(declare (type fixnum len))
(cond ((zerop len)
+empty-string+)
((and (null (position #\' str))
(null (position #\\ str)))
(concatenate 'string "'" str "'"))
(t
(let ((buf (make-string (+ (* len 2) 2) :initial-element #\')))
(declare (simple-string buf))
(do* ((i 0 (incf i))
(j 1 (incf j)))
((= i len) (subseq buf 0 (1+ j)))
(declare (type fixnum i j))
(let ((char (aref str i)))
(declare (character char))
(cond ((char= char #\')
(setf (aref buf j) #\')
(incf j)
(setf (aref buf j) #\'))
((and (char= char #\\)
;; MTP: only escape backslash with pgsql/mysql
(member (database-underlying-type database)
'(:postgresql :mysql)
:test #'eq))
(setf (aref buf j) #\\)
(incf j)
(setf (aref buf j) #\\))
(t
(setf (aref buf j) char))))))))))
(let ((keyword-package (symbol-package :foo)))
(defmethod database-output-sql ((sym symbol) database)
(if (null sym)
+null-string+
(if (equal (symbol-package sym) keyword-package)
(database-output-sql (symbol-name sym) database)
(escaped-database-identifier sym)))))
(defmethod database-output-sql ((tee (eql t)) database)
(if database
(let ((val (database-output-sql-as-type 'boolean t database (database-type database))))
(when val
(typecase val
(string (format nil "'~A'" val))
(integer (format nil "~A" val)))))
"'Y'"))
#+nil(defmethod database-output-sql ((tee (eql t)) database)
(declare (ignore database))
"'Y'")
(defmethod database-output-sql ((num number) database)
(declare (ignore database))
(number-to-sql-string num))
(defmethod database-output-sql ((arg list) database)
(if (null arg)
+null-string+
(format nil "(~{~A~^,~})" (mapcar #'(lambda (val)
(sql-output val database))
arg))))
(defmethod database-output-sql ((arg vector) database)
(format nil "~{~A~^,~}" (map 'list #'(lambda (val)
(sql-output val database))
arg)))
(defmethod output-sql-hash-key ((arg vector) database)
(list 'vector (map 'list (lambda (arg)
(or (output-sql-hash-key arg database)
(return-from output-sql-hash-key nil)))
arg)))
(defmethod database-output-sql ((self wall-time) database)
(declare (ignore database))
(db-timestring self))
(defmethod database-output-sql ((self date) database)
(declare (ignore database))
(db-datestring self))
(defmethod database-output-sql ((self duration) database)
(declare (ignore database))
(format nil "'~a'" (duration-timestring self)))
#+ignore
(defmethod database-output-sql ((self money) database)
(database-output-sql (slot-value self 'odcl::units) database))
(defmethod database-output-sql (thing database)
(if (or (null thing)
(eq 'null thing))
+null-string+
(error 'sql-user-error
:message
(format nil
"No type conversion to SQL for ~A is defined for DB ~A."
(type-of thing) (type-of database)))))
;;
;; Column constraint types and conversion to SQL
;;
(defmethod database-constraint-statement (constraint-list database)
(make-constraints-description constraint-list database))
;; KEEP THIS SYNCED WITH database-translate-constraint
(defparameter +auto-increment-names+
'(:auto-increment :auto_increment :autoincrement :identity))
(defmethod database-translate-constraint (constraint database)
(case constraint
(:not-null "NOT NULL")
(:primary-key "PRIMARY KEY")
((:auto-increment :auto_increment :autoincrement :identity)
(ecase (database-underlying-type database)
(:mssql "IDENTITY (1,1)")
((:sqlite :sqlite3) "PRIMARY KEY AUTOINCREMENT")
(:mysql "AUTO_INCREMENT")
;; this is modeled as a datatype instead of a constraint
(:postgresql "")))
;; everything else just get the name
(T (string-upcase (symbol-name constraint)))))
(defun make-constraints-description (constraint-list database
&aux (rest constraint-list) constraint)
(when constraint-list
(flet ((next ()
(setf constraint (first rest)
rest (rest rest))
constraint))
(with-output-to-string (s)
(loop while (next)
do (unless (keywordp constraint)
(setf constraint (intern (symbol-name constraint) :keyword)))
(write-string (database-translate-constraint constraint database) s)
(when (eql :default constraint) (princ (next) s))
(write-char #\space s)
)))))
(defmethod database-identifier ( name &optional database find-class-p
&aux cls)
"A function that takes whatever you give it, recursively coerces it,
and returns a database-identifier.
(escaped-database-identifiers *any-reasonable-object*) should be called to
produce a string that is safe to splice directly into sql strings.
This function should NOT throw errors when database is nil
find-class-p should be T if we want to search for classes
and check their use their view table. Should be used
on symbols we are sure indicate tables
;; metaclasses has further typecases of this, so that it will
;; load less painfully (try-recompiles) in SBCL
"
(flet ((flatten-id (id)
"if we have multiple pieces that we need to represent as
db-id lets do that by rendering out the id, then creating
a new db-id with that string as escaped"
(let ((s (sql-output id database)))
(make-instance '%database-identifier :escaped s :unescaped s))))
(setf name (dequote name))
(etypecase name
(null nil)
(string (%make-database-identifier name database))
(symbol
;; if this is being used as a table, we should check
;; for a class with this name and use the identifier specified
;; on it
(if (and find-class-p (setf cls (find-standard-db-class name)))
(database-identifier cls)
(%make-database-identifier name database)))
(%database-identifier name)
;; we know how to deref this without further escaping
(sql-ident-table
(with-slots ((inner-name name) alias) name
(if alias
(flatten-id name)
(database-identifier inner-name))))
;; if this is a single name we can derefence it
(sql-ident-attribute
(with-slots (qualifier (inner-name name)) name
(if qualifier
(flatten-id name)
(database-identifier inner-name))))
(sql-ident
(with-slots ((inner-name name)) name
(database-identifier inner-name)))
;; dont know how to handle this really :/
(%sql-expression (flatten-id name))
)))
(defun %clsql-subclauses (clauses)
"a helper for dealing with lists of sql clauses"
(loop for c in clauses
when c
collect (typecase c
(string (clsql-sys:sql-expression :string c))
(T c))))
(defun clsql-ands (clauses)
"Correctly creates a sql 'and' expression for the clauses
ignores any nil clauses
returns a single child expression if there is only one
returns an 'and' expression if there are many
returns nil if there are no children"
(let ((ex (%clsql-subclauses clauses)))
(when ex
(case (length ex)
(1 (first ex))
(t (apply #'clsql-sys:sql-and ex))))))
(defun clsql-and (&rest clauses)
"Correctly creates a sql 'and' expression for the clauses
ignores any nil clauses
returns a single child expression if there is only one
returns an 'and' expression if there are many
returns nil if there are no children"
(clsql-ands clauses))
(defun clsql-ors (clauses)
"Correctly creates a sql 'or' expression for the clauses
ignores any nil clauses
returns a single child expression if there is only one
returns an 'or' expression if there are many
returns nil if there are no children"
(let ((ex (%clsql-subclauses clauses)))
(when ex
(case (length ex)
(1 (first ex))
(t (apply #'clsql-sys:sql-or ex))))))
(defun clsql-or (&rest clauses)
"Correctly creates a sql 'or' expression for the clauses
ignores any nil clauses
returns a single child expression if there is only one
returns an 'or' expression if there are many
returns nil if there are no children"
(clsql-ors clauses))
(defclass sql-escape-string-exp (%sql-expression)
((string
:initarg :string
:initform nil))
(:documentation
"An escaped string string expression (postgresql E'stuff') ."))
(defmethod output-sql ((exp sql-escape-string-exp) database)
(with-slots (string) exp
(when string
(write-char #\E *sql-stream*)
(output-sql string database))))
|