;;;; *************************************************************************
;;;; FILE IDENTIFICATION
;;;;
-;;;; Name: postgresql-sql.sql
+;;;; Name: postgresql-sql.lisp
;;;; Purpose: High-level PostgreSQL interface using UFFI
-;;;; Programmers: Kevin M. Rosenberg based on
-;;;; Original code by Pierre R. Mai
;;;; Date Started: Feb 2002
;;;;
-;;;; $Id: postgresql-sql.lisp,v 1.1 2002/09/30 10:19:23 kevin Exp $
-;;;;
-;;;; This file, part of CLSQL, is Copyright (c) 2002 by Kevin M. Rosenberg
-;;;; and Copyright (c) 1999-2001 by Pierre R. Mai
+;;;; $Id$
;;;;
;;;; CLSQL users are granted the rights to distribute and use this software
;;;; as governed by the terms of the Lisp Lesser GNU Public License
;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
;;;; *************************************************************************
-(declaim (optimize (debug 3) (speed 3) (safety 1) (compilation-speed 0)))
-(in-package :cl-user)
+(in-package #:cl-user)
-(defpackage :clsql-postgresql
- (:use :common-lisp :clsql-base-sys :postgresql :clsql-uffi)
+(defpackage #:clsql-postgresql
+ (:use #:common-lisp #:clsql-sys #:postgresql #:clsql-uffi)
(:export #:postgresql-database)
(:documentation "This is the CLSQL interface to PostgreSQL."))
-(in-package :clsql-postgresql)
+(in-package #:clsql-postgresql)
;;; Field conversion functions
(uffi:def-type pgsql-result-def pgsql-result)
-(defclass postgresql-database (database)
+(defclass postgresql-database (generic-postgresql-database)
((conn-ptr :accessor database-conn-ptr :initarg :conn-ptr
- :type pgsql-conn-def)))
+ :type pgsql-conn-def)
+ (lock
+ :accessor database-lock
+ :initform (make-process-lock "conn"))))
(defmethod database-type ((database postgresql-database))
:postgresql)
(destructuring-bind (host db user password &optional port options tty)
connection-spec
(declare (ignore password options tty))
- (concatenate 'string host (if port ":") (if port port) "/" db "/" user)))
+ (concatenate 'string
+ (etypecase host
+ (null "localhost")
+ (pathname (namestring host))
+ (string host))
+ (when port
+ (concatenate 'string
+ ":"
+ (etypecase port
+ (integer (write-to-string port))
+ (string port))))
+ "/" db "/" user)))
(defmethod database-connect (connection-spec (database-type (eql :postgresql)))
(declare (type pgsql-conn-def connection))
(when (not (eq (PQstatus connection)
pgsql-conn-status-type#connection-ok))
- (error 'clsql-connect-error
+ (error 'sql-connection-error
:database-type database-type
:connection-spec connection-spec
- :errno (PQstatus connection)
- :error (tidy-error-message
- (PQerrorMessage connection))))
+ :error-id (PQstatus connection)
+ :message (tidy-error-message
+ (PQerrorMessage connection))))
(make-instance 'postgresql-database
:name (database-name-from-spec connection-spec
database-type)
+ :database-type :postgresql
:connection-spec connection-spec
:conn-ptr connection)))))
(setf (database-conn-ptr database) nil)
t)
-(defmethod database-query (query-expression (database postgresql-database) types)
+(defmethod database-query (query-expression (database postgresql-database) result-types field-names)
(let ((conn-ptr (database-conn-ptr database)))
(declare (type pgsql-conn-def conn-ptr))
(uffi:with-cstring (query-native query-expression)
(let ((result (PQexec conn-ptr query-native)))
(when (uffi:null-pointer-p result)
- (error 'clsql-sql-error
+ (error 'sql-database-data-error
:database database
:expression query-expression
- :errno nil
- :error (tidy-error-message (PQerrorMessage conn-ptr))))
+ :message (tidy-error-message (PQerrorMessage conn-ptr))))
(unwind-protect
(case (PQresultStatus result)
+ ;; User gave a command rather than a query
+ (#.pgsql-exec-status-type#command-ok
+ nil)
(#.pgsql-exec-status-type#empty-query
nil)
(#.pgsql-exec-status-type#tuples-ok
(let ((num-fields (PQnfields result)))
- (setq types
- (canonicalize-types types num-fields
- result))
- (loop for tuple-index from 0 below (PQntuples result)
- collect
- (loop for i from 0 below num-fields
- collect
- (if (zerop (PQgetisnull result tuple-index i))
- (convert-raw-field
- (PQgetvalue result tuple-index i)
- types i)
- nil)))))
+ (when result-types
+ (setq result-types
+ (canonicalize-types result-types num-fields
+ result)))
+ (let ((res (loop for tuple-index from 0 below (PQntuples result)
+ collect
+ (loop for i from 0 below num-fields
+ collect
+ (if (zerop (PQgetisnull result tuple-index i))
+ (convert-raw-field
+ (PQgetvalue result tuple-index i)
+ result-types i)
+ nil)))))
+ (if field-names
+ (values res (result-field-names num-fields result))
+ res))))
(t
- (error 'clsql-sql-error
+ (error 'sql-database-data-error
:database database
:expression query-expression
- :errno (PQresultStatus result)
- :error (tidy-error-message
- (PQresultErrorMessage result)))))
+ :error-id (PQresultStatus result)
+ :message (tidy-error-message
+ (PQresultErrorMessage result)))))
(PQclear result))))))
+(defun result-field-names (num-fields result)
+ "Return list of result field names."
+ (let ((names '()))
+ (dotimes (i num-fields (nreverse names))
+ (declare (fixnum i))
+ (push (uffi:convert-from-cstring (PQfname result i)) names))))
+
(defmethod database-execute-command (sql-expression
(database postgresql-database))
(let ((conn-ptr (database-conn-ptr database)))
(uffi:with-cstring (sql-native sql-expression)
(let ((result (PQexec conn-ptr sql-native)))
(when (uffi:null-pointer-p result)
- (error 'clsql-sql-error
+ (error 'sql-database-data-error
:database database
:expression sql-expression
- :errno nil
- :error (tidy-error-message (PQerrorMessage conn-ptr))))
+ :message (tidy-error-message (PQerrorMessage conn-ptr))))
(unwind-protect
(case (PQresultStatus result)
(#.pgsql-exec-status-type#command-ok
(warn "Strange result...")
t)
(t
- (error 'clsql-sql-error
+ (error 'sql-database-data-error
:database database
:expression sql-expression
- :errno (PQresultStatus result)
- :error (tidy-error-message
- (PQresultErrorMessage result)))))
+ :error-id (PQresultStatus result)
+ :message (tidy-error-message
+ (PQresultErrorMessage result)))))
(PQclear result))))))
(defstruct postgresql-result-set
(num-fields 0 :type integer)
(tuple-index 0 :type integer))
-(defmethod database-query-result-set (query-expression (database postgresql-database)
- &key full-set types)
+(defmethod database-query-result-set ((query-expression string)
+ (database postgresql-database)
+ &key full-set result-types)
(let ((conn-ptr (database-conn-ptr database)))
(declare (type pgsql-conn-def conn-ptr))
(uffi:with-cstring (query-native query-expression)
(let ((result (PQexec conn-ptr query-native)))
(when (uffi:null-pointer-p result)
- (error 'clsql-sql-error
+ (error 'sql-database-data-error
:database database
:expression query-expression
- :errno nil
- :error (tidy-error-message (PQerrorMessage conn-ptr))))
+ :message (tidy-error-message (PQerrorMessage conn-ptr))))
(case (PQresultStatus result)
((#.pgsql-exec-status-type#empty-query
#.pgsql-exec-status-type#tuples-ok)
:num-fields (PQnfields result)
:num-tuples (PQntuples result)
:types (canonicalize-types
- types
+ result-types
(PQnfields result)
result))))
(if full-set
(PQnfields result)))))
(t
(unwind-protect
- (error 'clsql-sql-error
+ (error 'sql-database-data-error
:database database
:expression query-expression
- :errno (PQresultStatus result)
- :error (tidy-error-message
- (PQresultErrorMessage result)))
+ :error-id (PQresultStatus result)
+ :message (tidy-error-message
+ (PQresultErrorMessage result)))
(PQclear result))))))))
(defmethod database-dump-result-set (result-set (database postgresql-database))
(defmethod database-delete-large-object (object-id (database postgresql-database))
(lo-unlink (database-conn-ptr database) object-id))
-(when (clsql-base-sys:database-type-library-loaded :postgresql)
- (clsql-base-sys:initialize-database-type :database-type :postgresql)
- (pushnew :postgresql cl:*features*))
+
+;;; Object listing
+
+
+
+(defmethod database-create (connection-spec (type (eql :postgresql)))
+ (destructuring-bind (host name user password) connection-spec
+ (declare (ignore user password))
+ (multiple-value-bind (output status)
+ (clsql-sys:command-output "createdb -h~A ~A"
+ (if host host "localhost")
+ name)
+ (if (or (not (zerop status))
+ (search "database creation failed: ERROR:" output))
+ (error 'sql-database-error
+ :message
+ (format nil "createdb failed for postgresql backend with connection spec ~A."
+ connection-spec))
+ t))))
+
+(defmethod database-destroy (connection-spec (type (eql :postgresql)))
+ (destructuring-bind (host name user password) connection-spec
+ (declare (ignore user password))
+ (multiple-value-bind (output status)
+ (clsql-sys:command-output "dropdb -h~A ~A"
+ (if host host "localhost")
+ name)
+ (if (or (not (zerop status))
+ (search "database removal failed: ERROR:" output))
+ (error 'sql-database-error
+ :message
+ (format nil "dropdb failed for postgresql backend with connection spec ~A."
+ connection-spec))
+ t))))
+
+
+(defmethod database-probe (connection-spec (type (eql :postgresql)))
+ (when (find (second connection-spec) (database-list connection-spec type)
+ :key #'car :test #'string-equal)
+ t))
+
+
+(defun %pg-database-connection (connection-spec)
+ (check-connection-spec connection-spec :postgresql
+ (host db user password &optional port options tty))
+ (macrolet ((coerce-string (var)
+ `(unless (typep ,var 'simple-base-string)
+ (setf ,var (coerce ,var 'simple-base-string)))))
+ (destructuring-bind (host db user password &optional port options tty)
+ connection-spec
+ (coerce-string db)
+ (coerce-string user)
+ (let ((connection (PQsetdbLogin host port options tty db user password)))
+ (declare (type postgresql::pgsql-conn-ptr connection))
+ (unless (eq (PQstatus connection)
+ pgsql-conn-status-type#connection-ok)
+ ;; Connect failed
+ (error 'sql-connection-error
+ :database-type :postgresql
+ :connection-spec connection-spec
+ :error-id (PQstatus connection)
+ :message (PQerrorMessage connection)))
+ connection))))
+
+(defmethod database-reconnect ((database postgresql-database))
+ (let ((lock (database-lock database)))
+ (with-process-lock (lock "Reconnecting")
+ (with-slots (connection-spec conn-ptr)
+ database
+ (setf conn-ptr (%pg-database-connection connection-spec))
+ database))))
+
+;;; Database capabilities
+
+(when (clsql-sys:database-type-library-loaded :postgresql)
+ (clsql-sys:initialize-database-type :database-type :postgresql))
projects / clsql.git / blobdiff