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
10 ;;;; This file, part of CLSQL, is Copyright (c) 2003 by Aurelio Bignoli and
11 ;;;; Copyright (c) 2003-2010 by Kevin Rosenberg and Marcus Pearce.
13 ;;;; CLSQL users are granted the rights to distribute and use this software
14 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
15 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
16 ;;;; *************************************************************************
18 (in-package #:clsql-sqlite)
20 (defclass sqlite-database (database)
21 ((sqlite-db :initarg :sqlite-db :accessor sqlite-db)))
23 (defmethod database-type ((database sqlite-database))
26 (defmethod database-initialize-database-type ((database-type (eql :sqlite)))
29 (defun check-sqlite-connection-spec (connection-spec)
30 (check-connection-spec connection-spec :sqlite (name)))
32 (defmethod database-name-from-spec (connection-spec
33 (database-type (eql :sqlite)))
34 (check-sqlite-connection-spec connection-spec)
35 (first connection-spec))
37 (defmethod database-connect (connection-spec (database-type (eql :sqlite)))
38 (check-sqlite-connection-spec connection-spec)
40 (make-instance 'sqlite-database
41 :name (database-name-from-spec connection-spec :sqlite)
42 :database-type :sqlite
43 :connection-spec connection-spec
44 :sqlite-db (sqlite:sqlite-open (first connection-spec)))
45 (sqlite:sqlite-error (err)
46 (error 'sql-connection-error
47 :database-type database-type
48 :connection-spec connection-spec
49 :error-id (sqlite:sqlite-error-code err)
50 :message (sqlite:sqlite-error-message err)))))
52 (defmethod database-disconnect ((database sqlite-database))
53 (sqlite:sqlite-close (sqlite-db database))
54 (setf (sqlite-db database) nil)
57 (defmethod database-execute-command (sql-expression (database sqlite-database))
59 (multiple-value-bind (data row-n col-n)
60 (sqlite:sqlite-get-table (sqlite-db database) sql-expression)
61 (sqlite:sqlite-free-table data)
65 "Result set not empty: ~@(~A~) row~:P, ~@(~A~) column~:P "
66 :format-arguments (list row-n col-n))))
67 (sqlite:sqlite-error (err)
68 (error 'sql-database-data-error
70 :expression sql-expression
71 :error-id (sqlite:sqlite-error-code err)
72 :message (sqlite:sqlite-error-message err))))
75 (defstruct sqlite-result-set
76 (vm (sqlite:make-null-vm)
77 :type sqlite:sqlite-vm-pointer)
78 (first-row (sqlite:make-null-row)
79 :type sqlite:sqlite-row-pointer-type)
80 (col-names (sqlite:make-null-row)
81 :type sqlite:sqlite-row-pointer-type)
83 (n-col 0 :type fixnum))
85 (defmethod database-query (query-expression (database sqlite-database) result-types field-names)
86 (declare (optimize (speed 3) (safety 0) (debug 0) (space 0)))
88 (let ((vm (sqlite:sqlite-compile (sqlite-db database)
93 ;; Read the first row to get column number and names.
94 (multiple-value-bind (n-col new-row sqlite-col-names)
95 (sqlite:sqlite-step vm)
96 (declare (type sqlite:sqlite-row-pointer-type new-row))
99 (setf col-names (loop for i from 0 below n-col
100 collect (sqlite:sqlite-aref sqlite-col-names i (encoding database)))))
101 (let ((canonicalized-result-types
102 (canonicalize-result-types result-types n-col sqlite-col-names)))
103 (flet ((extract-row-data (row)
104 (declare (type sqlite:sqlite-row-pointer-type row))
105 (loop for i from 0 below n-col
106 collect (clsql-uffi:convert-raw-field
107 (sqlite:sqlite-raw-aref row i)
108 (nth i canonicalized-result-types)
109 :encoding (encoding database)))))
110 (push (extract-row-data new-row) rows)
112 ;; Read subsequent rows.
114 (multiple-value-bind (n-col new-row)
115 (sqlite:sqlite-step vm)
116 (declare (type sqlite:sqlite-row-pointer-type new-row))
118 (push (extract-row-data new-row) rows)
120 (sqlite:sqlite-finalize vm))
121 (values (nreverse rows) col-names))
122 (sqlite:sqlite-error (err)
123 (error 'sql-database-data-error
125 :expression query-expression
126 :error-id (sqlite:sqlite-error-code err)
127 :message (sqlite:sqlite-error-message err)))))
129 (defmethod database-query-result-set ((query-expression string)
130 (database sqlite-database)
131 &key result-types full-set)
135 (setf vm (sqlite:sqlite-compile (sqlite-db database)
137 ;;; To obtain column number/datatypes we have to read the first row.
138 (multiple-value-bind (n-col cols col-names)
139 (sqlite:sqlite-step vm)
140 (declare (type sqlite:sqlite-row-pointer-type cols))
141 (let ((result-set (make-sqlite-result-set
147 (canonicalize-result-types
152 (values result-set n-col nil)
153 (values result-set n-col)))))
154 (sqlite:sqlite-error (err)
157 ;; The condition was thrown by sqlite-step, vm must be
160 (sqlite:sqlite-finalize vm)))
161 (error 'sql-database-data-error
163 :expression query-expression
164 :error-id (sqlite:sqlite-error-code err)
165 :message (sqlite:sqlite-error-message err))11)))))
167 (defun canonicalize-result-types (result-types n-col col-names)
169 (let ((raw-types (if (eq :auto result-types)
170 (loop for j from n-col below (* 2 n-col)
171 collect (ensure-keyword (sqlite:sqlite-aref col-names j)))
173 (loop for type in raw-types
176 ((:int :integer :tinyint)
178 (:long #+(or x86-64 64bit) :int64 #-(or x86-64 64bit) :int32)
188 (defmethod database-dump-result-set (result-set (database sqlite-database))
190 (sqlite:sqlite-finalize (sqlite-result-set-vm result-set))
191 (sqlite:sqlite-error (err)
192 (error 'sql-database-error
194 (format nil "Error finalizing SQLite VM: ~A"
195 (sqlite:sqlite-error-message err))))))
197 (defmethod database-store-next-row (result-set (database sqlite-database) list)
198 (let ((n-col (sqlite-result-set-n-col result-set))
199 (result-types (sqlite-result-set-result-types result-set)))
203 (let ((row (sqlite-result-set-first-row result-set)))
204 (if (sqlite:null-row-p row)
205 ;; First row already used. fetch another row from DB.
207 (multiple-value-bind (n new-row col-names)
208 (sqlite:sqlite-step (sqlite-result-set-vm result-set))
209 (declare (ignore n col-names)
210 (type sqlite:sqlite-row-pointer-type new-row))
211 (if (sqlite:null-row-p new-row)
212 (return-from database-store-next-row nil)
214 (sqlite:sqlite-error (err)
215 (error 'sql-database-error
217 (format nil "Error in sqlite-step: ~A"
218 (sqlite:sqlite-error-message err)))))
220 ;; Use the row previously read by database-query-result-set.
221 (setf (sqlite-result-set-first-row result-set)
222 (sqlite:make-null-row)))
223 (loop for i = 0 then (1+ i)
226 (clsql-uffi:convert-raw-field
227 (sqlite:sqlite-raw-aref row i)
229 :encoding (encoding database))))
230 (sqlite:sqlite-free-row row)
235 (defmethod database-list-tables-and-sequences ((database sqlite-database) &key owner)
236 (declare (ignore owner))
237 ;; Query is copied from .table command of sqlite comamnd line utility.
238 (mapcar #'car (database-query
239 "SELECT name FROM sqlite_master WHERE type='table' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='table' ORDER BY name"
242 (defmethod database-list-tables ((database sqlite-database) &key owner)
243 (remove-if #'(lambda (s)
244 (and (>= (length s) 11)
245 (string-equal (subseq s 0 11) "_CLSQL_SEQ_")))
246 (database-list-tables-and-sequences database :owner owner)))
248 (defmethod database-list-views ((database sqlite-database)
250 (declare (ignore owner))
251 (mapcar #'car (database-query
252 "SELECT name FROM sqlite_master WHERE type='view' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='view' ORDER BY name"
255 (defmethod database-list-indexes ((database sqlite-database)
257 (declare (ignore owner))
258 (mapcar #'car (database-query
259 "SELECT name FROM sqlite_master WHERE type='index' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='index' ORDER BY name"
262 (defmethod database-list-table-indexes (table (database sqlite-database)
264 (declare (ignore owner))
265 (let ((*print-circle* nil))
270 "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"
274 (declaim (inline sqlite-table-info))
275 (defun sqlite-table-info (table database)
276 (database-query (format nil "PRAGMA table_info('~A')" table)
279 (defmethod database-list-attributes (table (database sqlite-database)
281 (declare (ignore owner))
282 (mapcar #'(lambda (table-info) (second table-info))
283 (sqlite-table-info table database)))
285 (defmethod database-attribute-type (attribute table
286 (database sqlite-database)
288 (declare (ignore owner))
289 (loop for field-info in (sqlite-table-info table database)
290 when (string= attribute (second field-info))
292 (let* ((raw-type (third field-info))
293 (start-length (position #\( raw-type))
294 (type (if start-length
295 (subseq raw-type 0 start-length)
297 (length (if start-length
298 (parse-integer (subseq raw-type (1+ start-length))
301 (values (when type (ensure-keyword type))
304 (if (string-equal (fourth field-info) "0")
307 (defmethod database-create (connection-spec (type (eql :sqlite)))
308 (declare (ignore connection-spec))
309 ;; databases are created automatically by SQLite
312 (defmethod database-destroy (connection-spec (type (eql :sqlite)))
313 (destructuring-bind (name) connection-spec
314 (if (probe-file name)
318 (defmethod database-probe (connection-spec (type (eql :sqlite)))
319 (destructuring-bind (name) connection-spec
320 ;; TODO: Add a test that this file is a real sqlite database
321 (or (string-equal ":memory:" name)
322 (and (probe-file name) t))))
324 ;;; Database capabilities
326 (defmethod db-type-has-boolean-where? ((db-type (eql :sqlite)))