;;;; *************************************************************************
;;;; FILE IDENTIFICATION
;;;;
-;;;; Name: mysql-sql.cl
+;;;; Name: mysql-sql.lisp
;;;; Purpose: High-level MySQL interface using UFFI
-;;;; Programmers: Kevin M. Rosenberg based on
-;;;; Original code by Pierre R. Mai
;;;; Date Started: Feb 2002
;;;;
-;;;; $Id: mysql-sql.lisp,v 1.3 2002/10/14 07:10:19 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)))
-
-;;;; Modified by Kevin Rosenberg, Feb 20002
-;;;; -- Added support for Allegro CL and Lispworks using UFFI layer
-;;;; -- Changed database-connect to use mysql-real-connect. This way,
-;;;; can avoid using double (unwind-protect)
-;;;; -- Changed database-connect to have MySQL library allocate space
-;;;; for MYSQL structure. This will make the code more robust in
-;;;; the event that MySQL library changes the size of the mysql-mysql
-;;;; structure.
-;;;;
-;;;; Mar 2002
-;;;; Added field types
-
-(defpackage :clsql-mysql
- (:use #:common-lisp #:clsql-base-sys #:mysql #:clsql-uffi)
+(defpackage #:clsql-mysql
+ (:use #:common-lisp #:clsql-sys #:mysql #:clsql-uffi)
(:export #:mysql-database)
(:documentation "This is the CLSQL interface to MySQL."))
-(in-package :clsql-mysql)
+(in-package #:clsql-mysql)
;;; Field conversion functions
+(defun result-field-names (num-fields res-ptr)
+ (declare (fixnum num-fields))
+ (let ((names '())
+ (field-vec (mysql-fetch-fields res-ptr)))
+ (dotimes (i num-fields)
+ (declare (fixnum i))
+ (let* ((field (uffi:deref-array field-vec '(:array mysql-field) i))
+ (name (uffi:convert-from-foreign-string
+ (uffi:get-slot-value field 'mysql-field 'mysql::name))))
+ (push name names)))
+ (nreverse names)))
+
(defun make-type-list-for-auto (num-fields res-ptr)
+ (declare (fixnum num-fields))
(let ((new-types '())
- #+ignore (field-vec (mysql-fetch-fields res-ptr)))
+ (field-vec (mysql-fetch-fields res-ptr)))
(dotimes (i num-fields)
(declare (fixnum i))
- (let* ( (field (mysql-fetch-field-direct res-ptr i))
- #+ignore (field (uffi:deref-array field-vec '(:array mysql-field) i))
+ (let* ((field (uffi:deref-array field-vec '(:array mysql-field) i))
(type (uffi:get-slot-value field 'mysql-field 'type)))
(push
(case type
(nreverse new-types)))
(defun canonicalize-types (types num-fields res-ptr)
- (if (null types)
- nil
- (let ((auto-list (make-type-list-for-auto num-fields res-ptr)))
- (cond
- ((listp types)
- (canonicalize-type-list types auto-list))
- ((eq types :auto)
- auto-list)
- (t
- nil)))))
+ (when types
+ (let ((auto-list (make-type-list-for-auto num-fields res-ptr)))
+ (cond
+ ((listp types)
+ (canonicalize-type-list types auto-list))
+ ((eq types :auto)
+ auto-list)
+ (t
+ nil)))))
(defmethod database-initialize-database-type ((database-type (eql :mysql)))
t)
(check-connection-spec connection-spec database-type (host db user password))
(destructuring-bind (host db user password) connection-spec
(declare (ignore password))
- (concatenate 'string host "/" db "/" user)))
+ (concatenate 'string
+ (if host host "localhost")
+ "/" db "/" user)))
(defmethod database-connect (connection-spec (database-type (eql :mysql)))
(check-connection-spec connection-spec database-type (host db user password))
(make-instance 'mysql-database
:name (database-name-from-spec connection-spec
database-type)
+ :database-type :mysql
:connection-spec connection-spec
:mysql-ptr mysql-ptr))
(when error-occurred (mysql-close mysql-ptr)))))))))
(defmethod database-query (query-expression (database mysql-database)
- types)
- (with-slots (mysql-ptr) database
+ result-types field-names)
+ (declare (optimize (speed 3) (safety 0) (debug 0) (space 0)))
+ (let ((mysql-ptr (database-mysql-ptr database)))
(uffi:with-cstring (query-native query-expression)
- (if (zerop (mysql-query mysql-ptr query-native))
- (let ((res-ptr (mysql-use-result mysql-ptr)))
- (if res-ptr
- (let ((num-fields (mysql-num-fields res-ptr)))
- (setq types (canonicalize-types
- types num-fields
- res-ptr))
- (unwind-protect
- (loop for row = (mysql-fetch-row res-ptr)
- until (uffi:null-pointer-p row)
- collect
- (loop for i from 0 below num-fields
- collect
- (convert-raw-field
- (uffi:deref-array row '(:array (* :unsigned-char)) i)
- types i)))
- (mysql-free-result res-ptr)))
- (error 'clsql-sql-error
- :database database
- :expression query-expression
- :errno (mysql-errno mysql-ptr)
- :error (mysql-error-string mysql-ptr))))
- (error 'clsql-sql-error
- :database database
- :expression query-expression
- :errno (mysql-errno mysql-ptr)
- :error (mysql-error-string mysql-ptr))))))
+ (if (zerop (mysql-real-query mysql-ptr query-native
+ (length query-expression)))
+ (let ((res-ptr (mysql-use-result mysql-ptr)))
+ (if res-ptr
+ (unwind-protect
+ (let ((num-fields (mysql-num-fields res-ptr)))
+ (declare (fixnum num-fields))
+ (setq result-types (canonicalize-types
+ result-types num-fields
+ res-ptr))
+ (values
+ (loop for row = (mysql-fetch-row res-ptr)
+ for lengths = (mysql-fetch-lengths res-ptr)
+ until (uffi:null-pointer-p row)
+ collect
+ (do* ((rlist (make-list num-fields))
+ (i 0 (1+ i))
+ (pos rlist (cdr pos)))
+ ((= i num-fields) rlist)
+ (declare (fixnum i))
+ (setf (car pos)
+ (convert-raw-field
+ (uffi:deref-array row '(:array
+ (* :unsigned-char))
+ i)
+ result-types i
+ (uffi:deref-array lengths '(:array :unsigned-long)
+ i)))))
+ (when field-names
+ (result-field-names num-fields res-ptr))))
+ (mysql-free-result res-ptr))
+ (error 'clsql-sql-error
+ :database database
+ :expression query-expression
+ :errno (mysql-errno mysql-ptr)
+ :error (mysql-error-string mysql-ptr))))
+ (error 'clsql-sql-error
+ :database database
+ :expression query-expression
+ :errno (mysql-errno mysql-ptr)
+ :error (mysql-error-string mysql-ptr))))))
(defmethod database-execute-command (sql-expression (database mysql-database))
(uffi:with-cstring (sql-native sql-expression)
(let ((mysql-ptr (database-mysql-ptr database)))
(declare (type mysql-mysql-ptr-def mysql-ptr))
- (if (zerop (mysql-query mysql-ptr sql-native))
+ (if (zerop (mysql-real-query mysql-ptr sql-native
+ (length sql-expression)))
t
(error 'clsql-sql-error
:database database
(full-set nil :type boolean))
-(defmethod database-query-result-set (query-expression
+(defmethod database-query-result-set ((query-expression string)
(database mysql-database)
- &key full-set types)
+ &key full-set result-types)
(uffi:with-cstring (query-native query-expression)
(let ((mysql-ptr (database-mysql-ptr database)))
(declare (type mysql-mysql-ptr-def mysql-ptr))
- (if (zerop (mysql-query mysql-ptr query-native))
+ (if (zerop (mysql-real-query mysql-ptr query-native
+ (length query-expression)))
(let ((res-ptr (if full-set
(mysql-store-result mysql-ptr)
(mysql-use-result mysql-ptr))))
:full-set full-set
:types
(canonicalize-types
- types num-fields
+ result-types num-fields
res-ptr))))
(if full-set
(values result-set
(defmethod database-store-next-row (result-set (database mysql-database) list)
(let* ((res-ptr (mysql-result-set-res-ptr result-set))
(row (mysql-fetch-row res-ptr))
+ (lengths (mysql-fetch-lengths res-ptr))
(types (mysql-result-set-types result-set)))
(declare (type mysql-mysql-res-ptr-def res-ptr)
(type mysql-row-def row))
(convert-raw-field
(uffi:deref-array row '(:array (* :unsigned-char)) i)
types
- i)))
+ i
+ (uffi:deref-array lengths '(:array :unsigned-long) i))))
list)))
-(when (clsql-base-sys:database-type-library-loaded :mysql)
- (clsql-base-sys:initialize-database-type :database-type :mysql)
- (pushnew :mysql cl:*features*))
+;; Table and attribute introspection
+
+(defmethod database-list-tables ((database mysql-database) &key (owner nil))
+ (declare (ignore owner))
+ (remove-if #'(lambda (s)
+ (and (>= (length s) 11)
+ (string-equal (subseq s 0 11) "_CLSQL_SEQ_")))
+ (mapcar #'car (database-query "SHOW TABLES" database nil nil))))
+
+;; MySQL 4.1 does not support views
+(defmethod database-list-views ((database mysql-database)
+ &key (owner nil))
+ (declare (ignore owner))
+ nil)
+
+(defmethod database-list-indexes ((database mysql-database)
+ &key (owner nil))
+ (let ((result '()))
+ (dolist (table (database-list-tables database :owner owner) result)
+ (setq result
+ (append (database-list-table-indexes table database :owner owner)
+ result)))))
+
+(defmethod database-list-table-indexes (table (database mysql-database)
+ &key (owner nil))
+ (declare (ignore owner))
+ (do ((results nil)
+ (rows (database-query
+ (format nil "SHOW INDEX FROM ~A" (string-upcase table))
+ database nil nil)
+ (cdr rows)))
+ ((null rows) (nreverse results))
+ (let ((col (nth 2 (car rows))))
+ (unless (find col results :test #'string-equal)
+ (push col results)))))
+
+(defmethod database-list-attributes ((table string) (database mysql-database)
+ &key (owner nil))
+ (declare (ignore owner))
+ (mapcar #'car
+ (database-query
+ (format nil "SHOW COLUMNS FROM ~A" table)
+ database nil nil)))
+
+(defmethod database-attribute-type (attribute (table string)
+ (database mysql-database)
+ &key (owner nil))
+ (declare (ignore owner))
+ (let ((row (car (database-query
+ (format nil
+ "SHOW COLUMNS FROM ~A LIKE '~A'" table attribute)
+ database nil nil))))
+ (let* ((raw-type (second row))
+ (null (third row))
+ (start-length (position #\( raw-type))
+ (type (if start-length
+ (subseq raw-type 0 start-length)
+ raw-type))
+ (length (when start-length
+ (parse-integer (subseq raw-type (1+ start-length))
+ :junk-allowed t))))
+ (when type
+ (values (ensure-keyword type) length nil (if (string-equal null "YES") 1 0))))))
+
+;;; Sequence functions
+
+(defun %sequence-name-to-table (sequence-name)
+ (concatenate 'string "_CLSQL_SEQ_" (sql-escape sequence-name)))
+
+(defun %table-name-to-sequence-name (table-name)
+ (and (>= (length table-name) 11)
+ (string-equal (subseq table-name 0 11) "_CLSQL_SEQ_")
+ (subseq table-name 11)))
+
+(defmethod database-create-sequence (sequence-name
+ (database mysql-database))
+ (let ((table-name (%sequence-name-to-table sequence-name)))
+ (database-execute-command
+ (concatenate 'string "CREATE TABLE " table-name
+ " (id int NOT NULL PRIMARY KEY AUTO_INCREMENT)")
+ database)
+ (database-execute-command
+ (concatenate 'string "INSERT INTO " table-name
+ " VALUES (-1)")
+ database)))
+
+(defmethod database-drop-sequence (sequence-name
+ (database mysql-database))
+ (database-execute-command
+ (concatenate 'string "DROP TABLE " (%sequence-name-to-table sequence-name))
+ database))
+
+(defmethod database-list-sequences ((database mysql-database)
+ &key (owner nil))
+ (declare (ignore owner))
+ (mapcan #'(lambda (s)
+ (let ((sn (%table-name-to-sequence-name (car s))))
+ (and sn (list sn))))
+ (database-query "SHOW TABLES" database nil nil)))
+
+(defmethod database-set-sequence-position (sequence-name
+ (position integer)
+ (database mysql-database))
+ (database-execute-command
+ (format nil "UPDATE ~A SET id=~A" (%sequence-name-to-table sequence-name)
+ position)
+ database)
+ (mysql:mysql-insert-id (clsql-mysql::database-mysql-ptr database)))
+
+(defmethod database-sequence-next (sequence-name (database mysql-database))
+ (without-interrupts
+ (database-execute-command
+ (concatenate 'string "UPDATE " (%sequence-name-to-table sequence-name)
+ " SET id=LAST_INSERT_ID(id+1)")
+ database)
+ (mysql:mysql-insert-id (clsql-mysql::database-mysql-ptr database))))
+
+(defmethod database-sequence-last (sequence-name (database mysql-database))
+ (declare (ignore sequence-name)))
+
+(defmethod database-create (connection-spec (type (eql :mysql)))
+ (destructuring-bind (host name user password) connection-spec
+ (multiple-value-bind (output status)
+ (clsql-sys:command-output "mysqladmin create -u~A -p~A -h~A ~A"
+ user password
+ (if host host "localhost")
+ name)
+ (if (or (not (eql 0 status))
+ (and (search "failed" output) (search "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 :mysql)))
+ (destructuring-bind (host name user password) connection-spec
+ (multiple-value-bind (output status)
+ (clsql-sys:command-output "mysqladmin drop -f -u~A -p~A -h~A ~A"
+ user password
+ (if host host "localhost")
+ name)
+ (if (or (not (eql 0 status))
+ (and (search "failed" output) (search "error" output)))
+ (error 'clsql-access-error
+ :connection-spec connection-spec
+ :database-type type
+ :error
+ (format nil "database-destroy failed: ~A" output))
+ t))))
+
+(defmethod database-probe (connection-spec (type (eql :mysql)))
+ (when (find (second connection-spec) (database-list connection-spec type)
+ :key #'car :test #'string-equal)
+ t))
+
+(defmethod database-list (connection-spec (type (eql :mysql)))
+ (destructuring-bind (host name user password) connection-spec
+ (declare (ignore name))
+ (let ((database (database-connect (list host "mysql" user password) type)))
+ (unwind-protect
+ (progn
+ (setf (slot-value database 'clsql-sys::state) :open)
+ (mapcar #'car (database-query "show databases" database :auto nil)))
+ (progn
+ (database-disconnect database)
+ (setf (slot-value database 'clsql-sys::state) :closed))))))
+
+;;; Database capabilities
+
+(defmethod db-type-use-column-on-drop-index? ((db-type (eql :mysql)))
+ t)
+
+(defmethod db-type-has-views? ((db-type (eql :mysql)))
+ ;; MySQL 4.1 will apparently have views, need to check *mysql-client-info*
+ nil)
+
+(defmethod db-type-has-subqueries? ((db-type (eql :mysql)))
+ ;; MySQL 4.1 will apparently have subqueries, need to check *mysql-client-info*
+ nil)
+
+(defmethod db-type-has-boolean-where? ((db-type (eql :mysql)))
+ nil)
+
+(defmethod db-type-transaction-capable? ((db-type (eql :mysql)) database)
+ (let ((tuple (car (database-query "SHOW VARIABLES LIKE 'HAVE_INNODB'" database :auto nil))))
+ (and tuple (string-equal "YES" (second tuple)))))
+
+(when (clsql-sys:database-type-library-loaded :mysql)
+ (clsql-sys:initialize-database-type :database-type :mysql))
+