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)
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 '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)
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 'sql-database-data-error
110 :expression query-expression
111 :error-id (sqlite:sqlite-error-code err)
112 :message (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 'sql-database-error
139 :expression query-expression
140 :error-id (sqlite:sqlite-error-code err)
141 :message (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 'sql-database-error
167 (format nil "Error finalizing SQLite VM: ~A"
168 (sqlite:sqlite-error-message err))))))
170 (defmethod database-store-next-row (result-set (database sqlite-database) list)
171 (let ((n-col (sqlite-result-set-n-col result-set))
172 (result-types (sqlite-result-set-result-types result-set)))
176 (let ((row (sqlite-result-set-first-row result-set)))
177 (if (sqlite:null-row-p row)
178 ;; First row already used. fetch another row from DB.
180 (multiple-value-bind (n new-row col-names)
181 (sqlite:sqlite-step (sqlite-result-set-vm result-set))
182 (declare (ignore n col-names)
183 #-clisp (type sqlite:sqlite-row-pointer-type new-row))
184 (if (sqlite:null-row-p new-row)
185 (return-from database-store-next-row nil)
187 (sqlite:sqlite-error (err)
188 (error 'sql-database-error
190 (format nil "Error in sqlite-step: ~A"
191 (sqlite:sqlite-error-message err)))))
193 ;; Use the row previously read by database-query-result-set.
194 (setf (sqlite-result-set-first-row result-set)
195 (sqlite:make-null-row)))
196 (loop for i = 0 then (1+ i)
200 (clsql-uffi:convert-raw-field
202 (uffi:deref-pointer row 'sqlite:sqlite-row-pointer) '(:array (* :unsigned-char)) i)
206 (let ((type (if result-types
209 (val (sqlite:sqlite-aref row i)))
214 (when val (parse-integer val)))
216 (read-from-string val))
220 (read-from-string val)
222 (sqlite:sqlite-free-row row)
227 (defmethod database-list-tables-and-sequences ((database sqlite-database) &key owner)
228 (declare (ignore owner))
229 ;; Query is copied from .table command of sqlite comamnd line utility.
230 (mapcar #'car (database-query
231 "SELECT name FROM sqlite_master WHERE type='table' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='table' ORDER BY name"
234 (defmethod database-list-tables ((database sqlite-database) &key owner)
235 (remove-if #'(lambda (s)
236 (and (>= (length s) 11)
237 (string-equal (subseq s 0 11) "_CLSQL_SEQ_")))
238 (database-list-tables-and-sequences database :owner owner)))
240 (defmethod database-list-views ((database sqlite-database)
242 (declare (ignore owner))
243 (mapcar #'car (database-query
244 "SELECT name FROM sqlite_master WHERE type='view' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='view' ORDER BY name"
247 (defmethod database-list-indexes ((database sqlite-database)
249 (declare (ignore owner))
250 (mapcar #'car (database-query
251 "SELECT name FROM sqlite_master WHERE type='index' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='index' ORDER BY name"
254 (defmethod database-list-table-indexes (table (database sqlite-database)
256 (declare (ignore owner))
257 (let ((*print-circle* nil))
262 "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"
266 (declaim (inline sqlite-table-info))
267 (defun sqlite-table-info (table database)
268 (database-query (format nil "PRAGMA table_info('~A')" table)
271 (defmethod database-list-attributes (table (database sqlite-database)
273 (declare (ignore owner))
274 (mapcar #'(lambda (table-info) (second table-info))
275 (sqlite-table-info table database)))
277 (defmethod database-attribute-type (attribute table
278 (database sqlite-database)
280 (declare (ignore owner))
281 (loop for field-info in (sqlite-table-info table database)
282 when (string= attribute (second field-info))
284 (let* ((raw-type (third field-info))
285 (start-length (position #\( raw-type))
286 (type (if start-length
287 (subseq raw-type 0 start-length)
289 (length (if start-length
290 (parse-integer (subseq raw-type (1+ start-length))
293 (values (when type (ensure-keyword type))
296 (if (string-equal (fourth field-info) "0")
299 (defmethod database-create (connection-spec (type (eql :sqlite)))
300 (declare (ignore connection-spec))
301 ;; databases are created automatically by SQLite
304 (defmethod database-destroy (connection-spec (type (eql :sqlite)))
305 (destructuring-bind (name) connection-spec
306 (if (probe-file name)
310 (defmethod database-probe (connection-spec (type (eql :sqlite)))
311 (destructuring-bind (name) connection-spec
312 ;; TODO: Add a test that this file is a real sqlite database
313 (or (string-equal ":memory:" name)
314 (and (probe-file name) t))))
316 ;;; Database capabilities
318 (defmethod db-type-has-boolean-where? ((db-type (eql :sqlite)))