;;;; *************************************************************************
;;;; 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
(defclass postgresql-database (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)))
(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)
nil)
(#.pgsql-exec-status-type#tuples-ok
(let ((num-fields (PQnfields result)))
- (setq types
- (canonicalize-types types num-fields
+ (setq result-types
+ (canonicalize-types result-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)))))
+ (values
+ (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)))
+ (when field-names
+ (result-field-names num-fields result)))))
(t
(error 'clsql-sql-error
:database database
(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)))
(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)
:num-fields (PQnfields result)
:num-tuples (PQntuples result)
:types (canonicalize-types
- types
+ result-types
(PQnfields result)
result))))
(if full-set
(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
+
+(defun owner-clause (owner)
+ (cond
+ ((stringp owner)
+ (format
+ nil
+ " AND (relowner=(SELECT usesysid FROM pg_user WHERE (usename='~A')))"
+ owner))
+ ((null owner)
+ (format nil " AND (NOT (relowner=1))"))
+ (t "")))
+
+(defun database-list-objects-of-type (database type owner)
+ (mapcar #'car
+ (database-query
+ (format nil
+ "SELECT relname FROM pg_class WHERE (relkind = '~A')~A"
+ type
+ (owner-clause owner))
+ database nil nil)))
+
+(defmethod database-list-tables ((database postgresql-database)
+ &key (owner nil))
+ (database-list-objects-of-type database "r" owner))
+
+(defmethod database-list-views ((database postgresql-database)
+ &key (owner nil))
+ (database-list-objects-of-type database "v" owner))
+
+(defmethod database-list-indexes ((database postgresql-database)
+ &key (owner nil))
+ (database-list-objects-of-type database "i" owner))
+
+
+(defmethod database-list-table-indexes (table (database postgresql-database)
+ &key (owner nil))
+ (let ((indexrelids
+ (database-query
+ (format
+ nil
+ "select indexrelid from pg_index where indrelid=(select relfilenode from pg_class where relname='~A'~A)"
+ (string-downcase table)
+ (owner-clause owner))
+ database :auto nil))
+ (result nil))
+ (dolist (indexrelid indexrelids (nreverse result))
+ (push
+ (caar (database-query
+ (format nil "select relname from pg_class where relfilenode='~A'"
+ (car indexrelid))
+ database nil nil))
+ result))))
+
+(defmethod database-list-attributes ((table string)
+ (database postgresql-database)
+ &key (owner nil))
+ (let* ((owner-clause
+ (cond ((stringp owner)
+ (format nil " AND (relowner=(SELECT usesysid FROM pg_user WHERE usename='~A'))" owner))
+ ((null owner) " AND (not (relowner=1))")
+ (t "")))
+ (result
+ (mapcar #'car
+ (database-query
+ (format nil "SELECT attname FROM pg_class,pg_attribute WHERE pg_class.oid=attrelid AND relname='~A'~A"
+ (string-downcase table)
+ owner-clause)
+ database nil nil))))
+ (if result
+ (reverse
+ (remove-if #'(lambda (it) (member it '("cmin"
+ "cmax"
+ "xmax"
+ "xmin"
+ "oid"
+ "ctid"
+ ;; kmr -- added tableoid
+ "tableoid") :test #'equal))
+ result)))))
+
+(defmethod database-attribute-type (attribute (table string)
+ (database postgresql-database)
+ &key (owner nil))
+ (let ((row (car (database-query
+ (format nil "SELECT pg_type.typname,pg_attribute.attlen,pg_attribute.atttypmod,pg_attribute.attnotnull FROM pg_type,pg_class,pg_attribute WHERE pg_class.oid=pg_attribute.attrelid AND pg_class.relname='~A' AND pg_attribute.attname='~A' AND pg_attribute.atttypid=pg_type.oid~A"
+ (string-downcase table)
+ (string-downcase attribute)
+ (owner-clause owner))
+ database nil nil))))
+ (when row
+ (values
+ (ensure-keyword (first row))
+ (if (string= "-1" (second row))
+ (- (parse-integer (third row) :junk-allowed t) 4)
+ (parse-integer (second row)))
+ nil
+ (if (string-equal "f" (fourth row))
+ 1
+ 0)))))
+
+(defmethod database-create-sequence (sequence-name
+ (database postgresql-database))
+ (database-execute-command
+ (concatenate 'string "CREATE SEQUENCE " (sql-escape sequence-name))
+ database))
+
+(defmethod database-drop-sequence (sequence-name
+ (database postgresql-database))
+ (database-execute-command
+ (concatenate 'string "DROP SEQUENCE " (sql-escape sequence-name)) database))
+
+(defmethod database-list-sequences ((database postgresql-database)
+ &key (owner nil))
+ (database-list-objects-of-type database "S" owner))
+
+(defmethod database-set-sequence-position (name (position integer)
+ (database postgresql-database))
+ (values
+ (parse-integer
+ (caar
+ (database-query
+ (format nil "SELECT SETVAL ('~A', ~A)" name position)
+ database nil nil)))))
+
+(defmethod database-sequence-next (sequence-name
+ (database postgresql-database))
+ (values
+ (parse-integer
+ (caar
+ (database-query
+ (concatenate 'string "SELECT NEXTVAL ('" (sql-escape sequence-name) "')")
+ database nil nil)))))
+
+(defmethod database-sequence-last (sequence-name (database postgresql-database))
+ (values
+ (parse-integer
+ (caar
+ (database-query
+ (concatenate 'string "SELECT LAST_VALUE ('" sequence-name "')")
+ database nil nil)))))
+
+(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 'clsql-access-error
+ :connection-spec connection-spec
+ :database-type type
+ :error
+ (format nil "database-create failed: ~A"
+ output))
+ 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 'clsql-access-error
+ :connection-spec connection-spec
+ :database-type type
+ :error
+ (format nil "database-destory failed: ~A"
+ output))
+ 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))
+
+(defmethod database-list (connection-spec (type (eql :postgresql)))
+ (destructuring-bind (host name user password) connection-spec
+ (declare (ignore name))
+ (let ((database (database-connect (list host "template1" user password)
+ type)))
+ (unwind-protect
+ (progn
+ (setf (slot-value database 'clsql-sys::state) :open)
+ (mapcar #'car (database-query "select datname from pg_database"
+ database nil nil)))
+ (progn
+ (database-disconnect database)
+ (setf (slot-value database 'clsql-sys::state) :closed))))))
+
+(defmethod database-describe-table ((database postgresql-database) table)
+ (database-query
+ (format nil "select a.attname, t.typname
+ from pg_class c, pg_attribute a, pg_type t
+ where c.relname = '~a'
+ and a.attnum > 0
+ and a.attrelid = c.oid
+ and a.atttypid = t.oid"
+ (sql-escape (string-downcase table)))
+ database :auto nil))
+
+(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) :connection-ok)
+ ;; Connect failed
+ (error 'clsql-connect-error
+ :database-type :postgresql
+ :connection-spec connection-spec
+ :errno (PQstatus connection)
+ :error (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
+
+(defmethod db-type-has-fancy-math? ((db-type (eql :postgresql)))
+ t)
+
+(defmethod db-type-default-case ((db-type (eql :postgresql)))
+ :lower)
+
+(when (clsql-sys:database-type-library-loaded :postgresql)
+ (clsql-sys:initialize-database-type :database-type :postgresql))