base/database.lisp

   1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
   2 ;;;; *************************************************************************
   3 ;;;;
   4 ;;;; $Id$
   5 ;;;;
   6 ;;;; Base database 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 (setf (documentation 'database-name 'function)
  18       "Returns the name of a database.")
  19
  20 ;;; Database handling
  21
  22 (defvar *connect-if-exists* :error
  23   "Default value for the if-exists parameter of connect calls.")
  24
  25 (defvar *connected-databases* nil
  26   "List of active database objects.")
  27
  28 (defun connected-databases ()
  29   "Return the list of active database objects."
  30   *connected-databases*)
  31
  32 (defvar *default-database* nil
  33   "Specifies the default database to be used.")
  34
  35 (defun find-database (database &key (errorp t) (db-type nil))
  36   "The function FIND-DATABASE, given a string DATABASE, searches
  37 amongst the connected databases for one matching the name DATABASE. If
  38 there is exactly one such database, it is returned and the second
  39 return value count is 1. If more than one databases match and ERRORP
  40 is nil, then the most recently connected of the matching databases is
  41 returned and count is the number of matches. If no matching database
  42 is found and ERRORP is nil, then nil is returned. If none, or more
  43 than one, matching databases are found and ERRORP is true, then an
  44 error is signalled. If the argument database is a database, it is
  45 simply returned."
  46   (etypecase database
  47     (database
  48      (values database 1))
  49     (string
  50      (let* ((matches (remove-if
  51                       #'(lambda (db)
  52                           (not (and (string= (database-name db) database)
  53                                     (if db-type
  54                                         (equal (database-type db) db-type)
  55                                         t))))
  56                       (connected-databases)))
  57             (count (length matches)))
  58        (if (or (not errorp) (= count 1))
  59            (values (car matches) count)
  60            (cerror "Return nil."
  61                    'clsql-simple-error
  62                    :format-control "There exists ~A database called ~A."
  63                    :format-arguments
  64                    (list (if (zerop count) "no" "more than one")
  65                          database)))))))
  66
  67
  68 (defun connect (connection-spec
  69                 &key (if-exists *connect-if-exists*)
  70                 (make-default t)
  71                 (pool nil)
  72                 (database-type *default-database-type*))
  73   "Connects to a database of the given database-type, using the
  74 type-specific connection-spec.  The value of if-exists determines what
  75 happens if a connection to that database is already established.  A
  76 value of :new means create a new connection.  A value of :warn-new
  77 means warn the user and create a new connect.  A value of :warn-old
  78 means warn the user and use the old connection.  A value of :error
  79 means fail, notifying the user.  A value of :old means return the old
  80 connection.  If make-default is true, then *default-database* is set
  81 to the new connection, otherwise *default-database is not changed. If
  82 pool is t the connection will be taken from the general pool, if pool
  83 is a conn-pool object the connection will be taken from this pool."
  84   (if pool
  85       (acquire-from-pool connection-spec database-type pool)
  86       (let* ((db-name (database-name-from-spec connection-spec database-type))
  87              (old-db (unless (eq if-exists :new)
  88                        (find-database db-name :db-type database-type
  89                                       :errorp nil)))
  90              (result nil))
  91         (if old-db
  92             (ecase if-exists
  93               (:warn-new
  94                (setq result
  95                      (database-connect connection-spec database-type))
  96                (warn 'clsql-exists-warning :old-db old-db :new-db result))
  97               (:error
  98                (restart-case
  99                    (error 'clsql-exists-error :old-db old-db)
 100                  (create-new ()
 101                    :report "Create a new connection."
 102                    (setq result
 103                          (database-connect connection-spec database-type)))
 104                  (use-old ()
 105                    :report "Use the existing connection."
 106                    (setq result old-db))))
 107               (:warn-old
 108                (setq result old-db)
 109                (warn 'clsql-exists-warning :old-db old-db :new-db old-db))
 110               (:old
 111                (setq result old-db)))
 112             (setq result
 113                   (database-connect connection-spec database-type)))
 114         (when result
 115           (pushnew result *connected-databases*)
 116           (when make-default (setq *default-database* result))
 117           result))))
 118
 119
 120 (defun disconnect (&key (database *default-database*) (error nil))
 121
 122   "Closes the connection to DATABASE and resets *default-database* if
 123 that database was disconnected. If database is a database object, then
 124 it is used directly. Otherwise, the list of connected databases is
 125 searched to find one with DATABASE as its connection
 126 specifications. If no such database is found, then if ERROR and
 127 DATABASE are both non-nil an error is signaled, otherwise DISCONNECT
 128 returns nil. If the database is from a pool it will be released to
 129 this pool."
 130   (let ((database (find-database database :errorp (and database error))))
 131     (when database
 132       (if (conn-pool database)
 133           (when (release-to-pool database)
 134             (setf *connected-databases* (delete database *connected-databases*))
 135             (when (eq database *default-database*)
 136               (setf *default-database* (car *connected-databases*)))
 137             t)
 138           (when (database-disconnect database)
 139             (setf *connected-databases* (delete database *connected-databases*))
 140             (when (eq database *default-database*)
 141               (setf *default-database* (car *connected-databases*)))
 142             (change-class database 'closed-database)
 143             t)))))
 144
 145
 146 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 147
 148
 149
 150
 151
 152 (defun reconnect (&key (database *default-database*) (error nil) (force t))
 153   "Reconnects DATABASE to its underlying RDBMS. If successful, returns
 154 t and the variable *default-database* is set to the newly reconnected
 155 database. The default value for DATABASE is *default-database*. If
 156 DATABASE is a database object, then it is used directly. Otherwise,
 157 the list of connected databases is searched to find one with database
 158 as its connection specifications (see CONNECT). If no such database is
 159 found, then if ERROR and DATABASE are both non-nil an error is
 160 signaled, otherwise RECONNECT returns nil. FORCE controls whether an
 161 error should be signaled if the existing database connection cannot be
 162 closed. When non-nil (this is the default value) the connection is
 163 closed without error checking. When FORCE is nil, an error is signaled
 164 if the database connection has been lost."
 165   ;; TODO: just a placeholder
 166   (declare (ignore database error force)))
 167
 168
 169
 170 (defun status (&optional full)
 171   "The function STATUS prints status information to the standard
 172 output, for the connected databases and initialized database types. If
 173 full is T, detailed status information is printed. The default value
 174 of full is NIL."
 175   (declare (ignore full))
 176   ;; TODO: table details if full is true?
 177   (flet ((get-data ()
 178            (let ((data '()))
 179              (dolist (db (connected-databases) data)
 180                (push (list (database-name db)
 181                            (string (database-type db))
 182                            (when (conn-pool db) "T" "NIL")
 183                            (format nil "~A" (length (database-list-tables db)))
 184                            (format nil "~A" (length (database-list-views db)))
 185                            (if (equal db *default-database*) "   *" ""))
 186                      data))))
 187          (compute-sizes (data)
 188            (mapcar #'(lambda (x) (apply #'max (mapcar #'length x)))
 189                    (apply #'mapcar (cons #'list data))))
 190          (print-separator (size)
 191            (format t "~&~A" (make-string size :initial-element #\-))))
 192     (let ((data (get-data)))
 193       (when data
 194         (let* ((titles (list "NAME" "TYPE" "POOLED" "TABLES" "VIEWS" "DEFAULT"))
 195                (sizes (compute-sizes (cons titles data)))
 196                (total-size (+ (apply #'+ sizes) (* 2 (1- (length titles)))))
 197                (control-string (format nil "~~&~~{~{~~~AA  ~}~~}" sizes)))
 198           (print-separator total-size)
 199           (format t control-string titles)
 200           (print-separator total-size)
 201           (dolist (d data) (format t control-string d))
 202           (print-separator total-size))))
 203     (values)))
 204
 205
 206 (defmacro with-database ((db-var connection-spec &rest connect-args) &body body)
 207   "Evaluate the body in an environment, where `db-var' is bound to the
 208 database connection given by `connection-spec' and `connect-args'.
 209 The connection is automatically closed or released to the pool on exit from the body."
 210   (let ((result (gensym "result-")))
 211     (unless db-var (setf db-var '*default-database*))
 212     `(let ((,db-var (connect ,connection-spec ,@connect-args))
 213            (,result nil))
 214       (unwind-protect
 215            (let ((,db-var ,db-var))
 216              (setf ,result (progn ,@body)))
 217         (disconnect :database ,db-var))
 218       ,result)))
 219
 220
 221 (defmacro with-default-database ((database) &rest body)
 222   "Perform BODY with DATABASE bound as *default-database*."
 223   `(progv '(*default-database*)
 224        (list ,database)
 225      ,@body))