db-postgresql-socket3/sql.lisp

   1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
   2 ;;;; *************************************************************************
   3 ;;;; FILE IDENTIFICATION
   4 ;;;;
   5 ;;;; Name:     postgresql-socket-sql.sql
   6 ;;;; Purpose:  High-level PostgreSQL interface using socket
   7 ;;;; Authors:  Kevin M. Rosenberg based on original code by Pierre R. Mai
   8 ;;;; Created:  Feb 2002
   9 ;;;;
  10 ;;;; $Id$
  11 ;;;;
  12 ;;;; This file, part of CLSQL, is Copyright (c) 2002-2007 by Kevin M. Rosenberg
  13 ;;;; and Copyright (c) 1999-2001 by Pierre R. Mai
  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 #:cl-user)
  21
  22 (defpackage :clsql-postgresql-socket3
  23     (:use #:common-lisp #:clsql-sys #:postgresql-socket3)
  24     (:export #:postgresql-socket3-database)
  25     (:documentation "This is the CLSQL socket interface (protocol version 3) to PostgreSQL."))
  26
  27 (in-package #:clsql-postgresql-socket3)
  28
  29 (defvar *sqlreader* (cl-postgres:copy-sql-readtable))
  30 (let ((dt-fn (lambda (useconds-since-2000)
  31                (let ((sec (truncate
  32                            (/ useconds-since-2000
  33                               1000000)))
  34                      (usec (mod useconds-since-2000
  35                                 1000000)))
  36                  (clsql:make-time :year 2000 :second sec :usec usec)))))
  37   (cl-postgres:set-sql-datetime-readers
  38    :table *sqlreader*
  39    :date (lambda (days-since-2000)
  40            (clsql:make-date :year 2000 :day (+ 1 days-since-2000)))
  41    :timestamp dt-fn
  42    :timestamp-with-timezone dt-fn))
  43
  44
  45
  46 ;; interface foreign library loading routines
  47
  48 (clsql-sys:database-type-load-foreign :postgresql-socket3)
  49
  50
  51 (defmethod database-initialize-database-type ((database-type
  52                                                (eql :postgresql-socket3)))
  53   t)
  54
  55
  56 ;; Field type conversion
  57 (defun convert-to-clsql-warning (database condition)
  58   (ecase *backend-warning-behavior*
  59     (:warn
  60      (warn 'sql-database-warning :database database
  61            :message (cl-postgres:database-error-message condition)))
  62     (:error
  63      (error 'sql-database-error :database database
  64             :message (format nil "Warning upgraded to error: ~A"
  65                              (cl-postgres:database-error-message condition))))
  66     ((:ignore nil)
  67      ;; do nothing
  68      )))
  69
  70 (defun convert-to-clsql-error (database expression condition)
  71   (error 'sql-database-data-error
  72          :database database
  73          :expression expression
  74          :error-id (type-of condition)
  75          :message (cl-postgres:database-error-message condition)))
  76
  77 (defmacro with-postgresql-handlers
  78     ((database &optional expression)
  79      &body body)
  80   (let ((database-var (gensym))
  81         (expression-var (gensym)))
  82     `(let ((,database-var ,database)
  83            (,expression-var ,expression))
  84        (handler-bind ((postgresql-warning
  85                        (lambda (c)
  86                          (convert-to-clsql-warning ,database-var c)))
  87                       (cl-postgres:database-error
  88                        (lambda (c)
  89                          (convert-to-clsql-error
  90                           ,database-var ,expression-var c))))
  91          ,@body))))
  92
  93
  94
  95 (defclass postgresql-socket3-database (generic-postgresql-database)
  96   ((connection :accessor database-connection :initarg :connection
  97                :type cl-postgres:database-connection)))
  98
  99 (defmethod database-type ((database postgresql-socket3-database))
 100   :postgresql-socket3)
 101
 102 (defmethod database-name-from-spec (connection-spec (database-type (eql :postgresql-socket3)))
 103   (check-connection-spec connection-spec database-type
 104                          (host db user password &optional port options tty))
 105   (destructuring-bind (host db user password &optional port options tty)
 106       connection-spec
 107     (declare (ignore password options tty))
 108     (concatenate 'string
 109       (etypecase host
 110         (null
 111          "localhost")
 112         (pathname (namestring host))
 113         (string host))
 114       (when port
 115         (concatenate 'string
 116                      ":"
 117                      (etypecase port
 118                        (integer (write-to-string port))
 119                        (string port))))
 120       "/" db "/" user)))
 121
 122 (defmethod database-connect (connection-spec
 123                              (database-type (eql :postgresql-socket3)))
 124   (check-connection-spec connection-spec database-type
 125                          (host db user password &optional port options tty))
 126   (destructuring-bind (host db user password &optional
 127                             (port +postgresql-server-default-port+)
 128                             (options "") (tty ""))
 129       connection-spec
 130     (declare (ignore options tty))
 131     (handler-case
 132         (handler-bind ((warning
 133                         (lambda (c)
 134                           (warn 'sql-warning
 135                                 :format-control "~A"
 136                                 :format-arguments
 137                                 (list (princ-to-string c))))))
 138           (cl-postgres:open-database db user password host port))
 139       (cl-postgres:database-error (c)
 140         ;; Connect failed
 141         (error 'sql-connection-error
 142                :database-type database-type
 143                :connection-spec connection-spec
 144                :error-id (type-of c)
 145                :message (cl-postgres:database-error-message c)))
 146       (:no-error (connection)
 147                  ;; Success, make instance
 148                  (make-instance 'postgresql-socket3-database
 149                                 :name (database-name-from-spec connection-spec database-type)
 150                                 :database-type :postgresql-socket3
 151                                 :connection-spec connection-spec
 152                                 :connection connection)))))
 153
 154 (defmethod database-disconnect ((database postgresql-socket3-database))
 155   (cl-postgres:close-database (database-connection database))
 156   t)
 157
 158 (defvar *include-field-names* nil)
 159
 160
 161 ;; THE FOLLOWING MACRO EXPANDS TO THE FUNCTION BELOW IT,
 162 ;; BUT TO GET null CONVENTIONS CORRECT I NEEDED TO TWEAK THE EXPANSION
 163 ;;
 164 ;; (cl-postgres:def-row-reader clsql-default-row-reader (fields)
 165 ;;   (values (loop :while (cl-postgres:next-row)
 166 ;;              :collect (loop :for field :across fields
 167 ;;                             :collect (cl-postgres:next-field field)))
 168 ;;        (when *include-field-names*
 169 ;;          (loop :for field :across fields
 170 ;;                :collect (cl-postgres:field-name field)))))
 171
 172
 173
 174 (defun clsql-default-row-reader (stream fields)
 175   (declare (type stream stream)
 176            (type (simple-array cl-postgres::field-description) fields))
 177   (flet ((cl-postgres:next-row ()
 178            (cl-postgres::look-for-row stream))
 179          (cl-postgres:next-field (cl-postgres::field)
 180            (declare (type cl-postgres::field-description cl-postgres::field))
 181            (let ((cl-postgres::size (cl-postgres::read-int4 stream)))
 182              (declare (type (signed-byte 32) cl-postgres::size))
 183              (if (eq cl-postgres::size -1)
 184                  nil
 185                  (funcall (cl-postgres::field-interpreter cl-postgres::field)
 186                           stream cl-postgres::size)))))
 187     (let ((results (loop :while (cl-postgres:next-row)
 188                          :collect (loop :for field :across fields
 189                                         :collect (cl-postgres:next-field field))))
 190           (col-names (when *include-field-names*
 191                        (loop :for field :across fields
 192                              :collect (cl-postgres:field-name field)))))
 193       ;;multiple return values were not working here
 194       (list results col-names))))
 195
 196 (defmethod database-query ((expression string) (database postgresql-socket3-database) result-types field-names)
 197   (let ((connection (database-connection database))
 198         (cl-postgres:*sql-readtable* *sqlreader*))
 199     (with-postgresql-handlers (database expression)
 200       (let ((*include-field-names* field-names))
 201         (apply #'values (cl-postgres:exec-query connection expression #'clsql-default-row-reader)))
 202       )))
 203
 204 (defmethod query ((obj command-object) &key (database *default-database*)
 205                   (result-types :auto) (flatp nil) (field-names t))
 206   (clsql-sys::record-sql-command
 207    (format nil "~&~A~&{Params: ~{~A~^, ~}}"
 208            (expression obj)
 209            (parameters obj))
 210    database)
 211   (multiple-value-bind (rows names)
 212       (database-query obj database result-types field-names)
 213     (let ((result (if (and flatp (= 1 (length (car rows))))
 214                       (mapcar #'car rows)
 215                       rows)))
 216       (clsql-sys::record-sql-result result database)
 217       (if field-names
 218           (values result names)
 219           result))))
 220
 221 (defmethod database-query ((obj command-object) (database postgresql-socket3-database) result-types field-names)
 222   (let ((connection (database-connection database))
 223         (cl-postgres:*sql-readtable* *sqlreader*))
 224     (with-postgresql-handlers (database obj)
 225       (let ((*include-field-names* field-names))
 226         (unless (has-been-prepared obj)
 227           (cl-postgres:prepare-query connection (prepared-name obj) (expression obj))
 228           (setf (has-been-prepared obj) T))
 229         (apply #'values (cl-postgres:exec-prepared
 230                          connection
 231                          (prepared-name obj)
 232                          (parameters obj)
 233                          #'clsql-default-row-reader))))))
 234
 235 (defmethod database-execute-command
 236     ((expression string) (database postgresql-socket3-database))
 237   (let ((connection (database-connection database)))
 238     (with-postgresql-handlers (database expression)
 239       ;; return row count?
 240       (second (multiple-value-list (cl-postgres:exec-query connection expression))))))
 241
 242 (defmethod execute-command ((obj command-object)
 243                             &key (database *default-database*))
 244   (clsql-sys::record-sql-command (expression obj) database)
 245   (let ((res (database-execute-command obj database)))
 246     (clsql-sys::record-sql-result res database)
 247     ;; return row count?
 248     res))
 249
 250 (defmethod database-execute-command
 251     ((obj command-object) (database postgresql-socket3-database))
 252   (let ((connection (database-connection database)))
 253     (with-postgresql-handlers (database obj)
 254       (unless (has-been-prepared obj)
 255         (cl-postgres:prepare-query connection (prepared-name obj) (expression obj))
 256         (setf (has-been-prepared obj) T))
 257       (second (multiple-value-list (cl-postgres:exec-prepared connection (prepared-name obj) (parameters obj)))))))
 258
 259 ;;;; Cursoring interface
 260
 261
 262 (defmethod database-query-result-set ((expression string)
 263                                       (database postgresql-socket3-database)
 264                                       &key full-set result-types)
 265   (declare (ignore result-types))
 266   (declare (ignore full-set))
 267   (error "Cursoring interface is not supported for postgresql-socket3-database try cl-postgres:exec-query with a custom row-reader"))
 268
 269 (defmethod database-dump-result-set (result-set
 270                                      (database postgresql-socket3-database))
 271   (error "Cursoring interface is not supported for postgresql-socket3-database try cl-postgres:exec-query with a custom row-reader")
 272   T)
 273
 274 (defmethod database-store-next-row (result-set
 275                                     (database postgresql-socket3-database)
 276                                     list)
 277   (error "Cursoring interface is not supported for postgresql-socket3-database try cl-postgres:exec-query with a custom row-reader"))
 278
 279
 280 ;;;;;;;;;;;;;;;;;;;;;;;;;;
 281
 282
 283 (defmethod database-create (connection-spec (type (eql :postgresql-socket3)))
 284   (destructuring-bind (host name user password &optional port options tty) connection-spec
 285     (declare (ignore port options tty))
 286     (let ((database (database-connect (list host "postgres" user password)
 287                                       type)))
 288       (setf (slot-value database 'clsql-sys::state) :open)
 289       (unwind-protect
 290            (database-execute-command (format nil "create database ~A" name) database)
 291         (database-disconnect database)))))
 292
 293 (defmethod database-destroy (connection-spec (type (eql :postgresql-socket3)))
 294   (destructuring-bind (host name user password &optional port options tty) connection-spec
 295     (declare (ignore port options tty))
 296     (let ((database (database-connect (list host "postgres" user password)
 297                                       type)))
 298       (setf (slot-value database 'clsql-sys::state) :open)
 299       (unwind-protect
 300           (database-execute-command (format nil "drop database ~A" name) database)
 301         (database-disconnect database)))))
 302
 303
 304 (defmethod database-probe (connection-spec (type (eql :postgresql-socket3)))
 305   (when (find (second connection-spec) (database-list connection-spec type)
 306               :test #'string-equal)
 307     t))
 308
 309
 310 ;; Database capabilities
 311
 312 (defmethod db-backend-has-create/destroy-db? ((db-type (eql :postgresql-socket3)))
 313   nil)
 314
 315 (defmethod db-type-has-fancy-math? ((db-type (eql :postgresql-socket3)))
 316   t)
 317
 318 (defmethod db-type-default-case ((db-type (eql :postgresql-socket3)))
 319   :lower)
 320
 321 (defmethod database-underlying-type ((database postgresql-socket3-database))
 322   :postgresql)
 323
 324 (when (clsql-sys:database-type-library-loaded :postgresql-socket3)
 325   (clsql-sys:initialize-database-type :database-type :postgresql-socket3))
 326
 327