1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
3 ;;;; FILE IDENTIFICATION
5 ;;;; Name: sqlite-sql.lisp
6 ;;;; Purpose: High-level SQLite interface
7 ;;;; Authors: Aurelio Bignoli and Marcus Pearce
12 ;;;; This file, part of CLSQL, is Copyright (c) 2003 by Aurelio Bignoli and
15 ;;;; CLSQL users are granted the rights to distribute and use this software
16 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
17 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
18 ;;;; *************************************************************************
20 (in-package #:clsql-sqlite)
22 (defclass sqlite-database (database)
23 ((sqlite-db :initarg :sqlite-db :accessor sqlite-db)))
25 (defmethod database-type ((database sqlite-database))
28 (defmethod database-initialize-database-type ((database-type (eql :sqlite)))
31 (defun check-sqlite-connection-spec (connection-spec)
32 (check-connection-spec connection-spec :sqlite (name)))
34 (defmethod database-name-from-spec (connection-spec
35 (database-type (eql :sqlite)))
36 (check-sqlite-connection-spec connection-spec)
37 (first connection-spec))
39 (defmethod database-connect (connection-spec (database-type (eql :sqlite)))
40 (check-sqlite-connection-spec connection-spec)
42 (make-instance 'sqlite-database
43 :name (database-name-from-spec connection-spec :sqlite)
44 :database-type :sqlite
45 :connection-spec connection-spec
46 :sqlite-db (sqlite:sqlite-open (first connection-spec)))
47 (sqlite:sqlite-error (err)
48 (error 'clsql-connect-error
49 :database-type database-type
50 :connection-spec connection-spec
51 :errno (sqlite:sqlite-error-code err)
52 :error (sqlite:sqlite-error-message err)))))
54 (defmethod database-disconnect ((database sqlite-database))
55 (sqlite:sqlite-close (sqlite-db database))
56 (setf (sqlite-db database) nil)
59 (defmethod database-execute-command (sql-expression (database sqlite-database))
61 (multiple-value-bind (data row-n col-n)
62 (sqlite:sqlite-get-table (sqlite-db database) sql-expression)
63 #+clisp (declare (ignore data))
64 #-clisp (sqlite:sqlite-free-table data)
66 (error 'clsql-simple-warning
68 "Result set not empty: ~@(~A~) row~:P, ~@(~A~) column~:P "
69 :format-arguments (list row-n col-n))))
70 (sqlite:sqlite-error (err)
71 (error 'clsql-sql-error
73 :expression sql-expression
74 :errno (sqlite:sqlite-error-code err)
75 :error (sqlite:sqlite-error-message err))))
78 (defmethod database-query (query-expression (database sqlite-database) result-types field-names)
79 (declare (ignore result-types)) ; SQLite is typeless!
81 (multiple-value-bind (data row-n col-n)
82 (sqlite:sqlite-get-table (sqlite-db database) query-expression)
83 #-clisp (declare (type sqlite:sqlite-row-pointer-type data))
87 ;; The first col-n elements are column names.
89 (loop for i from col-n below (* (1+ row-n) col-n) by col-n
90 collect (loop for j from 0 below col-n
93 #-clisp sqlite:sqlite-aref
96 (loop for i from 0 below col-n
98 #-clisp sqlite:sqlite-aref
100 #-clisp (sqlite:sqlite-free-table data))
102 (sqlite:sqlite-error (err)
103 (error 'clsql-sql-error
105 :expression query-expression
106 :errno (sqlite:sqlite-error-code err)
107 :error (sqlite:sqlite-error-message err)))))
110 (defstruct sqlite-result-set
111 (vm (sqlite:make-null-vm)
112 :type sqlite:sqlite-vm-pointer)
113 (first-row (sqlite:make-null-row)
114 :type sqlite:sqlite-row-pointer-type)
115 (n-col 0 :type fixnum))
117 (defstruct sqlite-result-set
120 (n-col 0 :type fixnum))
122 (defmethod database-query-result-set
123 ((query-expression string) (database sqlite-database) &key full-set result-types)
124 (declare (ignore full-set result-types))
126 (let* ((vm (sqlite:sqlite-compile (sqlite-db database)
128 (result-set (make-sqlite-result-set :vm vm)))
129 #-clisp (declare (type sqlite:sqlite-vm-pointer vm))
131 ;;; To obtain column number we have to read the first row.
132 (multiple-value-bind (n-col cols col-names)
133 (sqlite:sqlite-step vm)
134 (declare (ignore col-names)
135 #-clisp (type sqlite:sqlite-row-pointer-type cols)
137 (setf (sqlite-result-set-first-row result-set) cols
138 (sqlite-result-set-n-col result-set) n-col)
139 (values result-set n-col nil)))
140 (sqlite:sqlite-error (err)
141 (error 'clsql-sql-error
143 :expression query-expression
144 :errno (sqlite:sqlite-error-code err)
145 :error (sqlite:sqlite-error-message err)))))
147 (defmethod database-dump-result-set (result-set (database sqlite-database))
149 (sqlite:sqlite-finalize (sqlite-result-set-vm result-set))
150 (sqlite:sqlite-error (err)
151 (error 'clsql-simple-error
152 :format-control "Error finalizing SQLite VM: ~A"
153 :format-arguments (list (sqlite:sqlite-error-message err))))))
155 (defmethod database-store-next-row (result-set (database sqlite-database) list)
156 (let ((n-col (sqlite-result-set-n-col result-set)))
160 (let ((row (sqlite-result-set-first-row result-set)))
161 (if (sqlite:null-row-p row)
162 ;; First row already used. fetch another row from DB.
164 (multiple-value-bind (n new-row col-names)
165 (sqlite:sqlite-step (sqlite-result-set-vm result-set))
166 (declare (ignore n col-names)
167 #-clisp (type sqlite:sqlite-row-pointer-type new-row)
169 (if (sqlite:null-row-p new-row)
170 (return-from database-store-next-row nil)
172 (sqlite:sqlite-error (err)
173 (error 'clsql-simple-error
174 :format-control "Error in sqlite-step: ~A"
176 (list (sqlite:sqlite-error-message err)))))
178 ;; Use the row previously read by database-query-result-set.
179 (setf (sqlite-result-set-first-row result-set)
180 (sqlite:make-null-row)))
181 (loop for i = 0 then (1+ i)
185 #-clisp sqlite:sqlite-aref
187 #-clisp (sqlite:sqlite-free-row row)
192 (defmethod database-list-tables ((database sqlite-database) &key owner)
193 (declare (ignore owner))
194 ;; Query is copied from .table command of sqlite comamnd line utility.
195 (remove-if #'(lambda (s)
196 (and (>= (length s) 11)
197 (string-equal (subseq s 0 11) "_CLSQL_SEQ_")))
198 (mapcar #'car (database-query
199 "SELECT name FROM sqlite_master WHERE type='table' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='table' ORDER BY name"
202 (defmethod database-list-views ((database sqlite-database)
204 (declare (ignore owner))
205 (mapcar #'car (database-query
206 "SELECT name FROM sqlite_master WHERE type='view' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='view' ORDER BY name"
209 (defmethod database-list-indexes ((database sqlite-database)
211 (declare (ignore owner))
212 (mapcar #'car (database-query
213 "SELECT name FROM sqlite_master WHERE type='index' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='index' ORDER BY name"
216 (defmethod database-list-table-indexes (table (database sqlite-database)
218 (declare (ignore owner))
219 (let ((*print-circle* nil))
224 "SELECT name FROM sqlite_master WHERE type='index' AND tbl_name='~A' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='index' AND tbl_name='~A' ORDER BY name"
228 (declaim (inline sqlite-table-info))
229 (defun sqlite-table-info (table database)
230 (database-query (format nil "PRAGMA table_info('~A')" table)
233 (defmethod database-list-attributes (table (database sqlite-database)
235 (declare (ignore owner))
236 (mapcar #'(lambda (table-info) (second table-info))
237 (sqlite-table-info table database)))
239 (defmethod database-attribute-type (attribute table
240 (database sqlite-database)
242 (declare (ignore owner))
243 (loop for field-info in (sqlite-table-info table database)
244 when (string= attribute (second field-info))
245 return (third field-info)))
247 (defun %sequence-name-to-table-name (sequence-name)
248 (concatenate 'string "_CLSQL_SEQ_" (sql-escape sequence-name)))
250 (defun %table-name-to-sequence-name (table-name)
251 (and (>= (length table-name) 11)
252 (string= (subseq table-name 0 11) "_CLSQL_SEQ_")
253 (subseq table-name 11)))
256 (defmethod database-create-sequence (sequence-name
257 (database sqlite-database))
258 (let ((table-name (%sequence-name-to-table-name sequence-name)))
259 (database-execute-command
260 (concatenate 'string "CREATE TABLE " table-name
261 " (last_value integer PRIMARY KEY, increment_by integer, min_value integer, is_called char(1))")
263 (database-execute-command
264 (concatenate 'string "INSERT INTO " table-name
265 " VALUES (1,1,1,'f')")
268 (defmethod database-drop-sequence (sequence-name
269 (database sqlite-database))
270 (database-execute-command
271 (concatenate 'string "DROP TABLE " (%sequence-name-to-table-name sequence-name))
274 (defmethod database-list-sequences ((database sqlite-database)
276 (declare (ignore owner))
277 (mapcan #'(lambda (s)
278 (let ((sn (%table-name-to-sequence-name (car s))))
281 "SELECT name FROM sqlite_master WHERE type='table' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='table' ORDER BY name"
284 (defmethod database-sequence-next (sequence-name (database sqlite-database))
286 (let* ((table-name (%sequence-name-to-table-name sequence-name))
289 (concatenate 'string "SELECT last_value,is_called FROM "
294 ((char-equal (schar (second tuple) 0) #\f)
295 (database-execute-command
296 (format nil "UPDATE ~A SET is_called='t'" table-name)
298 (parse-integer (car tuple)))
300 (let ((new-pos (1+ (parse-integer (car tuple)))))
301 (database-execute-command
302 (format nil "UPDATE ~A SET last_value=~D" table-name new-pos)
306 (defmethod database-sequence-last (sequence-name (database sqlite-database))
309 (caar (database-query
310 (concatenate 'string "SELECT last_value FROM "
311 (%sequence-name-to-table-name sequence-name))
315 (defmethod database-set-sequence-position (sequence-name
317 (database sqlite-database))
318 (database-execute-command
319 (format nil "UPDATE ~A SET last_value=~A,is_called='t'"
320 (%sequence-name-to-table-name sequence-name)
325 (defmethod database-create (connection-spec (type (eql :sqlite)))
326 (declare (ignore connection-spec))
327 ;; databases are created automatically by SQLite
330 (defmethod database-destroy (connection-spec (type (eql :sqlite)))
331 (destructuring-bind (name) connection-spec
332 (if (probe-file name)
336 (defmethod database-probe (connection-spec (type (eql :sqlite)))
337 (destructuring-bind (name) connection-spec
338 ;; TODO: Add a test that this file is a real sqlite database
339 (or (string-equal ":memory:" name)
340 (and (probe-file name) t))))
342 ;;; Database capabilities
344 (defmethod db-type-has-boolean-where? ((db-type (eql :sqlite)))