1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
3 ;;;; FILE IDENTIFICATION
5 ;;;; Name: postgresql-sql.lisp
6 ;;;; Purpose: High-level PostgreSQL interface using UFFI
7 ;;;; Date Started: Feb 2002
11 ;;;; CLSQL users are granted the rights to distribute and use this software
12 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
13 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
14 ;;;; *************************************************************************
16 (in-package #:cl-user)
18 (defpackage #:clsql-postgresql
19 (:use #:common-lisp #:clsql-base-sys #:postgresql #:clsql-uffi)
20 (:export #:postgresql-database)
21 (:documentation "This is the CLSQL interface to PostgreSQL."))
23 (in-package #:clsql-postgresql)
25 ;;; Field conversion functions
27 (defun make-type-list-for-auto (num-fields res-ptr)
28 (let ((new-types '()))
29 (dotimes (i num-fields)
31 (let* ((type (PQftype res-ptr i)))
40 ((#.pgsql-ftype#float4
46 (nreverse new-types)))
48 (defun canonicalize-types (types num-fields res-ptr)
51 (let ((auto-list (make-type-list-for-auto num-fields res-ptr)))
54 (canonicalize-type-list types auto-list))
60 (defun tidy-error-message (message)
61 (unless (stringp message)
62 (setq message (uffi:convert-from-foreign-string message)))
63 (let ((message (string-right-trim '(#\Return #\Newline) message)))
65 ((< (length message) (length "ERROR:"))
67 ((string= message "ERROR:" :end1 6)
68 (string-left-trim '(#\Space) (subseq message 6)))
72 (defmethod database-initialize-database-type ((database-type
76 (uffi:def-type pgsql-conn-def pgsql-conn)
77 (uffi:def-type pgsql-result-def pgsql-result)
80 (defclass postgresql-database (database)
81 ((conn-ptr :accessor database-conn-ptr :initarg :conn-ptr
82 :type pgsql-conn-def)))
84 (defmethod database-type ((database postgresql-database))
87 (defmethod database-name-from-spec (connection-spec (database-type
89 (check-connection-spec connection-spec database-type
90 (host db user password &optional port options tty))
91 (destructuring-bind (host db user password &optional port options tty)
93 (declare (ignore password options tty))
96 (pathname (namestring host))
102 (integer (write-to-string port))
107 (defmethod database-connect (connection-spec (database-type (eql :postgresql)))
108 (check-connection-spec connection-spec database-type
109 (host db user password &optional port options tty))
110 (destructuring-bind (host db user password &optional port options tty)
112 (uffi:with-cstrings ((host-native host)
114 (password-native password)
117 (options-native options)
119 (let ((connection (PQsetdbLogin host-native port-native
120 options-native tty-native
121 db-native user-native
123 (declare (type pgsql-conn-def connection))
124 (when (not (eq (PQstatus connection)
125 pgsql-conn-status-type#connection-ok))
126 (error 'clsql-connect-error
127 :database-type database-type
128 :connection-spec connection-spec
129 :errno (PQstatus connection)
130 :error (tidy-error-message
131 (PQerrorMessage connection))))
132 (make-instance 'postgresql-database
133 :name (database-name-from-spec connection-spec
135 :connection-spec connection-spec
136 :conn-ptr connection)))))
139 (defmethod database-disconnect ((database postgresql-database))
140 (PQfinish (database-conn-ptr database))
141 (setf (database-conn-ptr database) nil)
144 (defmethod database-query (query-expression (database postgresql-database) types)
145 (let ((conn-ptr (database-conn-ptr database)))
146 (declare (type pgsql-conn-def conn-ptr))
147 (uffi:with-cstring (query-native query-expression)
148 (let ((result (PQexec conn-ptr query-native)))
149 (when (uffi:null-pointer-p result)
150 (error 'clsql-sql-error
152 :expression query-expression
154 :error (tidy-error-message (PQerrorMessage conn-ptr))))
156 (case (PQresultStatus result)
157 (#.pgsql-exec-status-type#empty-query
159 (#.pgsql-exec-status-type#tuples-ok
160 (let ((num-fields (PQnfields result)))
162 (canonicalize-types types num-fields
164 (loop for tuple-index from 0 below (PQntuples result)
166 (loop for i from 0 below num-fields
168 (if (zerop (PQgetisnull result tuple-index i))
170 (PQgetvalue result tuple-index i)
174 (error 'clsql-sql-error
176 :expression query-expression
177 :errno (PQresultStatus result)
178 :error (tidy-error-message
179 (PQresultErrorMessage result)))))
180 (PQclear result))))))
182 (defmethod database-execute-command (sql-expression
183 (database postgresql-database))
184 (let ((conn-ptr (database-conn-ptr database)))
185 (declare (type pgsql-conn-def conn-ptr))
186 (uffi:with-cstring (sql-native sql-expression)
187 (let ((result (PQexec conn-ptr sql-native)))
188 (when (uffi:null-pointer-p result)
189 (error 'clsql-sql-error
191 :expression sql-expression
193 :error (tidy-error-message (PQerrorMessage conn-ptr))))
195 (case (PQresultStatus result)
196 (#.pgsql-exec-status-type#command-ok
198 ((#.pgsql-exec-status-type#empty-query
199 #.pgsql-exec-status-type#tuples-ok)
200 (warn "Strange result...")
203 (error 'clsql-sql-error
205 :expression sql-expression
206 :errno (PQresultStatus result)
207 :error (tidy-error-message
208 (PQresultErrorMessage result)))))
209 (PQclear result))))))
211 (defstruct postgresql-result-set
212 (res-ptr (uffi:make-null-pointer 'pgsql-result)
213 :type pgsql-result-def)
215 (num-tuples 0 :type integer)
216 (num-fields 0 :type integer)
217 (tuple-index 0 :type integer))
219 (defmethod database-query-result-set (query-expression (database postgresql-database)
221 (let ((conn-ptr (database-conn-ptr database)))
222 (declare (type pgsql-conn-def conn-ptr))
223 (uffi:with-cstring (query-native query-expression)
224 (let ((result (PQexec conn-ptr query-native)))
225 (when (uffi:null-pointer-p result)
226 (error 'clsql-sql-error
228 :expression query-expression
230 :error (tidy-error-message (PQerrorMessage conn-ptr))))
231 (case (PQresultStatus result)
232 ((#.pgsql-exec-status-type#empty-query
233 #.pgsql-exec-status-type#tuples-ok)
234 (let ((result-set (make-postgresql-result-set
236 :num-fields (PQnfields result)
237 :num-tuples (PQntuples result)
238 :types (canonicalize-types
247 (PQnfields result)))))
250 (error 'clsql-sql-error
252 :expression query-expression
253 :errno (PQresultStatus result)
254 :error (tidy-error-message
255 (PQresultErrorMessage result)))
256 (PQclear result))))))))
258 (defmethod database-dump-result-set (result-set (database postgresql-database))
259 (let ((res-ptr (postgresql-result-set-res-ptr result-set)))
260 (declare (type pgsql-result-def res-ptr))
264 (defmethod database-store-next-row (result-set (database postgresql-database)
266 (let ((result (postgresql-result-set-res-ptr result-set))
267 (types (postgresql-result-set-types result-set)))
268 (declare (type pgsql-result-def result))
269 (if (>= (postgresql-result-set-tuple-index result-set)
270 (postgresql-result-set-num-tuples result-set))
272 (loop with tuple-index = (postgresql-result-set-tuple-index result-set)
273 for i from 0 below (postgresql-result-set-num-fields result-set)
277 (if (zerop (PQgetisnull result tuple-index i))
279 (PQgetvalue result tuple-index i)
283 (incf (postgresql-result-set-tuple-index result-set))
286 ;;; Large objects support (Marc B)
288 (defmethod database-create-large-object ((database postgresql-database))
289 (lo-create (database-conn-ptr database)
290 (logior postgresql::+INV_WRITE+ postgresql::+INV_READ+)))
294 (defmethod database-write-large-object (object-id (data string) (database postgresql-database))
295 (let ((ptr (database-conn-ptr database))
296 (length (length data))
299 (with-transaction (:database database)
302 (setf fd (lo-open ptr object-id postgresql::+INV_WRITE+))
304 (when (= (lo-write ptr fd data length) length)
307 (when (and fd (>= fd 0))
312 (defmethod database-write-large-object (object-id (data string) (database postgresql-database))
313 (let ((ptr (database-conn-ptr database))
314 (length (length data))
317 (database-execute-command "begin" database)
320 (setf fd (lo-open ptr object-id postgresql::+INV_WRITE+))
322 (when (= (lo-write ptr fd data length) length)
325 (when (and fd (>= fd 0))
327 (database-execute-command (if result "commit" "rollback") database)))
330 ;; (MB) the begin/commit/rollback stuff will be removed when with-transaction wil be implemented
331 ;; (KMR) Can't use with-transaction since that function is in high-level code
332 (defmethod database-read-large-object (object-id (database postgresql-database))
333 (let ((ptr (database-conn-ptr database))
340 (database-execute-command "begin" database)
341 (setf fd (lo-open ptr object-id postgresql::+INV_READ+))
343 (setf length (lo-lseek ptr fd 0 2))
344 (lo-lseek ptr fd 0 0)
346 (setf buffer (uffi:allocate-foreign-string
348 (when (= (lo-read ptr fd buffer length) length)
349 (setf result (uffi:convert-from-foreign-string
350 buffer :length length :null-terminated-p nil))))))
352 (when buffer (uffi:free-foreign-object buffer))
353 (when (and fd (>= fd 0)) (lo-close ptr fd))
354 (database-execute-command (if result "commit" "rollback") database)))
357 (defmethod database-delete-large-object (object-id (database postgresql-database))
358 (lo-unlink (database-conn-ptr database) object-id))
363 (defmethod database-list-objects-of-type ((database postgresql-database)
366 (cond ((stringp owner)
367 (format nil " AND (relowner=(SELECT usesysid FROM pg_user WHERE (usename='~A')))" owner))
369 (format nil " AND (NOT (relowner=1))"))
374 "SELECT relname FROM pg_class WHERE (relkind = '~A')~A"
379 (defmethod database-list-tables ((database postgresql-database)
381 (database-list-objects-of-type database "r" owner))
383 (defmethod database-list-views ((database postgresql-database)
385 (database-list-objects-of-type database "v" owner))
387 (defmethod database-list-indexes ((database postgresql-database)
389 (database-list-objects-of-type database "i" owner))
391 (defmethod database-list-attributes ((table string)
392 (database postgresql-database)
395 (cond ((stringp owner)
396 (format nil " AND (relowner=(SELECT usesysid FROM pg_user WHERE usename='~A'))" owner))
397 ((null owner) " AND (not (relowner=1))")
402 (format nil "SELECT attname FROM pg_class,pg_attribute WHERE pg_class.oid=attrelid AND relname='~A'~A"
403 (string-downcase table)
408 (remove-if #'(lambda (it) (member it '("cmin"
414 ;; kmr -- added tableoid
415 "tableoid") :test #'equal))
418 (defmethod database-attribute-type (attribute (table string)
419 (database postgresql-database)
422 (cond ((stringp owner)
423 (format nil " AND (relowner=(SELECT usesysid FROM pg_user WHERE usename='~A'))" owner))
424 ((null owner) " AND (not (relowner=1))")
429 (format nil "SELECT pg_type.typname 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"
430 (string-downcase table)
431 (string-downcase attribute)
435 (intern (string-upcase (car result)) :keyword))))
437 (defmethod database-create-sequence (sequence-name
438 (database postgresql-database))
439 (database-execute-command
440 (concatenate 'string "CREATE SEQUENCE " (sql-escape sequence-name))
443 (defmethod database-drop-sequence (sequence-name
444 (database postgresql-database))
445 (database-execute-command
446 (concatenate 'string "DROP SEQUENCE " (sql-escape sequence-name)) database))
448 (defmethod database-list-sequences ((database postgresql-database)
450 (database-list-objects-of-type database "S" owner))
452 (defmethod database-set-sequence-position (name (position integer)
453 (database postgresql-database))
458 (format nil "SELECT SETVAL ('~A', ~A)" name position)
461 (defmethod database-sequence-next (sequence-name
462 (database postgresql-database))
467 (concatenate 'string "SELECT NEXTVAL ('" (sql-escape sequence-name) "')")
470 (defmethod database-sequence-last (sequence-name (database postgresql-database))
475 (concatenate 'string "SELECT LAST_VALUE ('" sequence-name "')")
479 ;; Functions depending upon high-level CommonSQL classes/functions
481 (defmethod database-output-sql ((expr clsql-sys::sql-typecast-exp)
482 (database postgresql-database))
483 (with-slots (clsql-sys::modifier clsql-sys::components)
485 (if clsql-sys::modifier
487 (clsql-sys::output-sql clsql-sys::components database)
488 (write-char #\: clsql-sys::*sql-stream*)
489 (write-char #\: clsql-sys::*sql-stream*)
490 (write-string (symbol-name clsql-sys::modifier)
491 clsql-sys::*sql-stream*)))))
493 (defmethod database-output-sql-as-type ((type (eql 'integer)) val
494 (database postgresql-database))
495 (when val ;; typecast it so it uses the indexes
496 (make-instance 'clsql-sys::sql-typecast-exp
501 (when (clsql-base-sys:database-type-library-loaded :postgresql)
502 (clsql-base-sys:initialize-database-type :database-type :postgresql))