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 'sql-connection-error
49 :database-type database-type
50 :connection-spec connection-spec
51 :error-id (sqlite:sqlite-error-code err)
52 :message (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)
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 'sql-database-data-error
72 :expression sql-expression
73 :error-id (sqlite:sqlite-error-code err)
74 :message (sqlite:sqlite-error-message err))))
77 (defstruct sqlite-result-set
78 (vm (sqlite:make-null-vm)
79 :type sqlite:sqlite-vm-pointer)
80 (first-row (sqlite:make-null-row)
81 :type sqlite:sqlite-row-pointer-type)
82 (col-names (sqlite:make-null-row)
83 :type sqlite:sqlite-row-pointer-type)
85 (n-col 0 :type fixnum))
87 (defmethod database-query (query-expression (database sqlite-database) result-types field-names)
88 (declare (optimize (speed 3) (safety 0) (debug 0) (space 0)))
90 (multiple-value-bind (result-set n-col)
91 (database-query-result-set query-expression database
92 :result-types result-types
95 (col-names (when field-names
96 (loop for j from 0 below n-col
97 collect (sqlite:sqlite-aref (sqlite-result-set-col-names result-set) j))))
98 (new-row (make-list n-col) (make-list n-col))
99 (row-ok (database-store-next-row result-set database new-row)
100 (database-store-next-row result-set database new-row)))
102 (values (nreverse rows) col-names))
103 (push new-row rows)))
104 (sqlite:sqlite-error (err)
105 (error 'sql-database-data-error
107 :expression query-expression
108 :error-id (sqlite:sqlite-error-code err)
109 :message (sqlite:sqlite-error-message err)))))
111 (defmethod database-query-result-set ((query-expression string)
112 (database sqlite-database)
113 &key result-types full-set)
115 (let ((vm (sqlite:sqlite-compile (sqlite-db database)
117 ;;; To obtain column number/datatypes we have to read the first row.
118 (multiple-value-bind (n-col cols col-names)
119 (sqlite:sqlite-step vm)
120 (let ((result-set (make-sqlite-result-set
126 (canonicalize-result-types
131 (values result-set n-col nil)
132 (values result-set n-col)))))
133 (sqlite:sqlite-error (err)
134 (error 'sql-database-data-error
136 :expression query-expression
137 :error-id (sqlite:sqlite-error-code err)
138 :message (sqlite:sqlite-error-message err)))))
140 (defun canonicalize-result-types (result-types n-col col-names)
142 (let ((raw-types (if (eq :auto result-types)
143 (loop for j from n-col below (* 2 n-col)
144 collect (ensure-keyword (sqlite:sqlite-aref col-names j)))
146 (loop for type in raw-types
149 ((:int :integer :tinyint :long)
160 (defmethod database-dump-result-set (result-set (database sqlite-database))
162 (sqlite:sqlite-finalize (sqlite-result-set-vm result-set))
163 (sqlite:sqlite-error (err)
164 (error 'sql-database-error
166 (format nil "Error finalizing SQLite VM: ~A"
167 (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 (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 'sql-database-error
189 (format nil "Error in sqlite-step: ~A"
190 (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)
198 (clsql-uffi:convert-raw-field
200 (uffi:deref-pointer row 'sqlite:sqlite-row-pointer) '(:array (* :unsigned-char)) i)
203 (sqlite:sqlite-free-row row)
208 (defmethod database-list-tables-and-sequences ((database sqlite-database) &key owner)
209 (declare (ignore owner))
210 ;; Query is copied from .table command of sqlite comamnd line utility.
211 (mapcar #'car (database-query
212 "SELECT name FROM sqlite_master WHERE type='table' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='table' ORDER BY name"
215 (defmethod database-list-tables ((database sqlite-database) &key owner)
216 (remove-if #'(lambda (s)
217 (and (>= (length s) 11)
218 (string-equal (subseq s 0 11) "_CLSQL_SEQ_")))
219 (database-list-tables-and-sequences database :owner owner)))
221 (defmethod database-list-views ((database sqlite-database)
223 (declare (ignore owner))
224 (mapcar #'car (database-query
225 "SELECT name FROM sqlite_master WHERE type='view' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='view' ORDER BY name"
228 (defmethod database-list-indexes ((database sqlite-database)
230 (declare (ignore owner))
231 (mapcar #'car (database-query
232 "SELECT name FROM sqlite_master WHERE type='index' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='index' ORDER BY name"
235 (defmethod database-list-table-indexes (table (database sqlite-database)
237 (declare (ignore owner))
238 (let ((*print-circle* nil))
243 "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"
247 (declaim (inline sqlite-table-info))
248 (defun sqlite-table-info (table database)
249 (database-query (format nil "PRAGMA table_info('~A')" table)
252 (defmethod database-list-attributes (table (database sqlite-database)
254 (declare (ignore owner))
255 (mapcar #'(lambda (table-info) (second table-info))
256 (sqlite-table-info table database)))
258 (defmethod database-attribute-type (attribute table
259 (database sqlite-database)
261 (declare (ignore owner))
262 (loop for field-info in (sqlite-table-info table database)
263 when (string= attribute (second field-info))
265 (let* ((raw-type (third field-info))
266 (start-length (position #\( raw-type))
267 (type (if start-length
268 (subseq raw-type 0 start-length)
270 (length (if start-length
271 (parse-integer (subseq raw-type (1+ start-length))
274 (values (when type (ensure-keyword type))
277 (if (string-equal (fourth field-info) "0")
280 (defmethod database-create (connection-spec (type (eql :sqlite)))
281 (declare (ignore connection-spec))
282 ;; databases are created automatically by SQLite
285 (defmethod database-destroy (connection-spec (type (eql :sqlite)))
286 (destructuring-bind (name) connection-spec
287 (if (probe-file name)
291 (defmethod database-probe (connection-spec (type (eql :sqlite)))
292 (destructuring-bind (name) connection-spec
293 ;; TODO: Add a test that this file is a real sqlite database
294 (or (string-equal ":memory:" name)
295 (and (probe-file name) t))))
297 ;;; Database capabilities
299 (defmethod db-type-has-boolean-where? ((db-type (eql :sqlite)))