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 and 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 ;;;; 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 'clsql-connect-error
  49              :database-type database-type
  50              :connection-spec connection-spec
  51              :errno (sqlite:sqlite-error-code err)
  52              :error (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         #+clisp (declare (ignore data))
  64         #-clisp (sqlite:sqlite-free-table data)
  65         (unless (= row-n 0)
  66           (error 'clsql-simple-warning
  67                  :format-control
  68                  "Result set not empty: ~@(~A~) row~:P, ~@(~A~) column~:P "
  69                  :format-arguments (list row-n col-n))))
  70     (sqlite:sqlite-error (err)
  71       (error 'clsql-sql-error
  72              :database database
  73              :expression sql-expression
  74              :errno (sqlite:sqlite-error-code err)
  75              :error (sqlite:sqlite-error-message err))))
  76   t)
  77
  78 (defmethod database-query (query-expression (database sqlite-database) result-types)
  79   (declare (ignore result-types))               ; SQLite is typeless!
  80   (handler-case
  81       (multiple-value-bind (data row-n col-n)
  82           (sqlite:sqlite-get-table (sqlite-db database) query-expression)
  83         #-clisp (declare (type sqlite:sqlite-row-pointer-type data))
  84         (if (= row-n 0)
  85             nil
  86             (prog1
  87                 ;; The first col-n elements are column names.
  88                 (loop for i from col-n below (* (1+ row-n) col-n) by col-n
  89                       collect (loop for j from 0 below col-n
  90                                     collect
  91                                     (#+clisp aref
  92                                      #-clisp sqlite:sqlite-aref
  93                                              data (+ i j))))
  94                 #-clisp (sqlite:sqlite-free-table data))
  95               ))
  96     (sqlite:sqlite-error (err)
  97       (error 'clsql-sql-error
  98              :database database
  99              :expression query-expression
 100              :errno (sqlite:sqlite-error-code err)
 101              :error (sqlite:sqlite-error-message err)))))
 102
 103 #-clisp
 104 (defstruct sqlite-result-set
 105   (vm (sqlite:make-null-vm)
 106       :type sqlite:sqlite-vm-pointer)
 107   (first-row (sqlite:make-null-row)
 108              :type sqlite:sqlite-row-pointer-type)
 109   (n-col 0 :type fixnum))
 110 #+clisp
 111 (defstruct sqlite-result-set
 112   (vm nil)
 113   (first-row nil)
 114   (n-col 0 :type fixnum))
 115
 116 (defmethod database-query-result-set
 117     ((query-expression string) (database sqlite-database) &key full-set result-types)
 118   (declare (ignore full-set result-types))
 119   (handler-case
 120       (let* ((vm (sqlite:sqlite-compile (sqlite-db database)
 121                                         query-expression))
 122              (result-set (make-sqlite-result-set :vm vm)))
 123         #-clisp (declare (type sqlite:sqlite-vm-pointer vm))
 124
 125         ;;; To obtain column number we have to read the first row.
 126         (multiple-value-bind (n-col cols col-names)
 127             (sqlite:sqlite-step vm)
 128           (declare (ignore col-names)
 129                    #-clisp (type sqlite:sqlite-row-pointer-type cols)
 130                    )
 131           (setf (sqlite-result-set-first-row result-set) cols
 132                 (sqlite-result-set-n-col result-set) n-col)
 133           (values result-set n-col nil)))
 134     (sqlite:sqlite-error (err)
 135       (error 'clsql-sql-error
 136              :database database
 137              :expression query-expression
 138              :errno (sqlite:sqlite-error-code err)
 139              :error (sqlite:sqlite-error-message err)))))
 140
 141 (defmethod database-dump-result-set (result-set (database sqlite-database))
 142   (handler-case
 143       (sqlite:sqlite-finalize (sqlite-result-set-vm result-set))
 144     (sqlite:sqlite-error (err)
 145       (error 'clsql-simple-error
 146              :format-control "Error finalizing SQLite VM: ~A"
 147              :format-arguments (list (sqlite:sqlite-error-message err))))))
 148
 149 (defmethod database-store-next-row (result-set (database sqlite-database) list)
 150   (let ((n-col (sqlite-result-set-n-col result-set)))
 151     (if (= n-col 0)
 152         ;; empty result set
 153         nil
 154         (let ((row (sqlite-result-set-first-row result-set)))
 155           (if (sqlite:null-row-p row)
 156               ;; First row already used. fetch another row from DB.
 157               (handler-case
 158                   (multiple-value-bind (n new-row col-names)
 159                       (sqlite:sqlite-step (sqlite-result-set-vm result-set))
 160                     (declare (ignore n col-names)
 161                              #-clisp (type sqlite:sqlite-row-pointer-type new-row)
 162                              )
 163                     (if (sqlite:null-row-p new-row)
 164                         (return-from database-store-next-row nil)
 165                         (setf row new-row)))
 166                 (sqlite:sqlite-error (err)
 167                   (error 'clsql-simple-error
 168                          :format-control "Error in sqlite-step: ~A"
 169                          :format-arguments
 170                          (list (sqlite:sqlite-error-message err)))))
 171
 172               ;; Use the row previously read by database-query-result-set.
 173               (setf (sqlite-result-set-first-row result-set)
 174                     (sqlite:make-null-row)))
 175           (loop for i = 0 then (1+ i)
 176                 for rest on list
 177                 do (setf (car rest)
 178                          (#+clisp aref
 179                           #-clisp sqlite:sqlite-aref
 180                           row i)))
 181           #-clisp (sqlite:sqlite-free-row row)
 182           t))))
 183
 184 ;;; Object listing
 185
 186 (defmethod database-list-tables ((database sqlite-database) &key owner)
 187   (declare (ignore owner))
 188   ;; Query is copied from .table command of sqlite comamnd line utility.
 189   (remove-if #'(lambda (s)
 190                  (and (>= (length s) 11)
 191                       (string= (subseq s 0 11) "_CLSQL_SEQ_")))
 192              (mapcar #'car (database-query
 193                             "SELECT name FROM sqlite_master WHERE type='table' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='table' ORDER BY name"
 194                             database '()))))
 195
 196 (defmethod database-list-views ((database sqlite-database)
 197                                 &key (owner nil))
 198   (declare (ignore owner))
 199   (mapcar #'car (database-query
 200                  "SELECT name FROM sqlite_master WHERE type='view' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='view' ORDER BY name"
 201                  database nil)))
 202
 203 (defmethod database-list-indexes ((database sqlite-database)
 204                                   &key (owner nil))
 205   (declare (ignore owner))
 206   (mapcar #'car (database-query
 207                  "SELECT name FROM sqlite_master WHERE type='index' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='index' ORDER BY name"
 208                  database nil)))
 209
 210 (defmethod database-list-table-indexes (table (database sqlite-database)
 211                                         &key (owner nil))
 212   (declare (ignore owner))
 213   (let ((*print-circle* nil))
 214     (mapcar #'car
 215             (database-query
 216              (format
 217               nil
 218               "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"
 219               table table)
 220              database nil))))
 221
 222 (declaim (inline sqlite-table-info))
 223 (defun sqlite-table-info (table database)
 224   (database-query (format nil "PRAGMA table_info('~A')" table)
 225                           database '()))
 226
 227 (defmethod database-list-attributes (table (database sqlite-database)
 228                                            &key (owner nil))
 229   (declare (ignore owner))
 230   (mapcar #'(lambda (table-info) (second table-info))
 231           (sqlite-table-info table database)))
 232
 233 (defmethod database-attribute-type (attribute table
 234                                     (database sqlite-database)
 235                                     &key (owner nil))
 236   (declare (ignore owner))
 237   (loop for field-info in (sqlite-table-info table database)
 238         when (string= attribute (second field-info))
 239         return (third field-info)))
 240
 241 (defun %sequence-name-to-table-name (sequence-name)
 242   (concatenate 'string "_CLSQL_SEQ_" (sql-escape sequence-name)))
 243
 244 (defun %table-name-to-sequence-name (table-name)
 245   (and (>= (length table-name) 11)
 246        (string= (subseq table-name 0 11) "_CLSQL_SEQ_")
 247        (subseq table-name 11)))
 248
 249
 250 (defmethod database-create-sequence (sequence-name
 251                                      (database sqlite-database))
 252   (let ((table-name (%sequence-name-to-table-name sequence-name)))
 253     (database-execute-command
 254      (concatenate 'string "CREATE TABLE " table-name
 255                   " (last_value integer PRIMARY KEY, increment_by integer, min_value integer, is_called char(1))")
 256      database)
 257     (database-execute-command
 258      (concatenate 'string "INSERT INTO " table-name
 259                   " VALUES (1,1,1,'f')")
 260      database)))
 261
 262 (defmethod database-drop-sequence (sequence-name
 263                                    (database sqlite-database))
 264   (database-execute-command
 265    (concatenate 'string "DROP TABLE " (%sequence-name-to-table-name sequence-name))
 266    database))
 267
 268 (defmethod database-list-sequences ((database sqlite-database)
 269                                     &key (owner nil))
 270   (declare (ignore owner))
 271   (mapcan #'(lambda (s)
 272               (let ((sn (%table-name-to-sequence-name (car s))))
 273                 (and sn (list sn))))
 274           (database-query
 275            "SELECT name FROM sqlite_master WHERE type='table' UNION ALL SELECT name FROM sqlite_temp_master WHERE type='table' ORDER BY name"
 276            database '())))
 277
 278 (defmethod database-sequence-next (sequence-name (database sqlite-database))
 279   (without-interrupts
 280    (let* ((table-name (%sequence-name-to-table-name sequence-name))
 281           (tuple
 282            (car (database-query
 283                  (concatenate 'string "SELECT last_value,is_called FROM "
 284                               table-name)
 285                  database
 286                  :auto))))
 287      (cond
 288        ((char-equal (schar (second tuple) 0) #\f)
 289         (database-execute-command
 290          (format nil "UPDATE ~A SET is_called='t'" table-name)
 291          database)
 292         (parse-integer (car tuple)))
 293        (t
 294         (let ((new-pos (1+ (parse-integer (car tuple)))))
 295          (database-execute-command
 296           (format nil "UPDATE ~A SET last_value=~D" table-name new-pos)
 297           database)
 298          new-pos))))))
 299
 300 (defmethod database-sequence-last (sequence-name (database sqlite-database))
 301   (without-interrupts
 302     (parse-integer
 303      (caar (database-query
 304             (concatenate 'string "SELECT last_value FROM "
 305                          (%sequence-name-to-table-name sequence-name))
 306             database
 307             :auto)))))
 308
 309 (defmethod database-set-sequence-position (sequence-name
 310                                            (position integer)
 311                                            (database sqlite-database))
 312   (database-execute-command
 313    (format nil "UPDATE ~A SET last_value=~A,is_called='t'"
 314            (%sequence-name-to-table-name sequence-name)
 315            position)
 316    database)
 317   position)
 318
 319 (defmethod database-create (connection-spec (type (eql :sqlite)))
 320   (declare (ignore connection-spec))
 321   ;; databases are created automatically by SQLite
 322   t)
 323
 324 (defmethod database-destroy (connection-spec (type (eql :sqlite)))
 325   (destructuring-bind (name) connection-spec
 326     (if (probe-file name)
 327         (delete-file name)
 328         nil)))
 329
 330 (defmethod database-probe (connection-spec (type (eql :sqlite)))
 331   (destructuring-bind (name) connection-spec
 332     ;; TODO: Add a test that this file is a real sqlite database
 333     (or (string-equal ":memory:" name)
 334         (and (probe-file name) t))))
 335
 336 ;;; Database capabilities
 337
 338 (defmethod db-type-has-boolean-where? ((db-type (eql :sqlite)))
 339   nil)
 340
 341
 342