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, Kevin Rosenberg, Marcus Pearce
12 ;;;; This file, part of CLSQL, is Copyright (c) 2003 by Aurelio Bignoli and
13 ;;;; Copyright (c) 2003-2004 by Kevin Rosenberg and Marcus Pearce.
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 (sqlite:sqlite-free-table data)
65 (error 'clsql-simple-warning
67 "Result set not empty: ~@(~A~) row~:P, ~@(~A~) column~:P "
68 :format-arguments (list row-n col-n))))
69 (sqlite:sqlite-error (err)
70 (error 'clsql-sql-error
72 :expression sql-expression
73 :errno (sqlite:sqlite-error-code err)
74 :error (sqlite:sqlite-error-message err))))
77 (defstruct sqlite-result-set
78 (vm (sqlite:make-null-vm)
80 #-clisp sqlite:sqlite-vm-pointer)
81 (first-row (sqlite:make-null-row)
83 #-clisp sqlite:sqlite-row-pointer-type)
84 (col-names (sqlite:make-null-row)
86 #-clisp sqlite:sqlite-row-pointer-type)
88 (n-col 0 :type fixnum))
90 (defmethod database-query (query-expression (database sqlite-database) result-types field-names)
91 (declare (optimize (speed 3) (safety 0) (debug 0) (space 0)))
93 (multiple-value-bind (result-set n-col)
94 (database-query-result-set query-expression database
95 :result-types result-types
98 (col-names (when field-names
99 (loop for j from 0 below n-col
100 collect (sqlite:sqlite-aref (sqlite-result-set-col-names result-set) j))))
101 (new-row (make-list n-col) (make-list n-col))
102 (row-ok (database-store-next-row result-set database new-row)
103 (database-store-next-row result-set database new-row)))
105 (values (nreverse rows) col-names))
106 (push new-row rows)))
107 (sqlite:sqlite-error (err)
108 (error 'clsql-sql-error
110 :expression query-expression
111 :errno (sqlite:sqlite-error-code err)
112 :error (sqlite:sqlite-error-message err)))))
114 (defmethod database-query-result-set ((query-expression string)
115 (database sqlite-database)
116 &key result-types full-set)
118 (let ((vm (sqlite:sqlite-compile (sqlite-db database)
120 ;;; To obtain column number/datatypes we have to read the first row.
121 (multiple-value-bind (n-col cols col-names)
122 (sqlite:sqlite-step vm)
123 (let ((result-set (make-sqlite-result-set
129 (canonicalize-result-types
134 (values result-set n-col nil)
135 (values result-set n-col)))))
136 (sqlite:sqlite-error (err)
137 (error 'clsql-sql-error
139 :expression query-expression
140 :errno (sqlite:sqlite-error-code err)
141 :error (sqlite:sqlite-error-message err)))))
143 (defun canonicalize-result-types (result-types n-col col-names)
145 (let ((raw-types (if (eq :auto result-types)
146 (loop for j from n-col below (* 2 n-col)
147 collect (ensure-keyword (sqlite:sqlite-aref col-names j)))
149 (loop for type in raw-types
152 ((:int :integer :tinyint :long :bigint)
161 (defmethod database-dump-result-set (result-set (database sqlite-database))
163 (sqlite:sqlite-finalize (sqlite-result-set-vm result-set))
164 (sqlite:sqlite-error (err)
165 (error 'clsql-simple-error
166 :format-control "Error finalizing SQLite VM: ~A"
167 :format-arguments (list (sqlite:sqlite-error-message err))))))
169 (defmethod database-store-next-row (result-set (database sqlite-database) list)
170 (let ((n-col (sqlite-result-set-n-col result-set))
171 (result-types (sqlite-result-set-result-types result-set)))
175 (let ((row (sqlite-result-set-first-row result-set)))
176 (if (sqlite:null-row-p row)
177 ;; First row already used. fetch another row from DB.
179 (multiple-value-bind (n new-row col-names)
180 (sqlite:sqlite-step (sqlite-result-set-vm result-set))
181 (declare (ignore n col-names)
182 #-clisp (type sqlite:sqlite-row-pointer-type new-row))
183 (if (sqlite:null-row-p new-row)
184 (return-from database-store-next-row nil)
186 (sqlite:sqlite-error (err)
187 (error 'clsql-simple-error
188 :format-control "Error in sqlite-step: ~A"
190 (list (sqlite:sqlite-error-message err)))))
192 ;; Use the row previously read by database-query-result-set.
193 (setf (sqlite-result-set-first-row result-set)
194 (sqlite:make-null-row)))
195 (loop for i = 0 then (1+ i)
199 (clsql-uffi:convert-raw-field
201 (uffi:deref-pointer row 'sqlite:sqlite-row-pointer) '(:array (* :unsigned-char)) i)
205 (let ((type (if result-types
208 (val (sqlite:sqlite-aref row i)))
213 (when val (parse-integer val)))
215 (read-from-string val))
219 (read-from-string val)
221 (sqlite:sqlite-free-row row)
226 (defmethod database-list-tables ((database sqlite-database) &key owner)
227 (declare (ignore owner))
228 ;; Query is copied from .table command of sqlite comamnd line utility.
229 (remove-if #'(lambda (s)
230 (and (>= (length s) 11)
231 (string-equal (subseq s 0 11) "_CLSQL_SEQ_")))
232 (mapcar #'car (database-query
233 "SELECT name FROM sqlite_master WHERE type='table' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='table' ORDER BY name"
236 (defmethod database-list-views ((database sqlite-database)
238 (declare (ignore owner))
239 (mapcar #'car (database-query
240 "SELECT name FROM sqlite_master WHERE type='view' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='view' ORDER BY name"
243 (defmethod database-list-indexes ((database sqlite-database)
245 (declare (ignore owner))
246 (mapcar #'car (database-query
247 "SELECT name FROM sqlite_master WHERE type='index' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='index' ORDER BY name"
250 (defmethod database-list-table-indexes (table (database sqlite-database)
252 (declare (ignore owner))
253 (let ((*print-circle* nil))
258 "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"
262 (declaim (inline sqlite-table-info))
263 (defun sqlite-table-info (table database)
264 (database-query (format nil "PRAGMA table_info('~A')" table)
267 (defmethod database-list-attributes (table (database sqlite-database)
269 (declare (ignore owner))
270 (mapcar #'(lambda (table-info) (second table-info))
271 (sqlite-table-info table database)))
273 (defmethod database-attribute-type (attribute table
274 (database sqlite-database)
276 (declare (ignore owner))
277 (loop for field-info in (sqlite-table-info table database)
278 when (string= attribute (second field-info))
280 (let* ((raw-type (third field-info))
281 (start-length (position #\( raw-type))
282 (type (if start-length
283 (subseq raw-type 0 start-length)
285 (length (if start-length
286 (parse-integer (subseq raw-type (1+ start-length))
289 (values (when type (ensure-keyword type))
292 (if (string-equal (fourth field-info) "0")
295 (defun %sequence-name-to-table-name (sequence-name)
296 (concatenate 'string "_CLSQL_SEQ_" (sql-escape sequence-name)))
298 (defun %table-name-to-sequence-name (table-name)
299 (and (>= (length table-name) 11)
300 (string= (subseq table-name 0 11) "_CLSQL_SEQ_")
301 (subseq table-name 11)))
304 (defmethod database-create-sequence (sequence-name
305 (database sqlite-database))
306 (let ((table-name (%sequence-name-to-table-name sequence-name)))
307 (database-execute-command
308 (concatenate 'string "CREATE TABLE " table-name
309 " (last_value integer PRIMARY KEY, increment_by integer, min_value integer, is_called char(1))")
311 (database-execute-command
312 (concatenate 'string "INSERT INTO " table-name
313 " VALUES (1,1,1,'f')")
316 (defmethod database-drop-sequence (sequence-name
317 (database sqlite-database))
318 (database-execute-command
319 (concatenate 'string "DROP TABLE " (%sequence-name-to-table-name sequence-name))
322 (defmethod database-list-sequences ((database sqlite-database)
324 (declare (ignore owner))
325 (mapcan #'(lambda (s)
326 (let ((sn (%table-name-to-sequence-name (car s))))
329 "SELECT name FROM sqlite_master WHERE type='table' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='table' ORDER BY name"
332 (defmethod database-sequence-next (sequence-name (database sqlite-database))
334 (let* ((table-name (%sequence-name-to-table-name sequence-name))
337 (concatenate 'string "SELECT last_value,is_called FROM "
339 database :auto nil))))
341 ((char-equal (schar (second tuple) 0) #\f)
342 (database-execute-command
343 (format nil "UPDATE ~A SET is_called='t'" table-name)
347 (let ((new-pos (1+ (car tuple))))
348 (database-execute-command
349 (format nil "UPDATE ~A SET last_value=~D" table-name new-pos)
353 (defmethod database-sequence-last (sequence-name (database sqlite-database))
355 (caar (database-query
356 (concatenate 'string "SELECT last_value FROM "
357 (%sequence-name-to-table-name sequence-name))
358 database :auto nil))))
360 (defmethod database-set-sequence-position (sequence-name
362 (database sqlite-database))
363 (database-execute-command
364 (format nil "UPDATE ~A SET last_value=~A,is_called='t'"
365 (%sequence-name-to-table-name sequence-name)
370 (defmethod database-create (connection-spec (type (eql :sqlite)))
371 (declare (ignore connection-spec))
372 ;; databases are created automatically by SQLite
375 (defmethod database-destroy (connection-spec (type (eql :sqlite)))
376 (destructuring-bind (name) connection-spec
377 (if (probe-file name)
381 (defmethod database-probe (connection-spec (type (eql :sqlite)))
382 (destructuring-bind (name) connection-spec
383 ;; TODO: Add a test that this file is a real sqlite database
384 (or (string-equal ":memory:" name)
385 (and (probe-file name) t))))
387 ;;; Database capabilities
389 (defmethod db-type-has-boolean-where? ((db-type (eql :sqlite)))