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 ;;;; Programmers: Kevin M. Rosenberg based on
8 ;;;; Original code by Pierre R. Mai
9 ;;;; Date Started: Feb 2002
11 ;;;; $Id: postgresql-sql.lisp,v 1.3 2003/07/21 01:45:45 kevin Exp $
13 ;;;; This file, part of CLSQL, is Copyright (c) 2002 by Kevin M. Rosenberg
14 ;;;; and Copyright (c) 1999-2001 by Pierre R. Mai
16 ;;;; CLSQL users are granted the rights to distribute and use this software
17 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
18 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
19 ;;;; *************************************************************************
21 (in-package #:cl-user)
23 (defpackage #:clsql-postgresql
24 (:use #:common-lisp #:clsql-base-sys #:postgresql #:clsql-uffi)
25 (:export #:postgresql-database)
26 (:documentation "This is the CLSQL interface to PostgreSQL."))
28 (in-package #:clsql-postgresql)
30 ;;; Field conversion functions
32 (defun make-type-list-for-auto (num-fields res-ptr)
33 (let ((new-types '()))
34 (dotimes (i num-fields)
36 (let* ((type (PQftype res-ptr i)))
45 ((#.pgsql-ftype#float4
51 (nreverse new-types)))
53 (defun canonicalize-types (types num-fields res-ptr)
56 (let ((auto-list (make-type-list-for-auto num-fields res-ptr)))
59 (canonicalize-type-list types auto-list))
65 (defun tidy-error-message (message)
66 (unless (stringp message)
67 (setq message (uffi:convert-from-foreign-string message)))
68 (let ((message (string-right-trim '(#\Return #\Newline) message)))
70 ((< (length message) (length "ERROR:"))
72 ((string= message "ERROR:" :end1 6)
73 (string-left-trim '(#\Space) (subseq message 6)))
77 (defmethod database-initialize-database-type ((database-type
81 (uffi:def-type pgsql-conn-def pgsql-conn)
82 (uffi:def-type pgsql-result-def pgsql-result)
85 (defclass postgresql-database (database)
86 ((conn-ptr :accessor database-conn-ptr :initarg :conn-ptr
87 :type pgsql-conn-def)))
89 (defmethod database-type ((database postgresql-database))
92 (defmethod database-name-from-spec (connection-spec (database-type
94 (check-connection-spec connection-spec database-type
95 (host db user password &optional port options tty))
96 (destructuring-bind (host db user password &optional port options tty)
98 (declare (ignore password options tty))
99 (concatenate 'string host (if port ":") (if port port) "/" db "/" user)))
102 (defmethod database-connect (connection-spec (database-type (eql :postgresql)))
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)
107 (uffi:with-cstrings ((host-native host)
109 (password-native password)
112 (options-native options)
114 (let ((connection (PQsetdbLogin host-native port-native
115 options-native tty-native
116 db-native user-native
118 (declare (type pgsql-conn-def connection))
119 (when (not (eq (PQstatus connection)
120 pgsql-conn-status-type#connection-ok))
121 (error 'clsql-connect-error
122 :database-type database-type
123 :connection-spec connection-spec
124 :errno (PQstatus connection)
125 :error (tidy-error-message
126 (PQerrorMessage connection))))
127 (make-instance 'postgresql-database
128 :name (database-name-from-spec connection-spec
130 :connection-spec connection-spec
131 :conn-ptr connection)))))
134 (defmethod database-disconnect ((database postgresql-database))
135 (PQfinish (database-conn-ptr database))
136 (setf (database-conn-ptr database) nil)
139 (defmethod database-query (query-expression (database postgresql-database) types)
140 (let ((conn-ptr (database-conn-ptr database)))
141 (declare (type pgsql-conn-def conn-ptr))
142 (uffi:with-cstring (query-native query-expression)
143 (let ((result (PQexec conn-ptr query-native)))
144 (when (uffi:null-pointer-p result)
145 (error 'clsql-sql-error
147 :expression query-expression
149 :error (tidy-error-message (PQerrorMessage conn-ptr))))
151 (case (PQresultStatus result)
152 (#.pgsql-exec-status-type#empty-query
154 (#.pgsql-exec-status-type#tuples-ok
155 (let ((num-fields (PQnfields result)))
157 (canonicalize-types types num-fields
159 (loop for tuple-index from 0 below (PQntuples result)
161 (loop for i from 0 below num-fields
163 (if (zerop (PQgetisnull result tuple-index i))
165 (PQgetvalue result tuple-index i)
169 (error 'clsql-sql-error
171 :expression query-expression
172 :errno (PQresultStatus result)
173 :error (tidy-error-message
174 (PQresultErrorMessage result)))))
175 (PQclear result))))))
177 (defmethod database-execute-command (sql-expression
178 (database postgresql-database))
179 (let ((conn-ptr (database-conn-ptr database)))
180 (declare (type pgsql-conn-def conn-ptr))
181 (uffi:with-cstring (sql-native sql-expression)
182 (let ((result (PQexec conn-ptr sql-native)))
183 (when (uffi:null-pointer-p result)
184 (error 'clsql-sql-error
186 :expression sql-expression
188 :error (tidy-error-message (PQerrorMessage conn-ptr))))
190 (case (PQresultStatus result)
191 (#.pgsql-exec-status-type#command-ok
193 ((#.pgsql-exec-status-type#empty-query
194 #.pgsql-exec-status-type#tuples-ok)
195 (warn "Strange result...")
198 (error 'clsql-sql-error
200 :expression sql-expression
201 :errno (PQresultStatus result)
202 :error (tidy-error-message
203 (PQresultErrorMessage result)))))
204 (PQclear result))))))
206 (defstruct postgresql-result-set
207 (res-ptr (uffi:make-null-pointer 'pgsql-result)
208 :type pgsql-result-def)
210 (num-tuples 0 :type integer)
211 (num-fields 0 :type integer)
212 (tuple-index 0 :type integer))
214 (defmethod database-query-result-set (query-expression (database postgresql-database)
216 (let ((conn-ptr (database-conn-ptr database)))
217 (declare (type pgsql-conn-def conn-ptr))
218 (uffi:with-cstring (query-native query-expression)
219 (let ((result (PQexec conn-ptr query-native)))
220 (when (uffi:null-pointer-p result)
221 (error 'clsql-sql-error
223 :expression query-expression
225 :error (tidy-error-message (PQerrorMessage conn-ptr))))
226 (case (PQresultStatus result)
227 ((#.pgsql-exec-status-type#empty-query
228 #.pgsql-exec-status-type#tuples-ok)
229 (let ((result-set (make-postgresql-result-set
231 :num-fields (PQnfields result)
232 :num-tuples (PQntuples result)
233 :types (canonicalize-types
242 (PQnfields result)))))
245 (error 'clsql-sql-error
247 :expression query-expression
248 :errno (PQresultStatus result)
249 :error (tidy-error-message
250 (PQresultErrorMessage result)))
251 (PQclear result))))))))
253 (defmethod database-dump-result-set (result-set (database postgresql-database))
254 (let ((res-ptr (postgresql-result-set-res-ptr result-set)))
255 (declare (type pgsql-result-def res-ptr))
259 (defmethod database-store-next-row (result-set (database postgresql-database)
261 (let ((result (postgresql-result-set-res-ptr result-set))
262 (types (postgresql-result-set-types result-set)))
263 (declare (type pgsql-result-def result))
264 (if (>= (postgresql-result-set-tuple-index result-set)
265 (postgresql-result-set-num-tuples result-set))
267 (loop with tuple-index = (postgresql-result-set-tuple-index result-set)
268 for i from 0 below (postgresql-result-set-num-fields result-set)
272 (if (zerop (PQgetisnull result tuple-index i))
274 (PQgetvalue result tuple-index i)
278 (incf (postgresql-result-set-tuple-index result-set))
281 ;;; Large objects support (Marc B)
283 (defmethod database-create-large-object ((database postgresql-database))
284 (lo-create (database-conn-ptr database)
285 (logior postgresql::+INV_WRITE+ postgresql::+INV_READ+)))
289 (defmethod database-write-large-object (object-id (data string) (database postgresql-database))
290 (let ((ptr (database-conn-ptr database))
291 (length (length data))
294 (with-transaction (:database database)
297 (setf fd (lo-open ptr object-id postgresql::+INV_WRITE+))
299 (when (= (lo-write ptr fd data length) length)
302 (when (and fd (>= fd 0))
307 (defmethod database-write-large-object (object-id (data string) (database postgresql-database))
308 (let ((ptr (database-conn-ptr database))
309 (length (length data))
312 (database-execute-command "begin" database)
315 (setf fd (lo-open ptr object-id postgresql::+INV_WRITE+))
317 (when (= (lo-write ptr fd data length) length)
320 (when (and fd (>= fd 0))
322 (database-execute-command (if result "commit" "rollback") database)))
325 ;; (MB) the begin/commit/rollback stuff will be removed when with-transaction wil be implemented
326 ;; (KMR) Can't use with-transaction since that function is in high-level code
327 (defmethod database-read-large-object (object-id (database postgresql-database))
328 (let ((ptr (database-conn-ptr database))
335 (database-execute-command "begin" database)
336 (setf fd (lo-open ptr object-id postgresql::+INV_READ+))
338 (setf length (lo-lseek ptr fd 0 2))
339 (lo-lseek ptr fd 0 0)
341 (setf buffer (uffi:allocate-foreign-string
343 (when (= (lo-read ptr fd buffer length) length)
344 (setf result (uffi:convert-from-foreign-string
345 buffer :length length :null-terminated-p nil))))))
347 (when buffer (uffi:free-foreign-object buffer))
348 (when (and fd (>= fd 0)) (lo-close ptr fd))
349 (database-execute-command (if result "commit" "rollback") database)))
352 (defmethod database-delete-large-object (object-id (database postgresql-database))
353 (lo-unlink (database-conn-ptr database) object-id))
355 (when (clsql-base-sys:database-type-library-loaded :postgresql)
356 (clsql-base-sys:initialize-database-type :database-type :postgresql))