dbe3a0b36ed7cb71689c9e654371cdfa5e43518d
[clsql.git] / sql / operations.lisp
1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
3 ;;;;
4 ;;;; $Id$
5 ;;;;
6 ;;;; Definition of SQL operations used with the symbolic SQL syntax.
7 ;;;;
8 ;;;; This file is part of CLSQL.
9 ;;;;
10 ;;;; CLSQL users are granted the rights to distribute and use this software
11 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
12 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
13 ;;;; *************************************************************************
14
15 (in-package #:clsql-sys)
16
17 ;; Keep a hashtable for mapping symbols to sql generator functions,
18 ;; for use by the bracketed reader syntax.
19
20 (defvar *sql-op-table* (make-hash-table :test #'equal))
21
22
23 ;; Define an SQL operation type.
24
25 (defmacro defsql (function definition-keys &body body)
26   `(progn
27      (defun ,function ,@body)
28      (let ((symbol (cadr (member :symbol ',definition-keys))))
29        (setf (gethash (if symbol (symbol-name-default-case symbol) ',function)
30                       *sql-op-table*)
31              ',function))))
32
33
34 ;; SQL operations
35
36 (defsql sql-query (:symbol "select") (&rest args)
37   (apply #'make-query args))
38
39 (defsql sql-any (:symbol "any") (&rest rest)
40   (make-instance 'sql-function-exp
41                  :name 'any :args rest))
42
43 (defsql sql-some (:symbol "some") (&rest rest)
44   (make-instance 'sql-function-exp
45                  :name 'some :args rest))
46
47 (defsql sql-all (:symbol "all") (&rest rest)
48   (make-instance 'sql-function-exp
49                  :name 'all :args rest))
50
51 (defsql sql-not (:symbol "not") (&rest rest)
52   (make-instance 'sql-value-exp
53                  :modifier 'not :components rest))
54
55 (defsql sql-union (:symbol "union") (&rest rest)
56   (make-instance 'sql-set-exp
57                  :operator 'union :sub-expressions rest))
58
59 (defsql sql-intersect (:symbol "intersect") (&rest rest)
60   (make-instance 'sql-set-exp
61                  :operator 'intersect :sub-expressions rest))
62
63 (defsql sql-except (:symbol "except") (&rest rest)
64   (make-instance 'sql-set-exp
65                  :operator 'except :sub-expressions rest))
66
67 (defsql sql-minus (:symbol "minus") (&rest rest)
68   (make-instance 'sql-set-exp
69                  :operator 'minus :sub-expressions rest))
70
71 (defsql sql-limit (:symbol "limit") (&rest rest)
72   (make-instance 'sql-query-modifier-exp
73                  :modifier 'limit :components rest))
74
75 (defsql sql-group-by (:symbol "group-by") (&rest rest)
76   (make-instance 'sql-query-modifier-exp
77                  :modifier '|GROUP BY| :components rest))
78
79 (defsql sql-order-by (:symbol "order-by") (&rest rest)
80   (make-instance 'sql-query-modifier-exp
81                  :modifier '|ORDER BY| :components rest))
82
83 (defsql sql-having (:symbol "having") (&rest rest)
84   (make-instance 'sql-query-modifier-exp
85                  :modifier 'having :components rest))
86
87 (defsql sql-null (:symbol "null") (&rest rest)
88   (if rest
89       (make-instance 'sql-relational-exp :operator 'is
90                      :sub-expressions (list (car rest) nil))
91       (make-instance 'sql-value-exp :components 'null)))
92
93 (defsql sql-not-null (:symbol "not-null") ()
94   (make-instance 'sql-value-exp
95                  :components '|NOT NULL|))
96
97 (defsql sql-exists (:symbol "exists") (&rest rest)
98   (make-instance 'sql-function-exp
99                  :name 'exists :args rest))
100
101 (defsql sql-* (:symbol "*") (&rest rest)
102   (if (zerop (length rest))
103       (make-instance 'sql-ident :name '*)
104       (make-instance 'sql-relational-exp :operator '* :sub-expressions rest)))
105
106 (defsql sql-+ (:symbol "+") (&rest rest)
107   (if (cdr rest)
108       (make-instance 'sql-relational-exp
109                      :operator '+ :sub-expressions rest)
110       (make-instance 'sql-value-exp :modifier '+ :components rest)))
111
112 (defsql sql-/ (:symbol "/") (&rest rest)
113   (make-instance 'sql-relational-exp
114                  :operator '/ :sub-expressions rest))
115
116 (defsql sql-- (:symbol "-") (&rest rest)
117         (if (cdr rest)
118             (make-instance 'sql-relational-exp
119                            :operator '- :sub-expressions rest)
120             (make-instance 'sql-value-exp :modifier '- :components rest)))
121
122 (defsql sql-like (:symbol "like") (&rest rest)
123   (make-instance 'sql-relational-exp
124                  :operator 'like :sub-expressions rest))
125
126 (defsql sql-~* (:symbol "~*") (&rest rest)
127         "This is the postgres regex match operator"
128   (make-instance 'sql-relational-exp
129                  :operator '~* :sub-expressions rest))
130
131 (defsql sql-uplike (:symbol "uplike") (&rest rest)
132   (make-instance 'sql-upcase-like
133                  :sub-expressions rest))
134
135 (defsql sql-and (:symbol "and") (&rest rest)
136   (make-instance 'sql-relational-exp
137                  :operator 'and :sub-expressions rest))
138
139 (defsql sql-or (:symbol "or") (&rest rest)
140   (make-instance 'sql-relational-exp
141                  :operator 'or :sub-expressions rest))
142
143 (defsql sql-in (:symbol "in") (&rest rest)
144   (make-instance 'sql-relational-exp
145                  :operator 'in :sub-expressions rest))
146
147 (defsql sql-concat-op (:symbol "concat-op") (&rest rest)
148   (make-instance 'sql-relational-exp
149                  :operator '\|\| :sub-expressions rest))
150
151 (defsql sql-concat (:symbol "concat") (&rest rest)
152   (make-instance 'sql-function-exp
153                  :name 'concat :args rest))
154
155 (defsql sql-substr (:symbol "substr") (&rest rest)
156   (if (= (length rest) 3)
157       (make-instance 'sql-function-exp
158                      :name 'substr :args rest)
159       (error 'sql-user-error :message "SUBSTR must have 3 arguments.")))
160
161 (defsql sql-substring (:symbol "substring") (&rest rest)
162   (if (= (length rest) 3)
163       (make-instance 'sql-function-exp
164                      :name 'substring :args rest)
165       (error 'sql-user-error :message "SUBSTRING must have 3 arguments.")))
166
167 (defsql sql-is (:symbol "is") (&rest rest)
168   (make-instance 'sql-relational-exp
169                  :operator 'is :sub-expressions rest))
170
171 (defsql sql-= (:symbol "=") (&rest rest)
172   (make-instance 'sql-relational-exp
173                  :operator '= :sub-expressions rest))
174
175 (defsql sql-== (:symbol "==") (&rest rest)
176   (make-instance 'sql-assignment-exp
177                  :operator '= :sub-expressions rest))
178
179 (defsql sql-< (:symbol "<") (&rest rest)
180   (make-instance 'sql-relational-exp
181                  :operator '< :sub-expressions rest))
182
183
184 (defsql sql-> (:symbol ">") (&rest rest)
185   (make-instance 'sql-relational-exp
186                  :operator '> :sub-expressions rest))
187
188 (defsql sql-<> (:symbol "<>") (&rest rest)
189         (make-instance 'sql-relational-exp
190                        :operator '<> :sub-expressions rest))
191
192 (defsql sql->= (:symbol ">=") (&rest rest)
193   (make-instance 'sql-relational-exp
194                  :operator '>= :sub-expressions rest))
195
196 (defsql sql-<= (:symbol "<=") (&rest rest)
197   (make-instance 'sql-relational-exp
198                  :operator '<= :sub-expressions rest))
199
200 (defsql sql-count (:symbol "count") (&rest rest)
201   (make-instance 'sql-function-exp
202                  :name 'count :args rest))
203
204 (defsql sql-max (:symbol "max") (&rest rest)
205   (make-instance 'sql-function-exp
206                  :name 'max :args rest))
207
208 (defsql sql-min (:symbol "min") (&rest rest)
209   (make-instance 'sql-function-exp
210                  :name 'min :args rest))
211
212 (defsql sql-avg (:symbol "avg") (&rest rest)
213   (make-instance 'sql-function-exp
214                  :name 'avg :args rest))
215
216 (defsql sql-sum (:symbol "sum") (&rest rest)
217   (make-instance 'sql-function-exp
218                  :name 'sum :args rest))
219
220 (defsql sql-the (:symbol "the") (&rest rest)
221   (make-instance 'sql-typecast-exp
222                  :modifier (first rest) :components (second rest)))
223
224 (defsql sql-function (:symbol "function") (&rest args)
225         (make-instance 'sql-function-exp
226                        :name (make-symbol (car args)) :args (cdr args)))
227
228 (defsql sql-between (:symbol "between") (&rest rest)
229   (if (= (length rest) 3)
230       (make-instance 'sql-between-exp :name 'between :args rest)
231       (error 'sql-user-error :message "BETWEEN must have 3 arguments.")))
232
233 (defsql sql-distinct (:symbol "distinct") (&rest rest)
234   (make-instance 'sql-query-modifier-exp :modifier 'distinct
235                  :components rest))
236
237 (defsql sql-coalesce (:symbol "coalesce") (&rest rest)
238   (make-instance 'sql-function-exp
239                  :name 'coalesce :args rest))
240
241 (defsql sql-nvl (:symbol "nvl") (&rest rest)
242   (if (= (length rest) 2)
243       (make-instance 'sql-function-exp
244                      :name 'coalesce :args rest)
245       (error 'sql-user-error :message "NVL accepts exactly 2 arguments.")))
246
247 (defsql sql-userenv (:symbol "userenv") (&rest rest)
248   (make-instance 'sql-function-exp
249                  :name 'userenv :args rest))
250
251 (defsql sql-lower  (:symbol "lower") (&rest rest)
252   (if (= (length rest) 1)
253       (make-instance 'sql-function-exp
254                      :name 'lower :args rest)
255     (error 'sql-user-error :message "LOWER must have 1 argument.")))
256
257 (defsql sql-upper  (:symbol "upper") (&rest rest)
258   (if (= (length rest) 1)
259       (make-instance 'sql-function-exp
260                      :name 'upper :args rest)
261     (error 'sql-user-error :message "UPPER must have 1 argument.")))