db-sqlite/sqlite-sql.lisp

   1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
   2 ;;;; *************************************************************************
   3 ;;;; FILE IDENTIFICATION
   4 ;;;;
   5 ;;;; Name:     sqlite-sql.lisp
   6 ;;;; Purpose:  High-level SQLite interface
   7 ;;;; Authors:  Aurelio Bignoli, Kevin Rosenberg, Marcus Pearce
   8 ;;;; Created:  Aug 2003
   9 ;;;;
  10 ;;;; $Id$
  11 ;;;;
  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.
  14 ;;;;
  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 ;;;; *************************************************************************
  19
  20 (in-package #:clsql-sqlite)
  21
  22 (defclass sqlite-database (database)
  23   ((sqlite-db :initarg :sqlite-db :accessor sqlite-db)))
  24
  25 (defmethod database-type ((database sqlite-database))
  26   :sqlite)
  27
  28 (defmethod database-initialize-database-type ((database-type (eql :sqlite)))
  29   t)
  30
  31 (defun check-sqlite-connection-spec (connection-spec)
  32   (check-connection-spec connection-spec :sqlite (name)))
  33
  34 (defmethod database-name-from-spec (connection-spec
  35                                     (database-type (eql :sqlite)))
  36   (check-sqlite-connection-spec connection-spec)
  37   (first connection-spec))
  38
  39 (defmethod database-connect (connection-spec (database-type (eql :sqlite)))
  40   (check-sqlite-connection-spec connection-spec)
  41   (handler-case
  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)))))
  53
  54 (defmethod database-disconnect ((database sqlite-database))
  55   (sqlite:sqlite-close (sqlite-db database))
  56   (setf (sqlite-db database) nil)
  57   t)
  58
  59 (defmethod database-execute-command (sql-expression (database sqlite-database))
  60   (handler-case
  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)
  64         (unless (= row-n 0)
  65           (error 'sql-warning
  66                  :format-control
  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
  71              :database database
  72              :expression sql-expression
  73              :error-id (sqlite:sqlite-error-code err)
  74              :message (sqlite:sqlite-error-message err))))
  75   t)
  76
  77 (defstruct sqlite-result-set
  78   (vm (sqlite:make-null-vm)
  79       #-clisp :type
  80       #-clisp sqlite:sqlite-vm-pointer)
  81   (first-row (sqlite:make-null-row)
  82              #-clisp :type
  83              #-clisp sqlite:sqlite-row-pointer-type)
  84   (col-names (sqlite:make-null-row)
  85              #-clisp :type
  86              #-clisp sqlite:sqlite-row-pointer-type)
  87   (result-types nil)
  88   (n-col 0 :type fixnum))
  89
  90 (defmethod database-query (query-expression (database sqlite-database) result-types field-names)
  91   (declare (optimize (speed 3) (safety 0) (debug 0) (space 0)))
  92   (handler-case
  93       (multiple-value-bind (result-set n-col)
  94           (database-query-result-set query-expression database
  95                                      :result-types result-types
  96                                      :full-set nil)
  97         (do* ((rows nil)
  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)))
 104              ((not row-ok)
 105               (values (nreverse rows) col-names))
 106           (push new-row rows)))
 107     (sqlite:sqlite-error (err)
 108       (error 'sql-database-data-error
 109              :database database
 110              :expression query-expression
 111              :error-id (sqlite:sqlite-error-code err)
 112              :message (sqlite:sqlite-error-message err)))))
 113
 114 (defmethod database-query-result-set ((query-expression string)
 115                                       (database sqlite-database)
 116                                       &key result-types full-set)
 117   (handler-case
 118       (let ((vm (sqlite:sqlite-compile (sqlite-db database)
 119                                        query-expression)))
 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
 124                              :vm vm
 125                              :first-row cols
 126                              :n-col n-col
 127                              :col-names col-names
 128                              :result-types
 129                              (canonicalize-result-types
 130                               result-types
 131                               n-col
 132                               col-names))))
 133             (if full-set
 134                 (values result-set n-col nil)
 135                 (values result-set n-col)))))
 136     (sqlite:sqlite-error (err)
 137       (error 'sql-database-error
 138              :database database
 139              :expression query-expression
 140              :error-id (sqlite:sqlite-error-code err)
 141              :message (sqlite:sqlite-error-message err)))))
 142
 143 (defun canonicalize-result-types (result-types n-col col-names)
 144   (when result-types
 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)))
 148                        result-types)))
 149       (loop for type in raw-types
 150             collect
 151             (case type
 152               ((:int :integer :tinyint :long)
 153                :int32)
 154               (:bigint
 155                :int64)
 156               ((:float :double)
 157                :double)
 158               ((:numeric)
 159                :number)
 160               (otherwise
 161                :string))))))
 162
 163 (defmethod database-dump-result-set (result-set (database sqlite-database))
 164   (handler-case
 165       (sqlite:sqlite-finalize (sqlite-result-set-vm result-set))
 166     (sqlite:sqlite-error (err)
 167       (error 'sql-database-error
 168              :message
 169              (format nil "Error finalizing SQLite VM: ~A"
 170                      (sqlite:sqlite-error-message err))))))
 171
 172 (defmethod database-store-next-row (result-set (database sqlite-database) list)
 173   (let ((n-col (sqlite-result-set-n-col result-set))
 174         (result-types (sqlite-result-set-result-types result-set)))
 175     (if (= n-col 0)
 176         ;; empty result set
 177         nil
 178         (let ((row (sqlite-result-set-first-row result-set)))
 179           (if (sqlite:null-row-p row)
 180               ;; First row already used. fetch another row from DB.
 181               (handler-case
 182                   (multiple-value-bind (n new-row col-names)
 183                       (sqlite:sqlite-step (sqlite-result-set-vm result-set))
 184                     (declare (ignore n col-names)
 185                              #-clisp (type sqlite:sqlite-row-pointer-type new-row))
 186                     (if (sqlite:null-row-p new-row)
 187                         (return-from database-store-next-row nil)
 188                         (setf row new-row)))
 189                 (sqlite:sqlite-error (err)
 190                   (error 'sql-database-error
 191                          :message
 192                          (format nil "Error in sqlite-step: ~A"
 193                                  (sqlite:sqlite-error-message err)))))
 194
 195             ;; Use the row previously read by database-query-result-set.
 196               (setf (sqlite-result-set-first-row result-set)
 197                     (sqlite:make-null-row)))
 198           (loop for i = 0 then (1+ i)
 199                 for rest on list
 200                 do (setf (car rest)
 201                          #-clisp
 202                          (clsql-uffi:convert-raw-field
 203                           (uffi:deref-array
 204                            (uffi:deref-pointer row 'sqlite:sqlite-row-pointer) '(:array (* :unsigned-char)) i)
 205                           result-types
 206                           i)
 207                          #+clisp
 208                          (let ((type (if result-types
 209                                          (nth i result-types)
 210                                          :string))
 211                                (val (sqlite:sqlite-aref row i)))
 212                            (case type
 213                              (:string
 214                               val)
 215                              (:integer
 216                               (when val (parse-integer val)))
 217                              (:number
 218                               (read-from-string val))
 219                              (:double
 220                               (when val
 221                                 (coerce
 222                                  (read-from-string val)
 223                                  'double-float)))))))
 224           (sqlite:sqlite-free-row row)
 225           t))))
 226
 227 ;;; Object listing
 228
 229 (defmethod database-list-tables-and-sequences ((database sqlite-database) &key owner)
 230   (declare (ignore owner))
 231   ;; Query is copied from .table command of sqlite comamnd line utility.
 232   (mapcar #'car (database-query
 233                  "SELECT name FROM sqlite_master WHERE type='table' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='table' ORDER BY name"
 234                  database nil nil)))
 235
 236 (defmethod database-list-tables ((database sqlite-database) &key owner)
 237   (remove-if #'(lambda (s)
 238                  (and (>= (length s) 11)
 239                       (string-equal (subseq s 0 11) "_CLSQL_SEQ_")))
 240              (database-list-tables-and-sequences database :owner owner)))
 241
 242 (defmethod database-list-views ((database sqlite-database)
 243                                 &key (owner nil))
 244   (declare (ignore owner))
 245   (mapcar #'car (database-query
 246                  "SELECT name FROM sqlite_master WHERE type='view' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='view' ORDER BY name"
 247                  database nil nil)))
 248
 249 (defmethod database-list-indexes ((database sqlite-database)
 250                                   &key (owner nil))
 251   (declare (ignore owner))
 252   (mapcar #'car (database-query
 253                  "SELECT name FROM sqlite_master WHERE type='index' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='index' ORDER BY name"
 254                  database nil nil)))
 255
 256 (defmethod database-list-table-indexes (table (database sqlite-database)
 257                                         &key (owner nil))
 258   (declare (ignore owner))
 259   (let ((*print-circle* nil))
 260     (mapcar #'car
 261             (database-query
 262              (format
 263               nil
 264               "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"
 265               table table)
 266              database nil nil))))
 267
 268 (declaim (inline sqlite-table-info))
 269 (defun sqlite-table-info (table database)
 270   (database-query (format nil "PRAGMA table_info('~A')" table)
 271                   database nil nil))
 272
 273 (defmethod database-list-attributes (table (database sqlite-database)
 274                                            &key (owner nil))
 275   (declare (ignore owner))
 276   (mapcar #'(lambda (table-info) (second table-info))
 277           (sqlite-table-info table database)))
 278
 279 (defmethod database-attribute-type (attribute table
 280                                     (database sqlite-database)
 281                                     &key (owner nil))
 282   (declare (ignore owner))
 283   (loop for field-info in (sqlite-table-info table database)
 284       when (string= attribute (second field-info))
 285       return
 286         (let* ((raw-type (third field-info))
 287                (start-length (position #\( raw-type))
 288                (type (if start-length
 289                          (subseq raw-type 0 start-length)
 290                        raw-type))
 291                (length (if start-length
 292                            (parse-integer (subseq raw-type (1+ start-length))
 293                                           :junk-allowed t)
 294                          nil)))
 295           (values (when type (ensure-keyword type))
 296                   length
 297                   nil
 298                   (if (string-equal (fourth field-info) "0")
 299                       1 0)))))
 300
 301 (defmethod database-create (connection-spec (type (eql :sqlite)))
 302   (declare (ignore connection-spec))
 303   ;; databases are created automatically by SQLite
 304   t)
 305
 306 (defmethod database-destroy (connection-spec (type (eql :sqlite)))
 307   (destructuring-bind (name) connection-spec
 308     (if (probe-file name)
 309         (delete-file name)
 310         nil)))
 311
 312 (defmethod database-probe (connection-spec (type (eql :sqlite)))
 313   (destructuring-bind (name) connection-spec
 314     ;; TODO: Add a test that this file is a real sqlite database
 315     (or (string-equal ":memory:" name)
 316         (and (probe-file name) t))))
 317
 318 ;;; Database capabilities
 319
 320 (defmethod db-type-has-boolean-where? ((db-type (eql :sqlite)))
 321   nil)
 322
 323
 324