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 (let ((vm (sqlite:sqlite-compile (sqlite-db database)
95 ;; Read the first row to get column number and names.
96 (multiple-value-bind (n-col new-row sqlite-col-names)
97 (sqlite:sqlite-step vm)
98 (declare (type sqlite:sqlite-row-pointer-type new-row))
101 (setf col-names (loop for i from 0 below n-col
102 collect (sqlite:sqlite-aref sqlite-col-names i))))
103 (let ((canonicalized-result-types
104 (canonicalize-result-types result-types n-col sqlite-col-names)))
105 (flet ((extract-row-data (row)
106 (declare (type sqlite:sqlite-row-pointer-type row))
107 (loop for i from 0 below n-col
108 collect (clsql-uffi:convert-raw-field
109 (sqlite:sqlite-raw-aref row i)
110 canonicalized-result-types i))))
111 (push (extract-row-data new-row) rows)
113 ;; Read subsequent rows.
115 (multiple-value-bind (n-col new-row)
116 (sqlite:sqlite-step vm)
117 (declare (type sqlite:sqlite-row-pointer-type new-row))
119 (push (extract-row-data new-row) rows)
121 (sqlite:sqlite-finalize vm))
122 (values (nreverse rows) col-names))
123 (sqlite:sqlite-error (err)
124 (error 'sql-database-data-error
126 :expression query-expression
127 :error-id (sqlite:sqlite-error-code err)
128 :message (sqlite:sqlite-error-message err)))))
130 (defmethod database-query-result-set ((query-expression string)
131 (database sqlite-database)
132 &key result-types full-set)
136 (setf vm (sqlite:sqlite-compile (sqlite-db database)
138 ;;; To obtain column number/datatypes we have to read the first row.
139 (multiple-value-bind (n-col cols col-names)
140 (sqlite:sqlite-step vm)
141 (declare (type sqlite:sqlite-row-pointer-type cols))
142 (let ((result-set (make-sqlite-result-set
148 (canonicalize-result-types
153 (values result-set n-col nil)
154 (values result-set n-col)))))
155 (sqlite:sqlite-error (err)
158 ;; The condition was thrown by sqlite-step, vm must be
161 (sqlite:sqlite-finalize vm)))
162 (error 'sql-database-data-error
164 :expression query-expression
165 :error-id (sqlite:sqlite-error-code err)
166 :message (sqlite:sqlite-error-message err))11)))))
168 (defun canonicalize-result-types (result-types n-col col-names)
170 (let ((raw-types (if (eq :auto result-types)
171 (loop for j from n-col below (* 2 n-col)
172 collect (ensure-keyword (sqlite:sqlite-aref col-names j)))
174 (loop for type in raw-types
177 ((:int :integer :tinyint)
179 (:long #+(or x86-64 64bit) :int64 #-(or x86-64 64bit) :int32)
189 (defmethod database-dump-result-set (result-set (database sqlite-database))
191 (sqlite:sqlite-finalize (sqlite-result-set-vm result-set))
192 (sqlite:sqlite-error (err)
193 (error 'sql-database-error
195 (format nil "Error finalizing SQLite VM: ~A"
196 (sqlite:sqlite-error-message err))))))
198 (defmethod database-store-next-row (result-set (database sqlite-database) list)
199 (let ((n-col (sqlite-result-set-n-col result-set))
200 (result-types (sqlite-result-set-result-types result-set)))
204 (let ((row (sqlite-result-set-first-row result-set)))
205 (if (sqlite:null-row-p row)
206 ;; First row already used. fetch another row from DB.
208 (multiple-value-bind (n new-row col-names)
209 (sqlite:sqlite-step (sqlite-result-set-vm result-set))
210 (declare (ignore n col-names)
211 (type sqlite:sqlite-row-pointer-type new-row))
212 (if (sqlite:null-row-p new-row)
213 (return-from database-store-next-row nil)
215 (sqlite:sqlite-error (err)
216 (error 'sql-database-error
218 (format nil "Error in sqlite-step: ~A"
219 (sqlite:sqlite-error-message err)))))
221 ;; Use the row previously read by database-query-result-set.
222 (setf (sqlite-result-set-first-row result-set)
223 (sqlite:make-null-row)))
224 (loop for i = 0 then (1+ i)
227 (clsql-uffi:convert-raw-field
228 (sqlite:sqlite-raw-aref row i)
231 (sqlite:sqlite-free-row row)
236 (defmethod database-list-tables-and-sequences ((database sqlite-database) &key owner)
237 (declare (ignore owner))
238 ;; Query is copied from .table command of sqlite comamnd line utility.
239 (mapcar #'car (database-query
240 "SELECT name FROM sqlite_master WHERE type='table' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='table' ORDER BY name"
243 (defmethod database-list-tables ((database sqlite-database) &key owner)
244 (remove-if #'(lambda (s)
245 (and (>= (length s) 11)
246 (string-equal (subseq s 0 11) "_CLSQL_SEQ_")))
247 (database-list-tables-and-sequences database :owner owner)))
249 (defmethod database-list-views ((database sqlite-database)
251 (declare (ignore owner))
252 (mapcar #'car (database-query
253 "SELECT name FROM sqlite_master WHERE type='view' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='view' ORDER BY name"
256 (defmethod database-list-indexes ((database sqlite-database)
258 (declare (ignore owner))
259 (mapcar #'car (database-query
260 "SELECT name FROM sqlite_master WHERE type='index' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='index' ORDER BY name"
263 (defmethod database-list-table-indexes (table (database sqlite-database)
265 (declare (ignore owner))
266 (let ((*print-circle* nil))
271 "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"
275 (declaim (inline sqlite-table-info))
276 (defun sqlite-table-info (table database)
277 (database-query (format nil "PRAGMA table_info('~A')" table)
280 (defmethod database-list-attributes (table (database sqlite-database)
282 (declare (ignore owner))
283 (mapcar #'(lambda (table-info) (second table-info))
284 (sqlite-table-info table database)))
286 (defmethod database-attribute-type (attribute table
287 (database sqlite-database)
289 (declare (ignore owner))
290 (loop for field-info in (sqlite-table-info table database)
291 when (string= attribute (second field-info))
293 (let* ((raw-type (third field-info))
294 (start-length (position #\( raw-type))
295 (type (if start-length
296 (subseq raw-type 0 start-length)
298 (length (if start-length
299 (parse-integer (subseq raw-type (1+ start-length))
302 (values (when type (ensure-keyword type))
305 (if (string-equal (fourth field-info) "0")
308 (defmethod database-create (connection-spec (type (eql :sqlite)))
309 (declare (ignore connection-spec))
310 ;; databases are created automatically by SQLite
313 (defmethod database-destroy (connection-spec (type (eql :sqlite)))
314 (destructuring-bind (name) connection-spec
315 (if (probe-file name)
319 (defmethod database-probe (connection-spec (type (eql :sqlite)))
320 (destructuring-bind (name) connection-spec
321 ;; TODO: Add a test that this file is a real sqlite database
322 (or (string-equal ":memory:" name)
323 (and (probe-file name) t))))
325 ;;; Database capabilities
327 (defmethod db-type-has-boolean-where? ((db-type (eql :sqlite)))