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)
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.
88 (loop for i from col-n below (* (1+ row-n) col-n) by col-n
89 collect (loop for j from 0 below col-n
92 #-clisp sqlite:sqlite-aref
94 #-clisp (sqlite:sqlite-free-table data))
96 (sqlite:sqlite-error (err)
97 (error 'clsql-sql-error
99 :expression query-expression
100 :errno (sqlite:sqlite-error-code err)
101 :error (sqlite:sqlite-error-message err)))))
104 (defstruct sqlite-result-set
105 (vm (sqlite:make-null-vm)
106 :type sqlite:sqlite-vm-pointer)
107 (first-row (sqlite:make-null-row)
108 :type sqlite:sqlite-row-pointer-type)
109 (n-col 0 :type fixnum))
111 (defstruct sqlite-result-set
114 (n-col 0 :type fixnum))
116 (defmethod database-query-result-set
117 ((query-expression string) (database sqlite-database) &key full-set result-types)
118 (declare (ignore full-set result-types))
120 (let* ((vm (sqlite:sqlite-compile (sqlite-db database)
122 (result-set (make-sqlite-result-set :vm vm)))
123 #-clisp (declare (type sqlite:sqlite-vm-pointer vm))
125 ;;; To obtain column number we have to read the first row.
126 (multiple-value-bind (n-col cols col-names)
127 (sqlite:sqlite-step vm)
128 (declare (ignore col-names)
129 #-clisp (type sqlite:sqlite-row-pointer-type cols)
131 (setf (sqlite-result-set-first-row result-set) cols
132 (sqlite-result-set-n-col result-set) n-col)
133 (values result-set n-col nil)))
134 (sqlite:sqlite-error (err)
135 (error 'clsql-sql-error
137 :expression query-expression
138 :errno (sqlite:sqlite-error-code err)
139 :error (sqlite:sqlite-error-message err)))))
141 (defmethod database-dump-result-set (result-set (database sqlite-database))
143 (sqlite:sqlite-finalize (sqlite-result-set-vm result-set))
144 (sqlite:sqlite-error (err)
145 (error 'clsql-simple-error
146 :format-control "Error finalizing SQLite VM: ~A"
147 :format-arguments (list (sqlite:sqlite-error-message err))))))
149 (defmethod database-store-next-row (result-set (database sqlite-database) list)
150 (let ((n-col (sqlite-result-set-n-col result-set)))
154 (let ((row (sqlite-result-set-first-row result-set)))
155 (if (sqlite:null-row-p row)
156 ;; First row already used. fetch another row from DB.
158 (multiple-value-bind (n new-row col-names)
159 (sqlite:sqlite-step (sqlite-result-set-vm result-set))
160 (declare (ignore n col-names)
161 #-clisp (type sqlite:sqlite-row-pointer-type new-row)
163 (if (sqlite:null-row-p new-row)
164 (return-from database-store-next-row nil)
166 (sqlite:sqlite-error (err)
167 (error 'clsql-simple-error
168 :format-control "Error in sqlite-step: ~A"
170 (list (sqlite:sqlite-error-message err)))))
172 ;; Use the row previously read by database-query-result-set.
173 (setf (sqlite-result-set-first-row result-set)
174 (sqlite:make-null-row)))
175 (loop for i = 0 then (1+ i)
179 #-clisp sqlite:sqlite-aref
181 #-clisp (sqlite:sqlite-free-row row)
186 (defmethod database-list-tables ((database sqlite-database) &key owner)
187 (declare (ignore owner))
188 ;; Query is copied from .table command of sqlite comamnd line utility.
189 (remove-if #'(lambda (s)
190 (and (>= (length s) 11)
191 (string= (subseq s 0 11) "_clsql_seq_")))
192 (mapcar #'car (database-query
193 "SELECT name FROM sqlite_master WHERE type='table' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='table' ORDER BY name"
196 (defmethod database-list-views ((database sqlite-database)
198 (declare (ignore owner))
199 (mapcar #'car (database-query
200 "SELECT name FROM sqlite_master WHERE type='view' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='view' ORDER BY name"
203 (defmethod database-list-indexes ((database sqlite-database)
205 (declare (ignore owner))
206 (mapcar #'car (database-query
207 "SELECT name FROM sqlite_master WHERE type='index' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='index' ORDER BY name"
210 (declaim (inline sqlite-table-info))
211 (defun sqlite-table-info (table database)
212 (database-query (format nil "PRAGMA table_info('~A')" table)
215 (defmethod database-list-attributes (table (database sqlite-database)
217 (declare (ignore owner))
218 (mapcar #'(lambda (table-info) (second table-info))
219 (sqlite-table-info table database)))
221 (defmethod database-attribute-type (attribute table
222 (database sqlite-database)
224 (declare (ignore owner))
225 (loop for field-info in (sqlite-table-info table database)
226 when (string= attribute (second field-info))
227 return (third field-info)))
229 (defun %sequence-name-to-table-name (sequence-name)
230 (concatenate 'string "_clsql_seq_" (sql-escape sequence-name)))
232 (defun %table-name-to-sequence-name (table-name)
233 (and (>= (length table-name) 11)
234 (string= (subseq table-name 0 11) "_clsql_seq_")
235 (subseq table-name 11)))
237 (defmethod database-create-sequence (sequence-name
238 (database sqlite-database))
239 (let ((table-name (%sequence-name-to-table-name sequence-name)))
240 (database-execute-command
241 (concatenate 'string "CREATE TABLE " table-name
242 " (id INTEGER PRIMARY KEY)")
244 (database-execute-command
245 (format nil "INSERT INTO ~A VALUES (-1)" table-name)
248 (defmethod database-drop-sequence (sequence-name
249 (database sqlite-database))
250 (database-execute-command
251 (concatenate 'string "DROP TABLE "
252 (%sequence-name-to-table-name sequence-name))
255 (defmethod database-list-sequences ((database sqlite-database)
257 (declare (ignore owner))
258 (mapcan #'(lambda (s)
259 (let ((sn (%table-name-to-sequence-name (car s))))
262 "SELECT name FROM sqlite_master WHERE type='table' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='table' ORDER BY name"
265 (defmethod database-sequence-next (sequence-name (database sqlite-database))
266 (let ((table-name (%sequence-name-to-table-name sequence-name)))
267 (database-execute-command
268 (format nil "UPDATE ~A SET id=(SELECT id FROM ~A)+1"
269 table-name table-name)
271 (sqlite:sqlite-last-insert-rowid (sqlite-db database))
273 (caar (database-query (format nil "SELECT id from ~A" table-name)
276 (defmethod database-set-sequence-position (sequence-name
278 (database sqlite-database))
279 (let ((table-name (%sequence-name-to-table-name sequence-name)))
280 (database-execute-command
281 (format nil "UPDATE ~A SET id=~A" table-name position)
283 (sqlite:sqlite-last-insert-rowid (sqlite-db database))))
285 (defmethod database-sequence-last (sequence-name (database sqlite-database))
286 (declare (ignore sequence-name)))
288 (defmethod database-create (connection-spec (type (eql :sqlite)))
289 (declare (ignore connection-spec))
290 ;; databases are created automatically by SQLite
293 (defmethod database-destroy (connection-spec (type (eql :sqlite)))
294 (destructuring-bind (name) connection-spec
295 (if (probe-file name)
299 (defmethod database-probe (connection-spec (type (eql :sqlite)))
300 (destructuring-bind (name) connection-spec
301 ;; TODO: Add a test that this file is a real sqlite database
302 (and (probe-file name) t)))