1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
4 ;;;; Generic ODBC layer, used by db-odbc and db-aodbc backends
6 ;;;; This file is part of CLSQL.
8 ;;;; CLSQL users are granted the rights to distribute and use this software
9 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
10 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
11 ;;;; *************************************************************************
13 (in-package #:clsql-sys)
15 (defclass generic-odbc-database (database)
16 ((dbi-package :initarg :dbi-package :reader dbi-package)
17 (odbc-conn :initarg :odbc-conn :initform nil :accessor odbc-conn)
18 (disconnect-fn :reader disconnect-fn)
19 (sql-fn :reader sql-fn)
20 (close-query-fn :reader close-query-fn)
21 (fetch-row :reader fetch-row-fn)
22 (list-all-database-tables-fn :reader list-all-database-tables-fn)
23 (list-all-table-columns-fn :reader list-all-table-columns-fn))
24 (:documentation "Encapsulate same behavior across odbc and aodbc backends."))
26 (defmethod initialize-instance :after ((db generic-odbc-database)
28 (declare (ignore all-keys))
29 (unless (slot-boundp db 'dbi-package)
30 (error "dbi-package not specified."))
31 (let ((pkg (slot-value db 'dbi-package)))
33 (error "dbi-package is nil."))
34 (setf (slot-value db 'disconnect-fn)
35 (intern (symbol-name '#:disconnect) pkg)
36 (slot-value db 'sql-fn)
37 (intern (symbol-name '#:sql) pkg)
38 (slot-value db 'close-query-fn)
39 (intern (symbol-name '#:close-query) pkg)
40 (slot-value db 'fetch-row)
41 (intern (symbol-name '#:fetch-row) pkg)
42 (slot-value db 'list-all-database-tables-fn)
43 (intern (symbol-name '#:list-all-database-tables) pkg)
44 (slot-value db 'list-all-table-columns-fn)
45 (intern (symbol-name '#:list-all-table-columns) pkg))))
49 (defmethod read-sql-value (val (type (eql 'boolean))
50 (database generic-odbc-database)
51 (db-type (eql :postgresql)))
52 (if (string= "0" val) nil t))
54 (defmethod read-sql-value (val (type (eql 'generalized-boolean))
55 (database generic-odbc-database)
56 (db-type (eql :postgresql)))
57 (if (string= "0" val) nil t))
59 (defmethod read-sql-value (val (type (eql 'boolean)) database
60 (db-type (eql :mssql)))
61 (declare (ignore database))
63 (string (if (string= "0" val) nil t))
64 (integer (if (zerop val) nil t))))
66 (defmethod read-sql-value (val (type (eql 'generalized-boolean)) database
67 (db-type (eql :mssql)))
68 (declare (ignore database))
70 (string (if (string= "0" val) nil t))
71 (integer (if (zerop val) nil t))))
75 (defmethod database-get-type-specifier ((type (eql 'wall-time)) args database
76 (db-type (eql :mssql)))
77 (declare (ignore args database))
80 (defmethod database-get-type-specifier ((type (eql 'date)) args database
81 (db-type (eql :mssql)))
82 (declare (ignore args database))
85 (defmethod database-get-type-specifier ((type (eql 'boolean)) args database
86 (db-type (eql :mssql)))
87 (declare (ignore args database))
90 (defmethod database-get-type-specifier ((type (eql 'generalized-boolean)) args database
91 (db-type (eql :mssql)))
92 (declare (ignore args database))
95 ;;; Generation of SQL strings from lisp expressions
97 (defmethod database-output-sql ((tee (eql t)) (database generic-odbc-database))
98 (case (database-underlying-type database)
102 (defmethod database-output-sql-as-type ((type (eql 'boolean)) val database
103 (db-type (eql :mssql)))
104 (declare (ignore database))
107 (defmethod database-output-sql-as-type ((type (eql 'generalized-boolean)) val database
108 (db-type (eql :mssql)))
109 (declare (ignore database))
112 ;;; Database backend capabilities
114 (defmethod db-type-use-fully-qualified-column-on-drop-index? ((db-type (eql :mssql)))
117 (defmethod db-type-has-boolean-where? ((db-type (eql :mssql)))
120 (defmethod db-type-has-intersect? ((db-type (eql :mssql)))
123 (defmethod db-type-has-except? ((db-type (eql :mssql)))
128 (defmethod database-disconnect ((database generic-odbc-database))
129 (funcall (disconnect-fn database) (odbc-conn database))
130 (setf (odbc-conn database) nil)
133 (defmethod database-query (query-expression (database generic-odbc-database)
134 result-types field-names)
136 (funcall (sql-fn database)
137 query-expression :db (odbc-conn database)
138 :result-types result-types
139 :column-names field-names)
142 (error 'sql-database-data-error
144 :expression query-expression
145 :message "Query failed"))))
148 (defmethod database-execute-command (sql-expression (database generic-odbc-database))
150 (funcall (sql-fn database)
151 sql-expression :db (odbc-conn database))
157 (error 'sql-database-data-error
159 :expression sql-expression
160 :message "Execute command failed"))))
163 (defstruct odbc-result-set
166 (full-set nil :type boolean))
171 (defmethod database-query-result-set ((query-expression string)
172 (database generic-odbc-database)
173 &key full-set result-types)
175 (multiple-value-bind (query column-names)
176 (funcall (sql-fn database)
178 :db (odbc-conn database)
182 :result-types result-types)
184 (make-odbc-result-set :query query :full-set full-set
186 (length column-names)
187 nil ;; not able to return number of rows with odbc
190 (error 'sql-database-data-error
192 :expression query-expression
193 :message "Query result set failed"))))
195 (defmethod database-dump-result-set (result-set (database generic-odbc-database))
196 (funcall (close-query-fn database) (odbc-result-set-query result-set))
199 (defmethod database-store-next-row (result-set
200 (database generic-odbc-database)
202 (let ((row (funcall (fetch-row-fn database)
203 (odbc-result-set-query result-set) nil 'eof)))
207 (loop for elem in row
210 (setf (car rest) elem))
214 (defun %database-list-* (database type owner)
215 "Internal function used by database-list-tables and
217 (multiple-value-bind (rows col-names)
218 (funcall (list-all-database-tables-fn database) :db (odbc-conn database))
219 (declare (ignore col-names))
220 ;; http://msdn.microsoft.com/en-us/library/ms711831%28VS.85%29.aspx
221 ;; TABLE_SCHEM is hard-coded in second column by ODBC Driver Manager
222 ;; TABLE_NAME in third column, TABLE_TYPE in fourth column
223 (loop for (category schema name ttype . rest) in rows
224 when (and (string-equal type ttype)
225 (or (null owner) (string-equal owner schema))
226 ;; unless requesting by name, skip system schema
227 (not (and (null owner)
228 (member schema '("information_schema" "sys")
229 :test #'string-equal)))
230 ;; skip system specific tables in mssql2000
231 (not (and (eql :mssql (database-underlying-type database))
232 (member name '("dtproperties" "sysconstraints"
234 :test #'string-equal))))
237 (defmethod database-list-tables ((database generic-odbc-database)
239 "Since ODBC doesn't expose the owner we use that parameter to filter
240 on schema since that's what tends to be exposed. Some DBs like mssql
241 2000 conflate the two so at least there it works nicely."
242 (%database-list-* database "TABLE" owner))
245 (defmethod database-list-views ((database generic-odbc-database)
247 "Since ODBC doesn't expose the owner we use that parameter to filter
248 on schema since that's what tends to be exposed. Some DBs like mssql
249 2000 conflate the two so at least there it works nicely."
250 (%database-list-* database "VIEW" owner))
253 (defmethod database-list-attributes ((table %database-identifier) (database generic-odbc-database)
255 &aux (table (unescaped-database-identifier table)))
256 (declare (ignore owner))
257 (multiple-value-bind (rows col-names)
258 (funcall (list-all-table-columns-fn database) table
259 :db (odbc-conn database))
260 (declare (ignore col-names))
261 ;; COLUMN_NAME is hard-coded by odbc spec as fourth position
262 (loop for row in rows
263 collect (fourth row))))
265 (defmethod database-attribute-type ((attribute %database-identifier) (table %database-identifier)
266 (database generic-odbc-database)
268 &aux (table (unescaped-database-identifier table))
269 (attribute (unescaped-database-identifier attribute)))
270 (declare (ignore owner))
271 (multiple-value-bind (rows col-names)
272 (funcall (list-all-table-columns-fn database) table
273 :db (odbc-conn database))
274 (declare (ignore col-names))
275 ;; COLUMN_NAME is hard-coded by odbc spec as fourth position
276 ;; TYPE_NAME is the sixth column
277 ;; PRECISION/COLUMN_SIZE is the seventh column
278 ;; SCALE/DECIMAL_DIGITS is the ninth column
279 ;; NULLABLE is the eleventh column
280 (loop for row in rows
281 when (string-equal attribute (fourth row))
283 (let ((size (seventh row))
284 (precision (ninth row))
285 (scale (nth 10 row)))
286 (return (values (ensure-keyword (sixth row))
287 (when size (parse-integer size))
288 (when precision (parse-integer precision))
289 (when scale (parse-integer scale))))))))