base/basic-sql.lisp

   1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
   2 ;;;; *************************************************************************
   3 ;;;;
   4 ;;;; $Id$
   5 ;;;;
   6 ;;;; Base SQL functions
   7 ;;;;
   8 ;;;; This file is part of CLSQL.
   9 ;;;;
  10 ;;;; CLSQL users are granted the rights to distribute and use this software
  11 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
  12 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
  13 ;;;; *************************************************************************
  14
  15 (in-package #:clsql-base-sys)
  16
  17 ;;; Query
  18
  19 (defgeneric query (query-expression &key database result-types flatp)
  20   (:documentation
  21    "Execute the SQL query expression QUERY-EXPRESSION on the given
  22 DATABASE which defaults to *default-database*. RESULT-TYPES is a list
  23 of symbols such as :string and :integer, one for each field in the
  24 query, which are used to specify the types to return. The FLATP
  25 argument, which has a default value of nil, specifies if full
  26 bracketed results should be returned for each matched entry. If FLATP
  27 is nil, the results are returned as a list of lists. If FLATP is t,
  28 the results are returned as elements of a list, only if there is only
  29 one result per row. Returns a list of lists of values of the result of
  30 that expression and a list of field names selected in sql-exp."))
  31
  32 (defmethod query ((query-expression string) &key (database *default-database*)
  33                   (result-types nil) (flatp nil))
  34   (record-sql-action query-expression :query database)
  35   (let* ((res (database-query query-expression database result-types))
  36          (res (if flatp
  37                   (mapcar #'car res)
  38                 res)))
  39     (record-sql-action res :result database)
  40     res))
  41
  42 ;;; Execute
  43
  44 (defgeneric execute-command (expression &key database)
  45   (:documentation
  46    "Executes the SQL command specified by EXPRESSION for the database
  47 specified by DATABASE, which has a default value of
  48 *DEFAULT-DATABASE*. The argument EXPRESSION may be any SQL statement
  49 other than a query. To run a stored procedure, pass an appropriate
  50 string. The call to the procedure needs to be wrapped in a BEGIN END
  51 pair."))
  52
  53 (defmethod execute-command ((sql-expression string)
  54                             &key (database *default-database*))
  55   (record-sql-action sql-expression :command database)
  56   (let ((res (database-execute-command sql-expression database)))
  57     (record-sql-action res :result database))
  58   (values))
  59
  60 (defmacro do-query (((&rest args) query-expression
  61                      &key (database '*default-database*) (result-types nil))
  62                     &body body)
  63   "Repeatedly executes BODY within a binding of ARGS on the attributes
  64 of each record resulting from QUERY. The return value is determined by
  65 the result of executing BODY. The default value of DATABASE is
  66 *DEFAULT-DATABASE*."
  67   (let ((result-set (gensym))
  68         (columns (gensym))
  69         (row (gensym))
  70         (db (gensym)))
  71     `(let ((,db ,database))
  72       (multiple-value-bind (,result-set ,columns)
  73           (database-query-result-set ,query-expression ,db
  74                                      :full-set nil :result-types ,result-types)
  75         (when ,result-set
  76           (unwind-protect
  77                (do ((,row (make-list ,columns)))
  78                    ((not (database-store-next-row ,result-set ,db ,row))
  79                     nil)
  80                  (destructuring-bind ,args ,row
  81                    ,@body))
  82             (database-dump-result-set ,result-set ,db)))))))
  83
  84 (defun map-query (output-type-spec function query-expression
  85                   &key (database *default-database*)
  86                   (result-types nil))
  87   "Map the function over all tuples that are returned by the query in
  88 query-expression.  The results of the function are collected as
  89 specified in output-type-spec and returned like in MAP."
  90   (macrolet ((type-specifier-atom (type)
  91                `(if (atom ,type) ,type (car ,type))))
  92     (case (type-specifier-atom output-type-spec)
  93       ((nil)
  94        (map-query-for-effect function query-expression database result-types))
  95       (list
  96        (map-query-to-list function query-expression database result-types))
  97       ((simple-vector simple-string vector string array simple-array
  98         bit-vector simple-bit-vector base-string
  99         simple-base-string)
 100        (map-query-to-simple output-type-spec function query-expression database result-types))
 101       (t
 102        (funcall #'map-query (cmucl-compat:result-type-or-lose output-type-spec t)
 103               function query-expression :database database :result-types result-types)))))
 104
 105 (defun map-query-for-effect (function query-expression database result-types)
 106   (multiple-value-bind (result-set columns)
 107       (database-query-result-set query-expression database :full-set nil
 108                                  :result-types result-types)
 109     (when result-set
 110       (unwind-protect
 111            (do ((row (make-list columns)))
 112                ((not (database-store-next-row result-set database row))
 113                 nil)
 114              (apply function row))
 115         (database-dump-result-set result-set database)))))
 116
 117 (defun map-query-to-list (function query-expression database result-types)
 118   (multiple-value-bind (result-set columns)
 119       (database-query-result-set query-expression database :full-set nil
 120                                  :result-types result-types)
 121     (when result-set
 122       (unwind-protect
 123            (let ((result (list nil)))
 124              (do ((row (make-list columns))
 125                   (current-cons result (cdr current-cons)))
 126                  ((not (database-store-next-row result-set database row))
 127                   (cdr result))
 128                (rplacd current-cons (list (apply function row)))))
 129         (database-dump-result-set result-set database)))))
 130
 131
 132 (defun map-query-to-simple (output-type-spec function query-expression database result-types)
 133   (multiple-value-bind (result-set columns rows)
 134       (database-query-result-set query-expression database :full-set t
 135                                  :result-types result-types)
 136     (when result-set
 137       (unwind-protect
 138            (if rows
 139                ;; We know the row count in advance, so we allocate once
 140                (do ((result
 141                      (cmucl-compat:make-sequence-of-type output-type-spec rows))
 142                     (row (make-list columns))
 143                     (index 0 (1+ index)))
 144                    ((not (database-store-next-row result-set database row))
 145                     result)
 146                  (declare (fixnum index))
 147                  (setf (aref result index)
 148                        (apply function row)))
 149                ;; Database can't report row count in advance, so we have
 150                ;; to grow and shrink our vector dynamically
 151                (do ((result
 152                      (cmucl-compat:make-sequence-of-type output-type-spec 100))
 153                     (allocated-length 100)
 154                     (row (make-list columns))
 155                     (index 0 (1+ index)))
 156                    ((not (database-store-next-row result-set database row))
 157                     (cmucl-compat:shrink-vector result index))
 158                  (declare (fixnum allocated-length index))
 159                  (when (>= index allocated-length)
 160                    (setq allocated-length (* allocated-length 2)
 161                          result (adjust-array result allocated-length)))
 162                  (setf (aref result index)
 163                        (apply function row))))
 164         (database-dump-result-set result-set database)))))
 165
 166
 167