1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
3 ;;;; FILE IDENTIFICATION
5 ;;;; Name: mysql-sql.cl
6 ;;;; Purpose: High-level MySQL interface using UFFI
7 ;;;; Programmers: Kevin M. Rosenberg based on
8 ;;;; Original code by Pierre R. Mai
9 ;;;; Date Started: Feb 2002
11 ;;;; $Id: mysql-sql.cl,v 1.9 2002/03/25 14:26:23 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 (declaim (optimize (debug 3) (speed 3) (safety 1) (compilation-speed 0)))
23 ;;;; Modified by Kevin Rosenberg, Feb 20002
24 ;;;; -- Added support for Allegro CL and Lispworks using UFFI layer
25 ;;;; -- Changed database-connect to use mysql-real-connect. This way,
26 ;;;; can avoid using double (unwind-protect)
27 ;;;; -- Changed database-connect to have MySQL library allocate space
28 ;;;; for MYSQL structure. This will make the code more robust in
29 ;;;; the event that MySQL library changes the size of the mysql-mysql
33 ;;;; Added field types
35 (defpackage :clsql-mysql
36 (:use :common-lisp :clsql-sys :mysql)
37 (:export #:mysql-database)
38 (:documentation "This is the CLSQL interface to MySQL."))
40 (in-package :clsql-mysql)
42 ;;; Field conversion functions
44 (defun canonicalize-field-types (types num-fields res-ptr)
47 (let ((length-types (length types))
49 (loop for i from 0 below num-fields
51 (if (>= i length-types)
52 (push t new-types) ;; types is shorted than num-fields
55 ((:int :long :double t)
60 (nreverse new-types))))
63 #+ignore (field-vec (mysql-fetch-fields res-ptr)))
64 (dotimes (i num-fields)
66 (let* ( (field (mysql-fetch-field-direct res-ptr i))
67 #+ignore (field (uffi:deref-array field-vec 'mysql-field-vector i))
68 (type (uffi:get-slot-value field 'mysql-field 'type)))
71 ((#.mysql-field-types#tiny
72 #.mysql-field-types#short
73 #.mysql-field-types#int24
74 #.mysql-field-types#long)
76 ((#.mysql-field-types#double
77 #.mysql-field-types#float
78 #.mysql-field-types#decimal)
83 (nreverse new-types)))
87 (uffi:def-function "atoi"
91 (uffi:def-function "atol"
95 (uffi:def-function "atof"
99 (defun convert-raw-field (char-ptr types index)
100 (let ((type (if (listp types)
111 (uffi:convert-from-foreign-string char-ptr)))))
113 (defmethod database-initialize-database-type ((database-type (eql :mysql)))
116 (uffi:def-type mysql-mysql-ptr-def (* mysql-mysql))
117 (uffi:def-type mysql-row-def mysql-row)
118 (uffi:def-type mysql-mysql-res-ptr-def (* mysql-mysql-res))
120 (defclass mysql-database (database)
121 ((mysql-ptr :accessor database-mysql-ptr :initarg :mysql-ptr
122 :type mysql-mysql-ptr-def)))
124 (defmethod database-name-from-spec (connection-spec (database-type (eql :mysql)))
125 (check-connection-spec connection-spec database-type (host db user password))
126 (destructuring-bind (host db user password) connection-spec
127 (declare (ignore password))
128 (concatenate 'string host "/" db "/" user)))
131 (defmethod database-connect (connection-spec (database-type (eql :mysql)))
132 (check-connection-spec connection-spec database-type (host db user password))
133 (destructuring-bind (host db user password) connection-spec
134 (let ((mysql-ptr (mysql-init (uffi:make-null-pointer 'mysql-mysql)))
136 (if (uffi:null-pointer-p mysql-ptr)
137 (error 'clsql-connect-error
138 :database-type database-type
139 :connection-spec connection-spec
140 :errno (mysql-errno mysql-ptr)
141 :error (mysql-error-string mysql-ptr))
142 (uffi:with-cstrings ((host-native host)
144 (password-native password)
146 (socket-native socket))
147 (let ((error-occurred nil))
149 (if (uffi:null-pointer-p
151 mysql-ptr host-native user-native password-native
152 db-native 0 socket-native 0))
154 (setq error-occurred t)
155 (error 'clsql-connect-error
156 :database-type database-type
157 :connection-spec connection-spec
158 :errno (mysql-errno mysql-ptr)
159 :error (mysql-error-string mysql-ptr)))
160 (make-instance 'mysql-database
161 :name (database-name-from-spec connection-spec
163 :mysql-ptr mysql-ptr))
164 (when error-occurred (mysql-close mysql-ptr)))))))))
167 (defmethod database-disconnect ((database mysql-database))
168 (mysql-close (database-mysql-ptr database))
169 (setf (database-mysql-ptr database) nil)
173 (defmethod database-query (query-expression (database mysql-database)
175 (with-slots (mysql-ptr) database
176 (uffi:with-cstring (query-native query-expression)
177 (if (zerop (mysql-query mysql-ptr query-native))
178 (let ((res-ptr (mysql-use-result mysql-ptr)))
180 (let ((num-fields (mysql-num-fields res-ptr)))
181 (setq field-types (canonicalize-field-types
182 field-types num-fields
185 (loop for row = (mysql-fetch-row res-ptr)
186 until (uffi:null-pointer-p row)
188 (loop for i from 0 below num-fields
190 (uffi:convert-from-foreign-string
191 (uffi:deref-array row 'mysql-row i))))
192 (mysql-free-result res-ptr)))
193 (error 'clsql-sql-error
195 :expression query-expression
196 :errno (mysql-errno mysql-ptr)
197 :error (mysql-error-string mysql-ptr))))
198 (error 'clsql-sql-error
200 :expression query-expression
201 :errno (mysql-errno mysql-ptr)
202 :error (mysql-error-string mysql-ptr))))))
204 (defmethod database-execute-command (sql-expression (database mysql-database))
205 (uffi:with-cstring (sql-native sql-expression)
206 (let ((mysql-ptr (database-mysql-ptr database)))
207 (declare (type mysql-mysql-ptr-def mysql-ptr))
208 (if (zerop (mysql-query mysql-ptr sql-native))
210 (error 'clsql-sql-error
212 :expression sql-expression
213 :errno (mysql-errno mysql-ptr)
214 :error (mysql-error-string mysql-ptr))))))
216 (defstruct mysql-result-set
217 (res-ptr (uffi:make-null-pointer 'mysql-mysql-res)
218 :type mysql-mysql-res-ptr-def)
220 (num-fields nil :type fixnum)
221 (full-set nil :type boolean))
224 (defmethod database-query-result-set (query-expression
225 (database mysql-database)
226 &key full-set field-types)
227 (uffi:with-cstring (query-native query-expression)
228 (let ((mysql-ptr (database-mysql-ptr database)))
229 (declare (type mysql-mysql-ptr-def mysql-ptr))
230 (if (zerop (mysql-query mysql-ptr query-native))
231 (let ((res-ptr (if full-set
232 (mysql-store-result mysql-ptr)
233 (mysql-use-result mysql-ptr))))
234 (declare (type mysql-mysql-res-ptr-def res-ptr))
235 (if (not (uffi:null-pointer-p res-ptr))
236 (let* ((num-fields (mysql-num-fields res-ptr))
237 (result-set (make-mysql-result-set
239 :num-fields num-fields
242 (canonicalize-field-types
243 field-types num-fields
248 (mysql-num-rows res-ptr))
251 (error 'clsql-sql-error
253 :expression query-expression
254 :errno (mysql-errno mysql-ptr)
255 :error (mysql-error-string mysql-ptr))))
256 (error 'clsql-sql-error
258 :expression query-expression
259 :errno (mysql-errno mysql-ptr)
260 :error (mysql-error-string mysql-ptr))))))
262 (defmethod database-dump-result-set (result-set (database mysql-database))
263 (mysql-free-result (mysql-result-set-res-ptr result-set))
268 (defmethod database-store-next-row (result-set (database mysql-database) list)
269 (let* ((res-ptr (mysql-result-set-res-ptr result-set))
270 (row (mysql-fetch-row res-ptr))
271 (field-types (mysql-result-set-field-types result-set)))
272 (declare (type mysql-mysql-res-ptr-def res-ptr)
273 (type mysql-row-def row))
274 (unless (uffi:null-pointer-p row)
275 (loop for i from 0 below (mysql-result-set-num-fields result-set)
280 (uffi:deref-array row 'mysql-row i)