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 and Marcus Pearce
12 ;;;; This file, part of CLSQL, is Copyright (c) 2003 by Aurelio Bignoli and
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 :sqlite-db (sqlite:sqlite-open (first connection-spec)))
45 (sqlite:sqlite-error (err)
46 (error 'clsql-connect-error
47 :database-type database-type
48 :connection-spec connection-spec
49 :errno (sqlite:sqlite-error-code err)
50 :error (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 #+clisp (declare (ignore data))
62 #-clisp (sqlite:sqlite-free-table data)
64 (error 'clsql-simple-warning
66 "Result set not empty: ~@(~A~) row~:P, ~@(~A~) column~:P "
67 :format-arguments (list row-n col-n))))
68 (sqlite:sqlite-error (err)
69 (error 'clsql-sql-error
71 :expression sql-expression
72 :errno (sqlite:sqlite-error-code err)
73 :error (sqlite:sqlite-error-message err))))
76 (defmethod database-query (query-expression (database sqlite-database) result-types)
77 (declare (ignore result-types)) ; SQLite is typeless!
79 (multiple-value-bind (data row-n col-n)
80 (sqlite:sqlite-get-table (sqlite-db database) query-expression)
81 #-clisp (declare (type sqlite:sqlite-row-pointer-type data))
85 ;; The first col-n elements are column names.
86 (loop for i from col-n below (* (1+ row-n) col-n) by col-n
87 collect (loop for j from 0 below col-n
90 #-clisp sqlite:sqlite-aref
92 #-clisp (sqlite:sqlite-free-table data))
94 (sqlite:sqlite-error (err)
95 (error 'clsql-sql-error
97 :expression query-expression
98 :errno (sqlite:sqlite-error-code err)
99 :error (sqlite:sqlite-error-message err)))))
102 (defstruct sqlite-result-set
103 (vm (sqlite:make-null-vm)
104 :type sqlite:sqlite-vm-pointer)
105 (first-row (sqlite:make-null-row)
106 :type sqlite:sqlite-row-pointer-type)
107 (n-col 0 :type fixnum))
109 (defstruct sqlite-result-set
112 (n-col 0 :type fixnum))
114 (defmethod database-query-result-set
115 ((query-expression string) (database sqlite-database) &key full-set result-types)
116 (declare (ignore full-set result-types))
118 (let* ((vm (sqlite:sqlite-compile (sqlite-db database)
120 (result-set (make-sqlite-result-set :vm vm)))
121 #-clisp (declare (type sqlite:sqlite-vm-pointer vm))
123 ;;; To obtain column number we have to read the first row.
124 (multiple-value-bind (n-col cols col-names)
125 (sqlite:sqlite-step vm)
126 (declare (ignore col-names)
127 #-clisp (type sqlite:sqlite-row-pointer-type cols)
129 (setf (sqlite-result-set-first-row result-set) cols
130 (sqlite-result-set-n-col result-set) n-col)
131 (values result-set n-col nil)))
132 (sqlite:sqlite-error (err)
133 (error 'clsql-sql-error
135 :expression query-expression
136 :errno (sqlite:sqlite-error-code err)
137 :error (sqlite:sqlite-error-message err)))))
139 (defmethod database-dump-result-set (result-set (database sqlite-database))
141 (sqlite:sqlite-finalize (sqlite-result-set-vm result-set))
142 (sqlite:sqlite-error (err)
143 (error 'clsql-simple-error
144 :format-control "Error finalizing SQLite VM: ~A"
145 :format-arguments (list (sqlite:sqlite-error-message err))))))
147 (defmethod database-store-next-row (result-set (database sqlite-database) list)
148 (let ((n-col (sqlite-result-set-n-col result-set)))
152 (let ((row (sqlite-result-set-first-row result-set)))
153 (if (sqlite:null-row-p row)
154 ;; First row already used. fetch another row from DB.
156 (multiple-value-bind (n new-row col-names)
157 (sqlite:sqlite-step (sqlite-result-set-vm result-set))
158 (declare (ignore n col-names)
159 #-clisp (type sqlite:sqlite-row-pointer-type new-row)
161 (if (sqlite:null-row-p new-row)
162 (return-from database-store-next-row nil)
164 (sqlite:sqlite-error (err)
165 (error 'clsql-simple-error
166 :format-control "Error in sqlite-step: ~A"
168 (list (sqlite:sqlite-error-message err)))))
170 ;; Use the row previously read by database-query-result-set.
171 (setf (sqlite-result-set-first-row result-set)
172 (sqlite:make-null-row)))
173 (loop for i = 0 then (1+ i)
177 #-clisp sqlite:sqlite-aref
179 #-clisp (sqlite:sqlite-free-row row)
184 (defmethod database-list-tables ((database sqlite-database) &key owner)
185 (declare (ignore owner))
186 ;; Query is copied from .table command of sqlite comamnd line utility.
187 (remove-if #'(lambda (s)
188 (and (>= (length s) 11)
189 (string= (subseq s 0 11) "_clsql_seq_")))
190 (mapcar #'car (database-query
191 "SELECT name FROM sqlite_master WHERE type='table' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='table' ORDER BY name"
194 (defmethod database-list-views ((database sqlite-database)
196 (declare (ignore owner))
197 (mapcar #'car (database-query
198 "SELECT name FROM sqlite_master WHERE type='view' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='view' ORDER BY name"
201 (defmethod database-list-indexes ((database sqlite-database)
203 (declare (ignore owner))
204 (mapcar #'car (database-query
205 "SELECT name FROM sqlite_master WHERE type='index' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='index' ORDER BY name"
208 (declaim (inline sqlite-table-info))
209 (defun sqlite-table-info (table database)
210 (database-query (format nil "PRAGMA table_info('~A')" table)
213 (defmethod database-list-attributes (table (database sqlite-database)
215 (declare (ignore owner))
216 (mapcar #'(lambda (table-info) (second table-info))
217 (sqlite-table-info table database)))
219 (defmethod database-attribute-type (attribute table
220 (database sqlite-database)
222 (declare (ignore owner))
223 (loop for field-info in (sqlite-table-info table database)
224 when (string= attribute (second field-info))
225 return (third field-info)))
227 (defun %sequence-name-to-table-name (sequence-name)
228 (concatenate 'string "_clsql_seq_" (sql-escape sequence-name)))
230 (defun %table-name-to-sequence-name (table-name)
231 (and (>= (length table-name) 11)
232 (string= (subseq table-name 0 11) "_clsql_seq_")
233 (subseq table-name 11)))
235 (defmethod database-create-sequence (sequence-name
236 (database sqlite-database))
237 (let ((table-name (%sequence-name-to-table-name sequence-name)))
238 (database-execute-command
239 (concatenate 'string "CREATE TABLE " table-name
240 " (id INTEGER PRIMARY KEY)")
242 (database-execute-command
243 (format nil "INSERT INTO ~A VALUES (-1)" table-name)
246 (defmethod database-drop-sequence (sequence-name
247 (database sqlite-database))
248 (database-execute-command
249 (concatenate 'string "DROP TABLE "
250 (%sequence-name-to-table-name sequence-name))
253 (defmethod database-list-sequences ((database sqlite-database)
255 (declare (ignore owner))
256 (mapcan #'(lambda (s)
257 (let ((sn (%table-name-to-sequence-name (car s))))
260 "SELECT name FROM sqlite_master WHERE type='table' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='table' ORDER BY name"
263 (defmethod database-sequence-next (sequence-name (database sqlite-database))
264 (let ((table-name (%sequence-name-to-table-name sequence-name)))
265 (database-execute-command
266 (format nil "UPDATE ~A SET id=(SELECT id FROM ~A)+1"
267 table-name table-name)
269 (sqlite:sqlite-last-insert-rowid (sqlite-db database))
271 (caar (database-query (format nil "SELECT id from ~A" table-name)
274 (defmethod database-set-sequence-position (sequence-name
276 (database sqlite-database))
277 (let ((table-name (%sequence-name-to-table-name sequence-name)))
278 (database-execute-command
279 (format nil "UPDATE ~A SET id=~A" table-name position)
281 (sqlite:sqlite-last-insert-rowid (sqlite-db database))))
283 (defmethod database-sequence-last (sequence-name (database sqlite-database))
284 (declare (ignore sequence-name)))