db-mysql/mysql-sql.lisp

   1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
   2 ;;;; *************************************************************************
   3 ;;;; FILE IDENTIFICATION
   4 ;;;;
   5 ;;;; Name:          mysql-sql.lisp
   6 ;;;; Purpose:       High-level MySQL interface using UFFI
   7 ;;;; Date Started:  Feb 2002
   8 ;;;;
   9 ;;;; This file, part of CLSQL, is Copyright (c) 2002-2010 by Kevin M. Rosenberg
  10 ;;;;
  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 ;;;; *************************************************************************
  15
  16 (defpackage #:clsql-mysql
  17     (:use #:common-lisp #:clsql-sys #:mysql #:clsql-uffi)
  18     (:export #:mysql-database)
  19     (:documentation "This is the CLSQL interface to MySQL."))
  20
  21 (in-package #:clsql-mysql)
  22
  23 ;;; Field conversion functions
  24
  25 (defun result-field-names (res-ptr)
  26   (let ((names '()))
  27     (mysql-field-seek res-ptr 0)
  28     (loop
  29        (let ((field (mysql-fetch-field res-ptr)))
  30          (when (uffi:null-pointer-p field) (return))
  31          (push (uffi:convert-from-cstring (clsql-mysql-field-name field)) names)))
  32     (nreverse names)))
  33
  34 (defun make-type-list-for-auto (res-ptr)
  35   (let ((new-types '()))
  36     (mysql-field-seek res-ptr 0)
  37     (loop
  38        (let ((field (mysql-fetch-field res-ptr)))
  39          (when (uffi:null-pointer-p field) (return))
  40          (let* ((flags (clsql-mysql-field-flags field))
  41                 (unsigned (plusp (logand flags 32)))
  42                 (type (clsql-mysql-field-type field)))
  43            (push
  44             (case type
  45               ((#.mysql-field-types#tiny
  46                 #.mysql-field-types#short
  47                 #.mysql-field-types#int24)
  48                (if unsigned
  49                    :uint32
  50                    :int32))
  51               (#.mysql-field-types#long
  52                (if unsigned
  53                    :uint
  54                    :int))
  55               (#.mysql-field-types#longlong
  56                (if unsigned
  57                    :uint64
  58                    :int64))
  59               ((#.mysql-field-types#double
  60                 #.mysql-field-types#float
  61                 #.mysql-field-types#decimal)
  62                :double)
  63               (otherwise
  64                t))
  65             new-types))))
  66     (nreverse new-types)))
  67
  68 (defun canonicalize-types (types res-ptr)
  69   (when types
  70     (let ((auto-list (make-type-list-for-auto res-ptr)))
  71       (cond
  72         ((listp types)
  73          (canonicalize-type-list types auto-list))
  74         ((eq types :auto)
  75          auto-list)
  76         (t
  77          nil)))))
  78
  79 (defmethod database-initialize-database-type ((database-type (eql :mysql)))
  80   t)
  81
  82 ;;(uffi:def-type mysql-mysql-ptr-def (* mysql-mysql))
  83 ;;(uffi:def-type mysql-mysql-res-ptr-def (* mysql-mysql-res))
  84 (uffi:def-type mysql-mysql-ptr-def mysql-mysql)
  85 (uffi:def-type mysql-mysql-res-ptr-def mysql-mysql-res)
  86 (uffi:def-type mysql-row-def mysql-row)
  87
  88 (defclass mysql-database (database)
  89   ((mysql-ptr :accessor database-mysql-ptr :initarg :mysql-ptr
  90               :type mysql-mysql-ptr-def)
  91    (server-info :accessor database-server-info :initarg :server-info
  92               :type string)))
  93
  94 (defmethod database-type ((database mysql-database))
  95   :mysql)
  96
  97 (defmethod database-name-from-spec (connection-spec (database-type (eql :mysql)))
  98   (check-connection-spec connection-spec database-type
  99                          (host db user password &optional port options))
 100   (destructuring-bind (host db user password &optional port options) connection-spec
 101     (declare (ignore password options))
 102     (concatenate 'string
 103                  (etypecase host
 104                    (null "localhost")
 105                    (pathname (namestring host))
 106                    (string host))
 107                  (if port
 108                      (concatenate 'string
 109                                   ":"
 110                                   (etypecase port
 111                                     (integer (write-to-string port))
 112                                     (string port)))
 113                      "")
 114                  "/" db "/" user)))
 115
 116 (defun lookup-option-code (option)
 117   (if (assoc option +mysql-option-parameter-map+)
 118       (symbol-value (intern
 119                      (concatenate 'string (symbol-name-default-case "mysql-option#")
 120                                   (symbol-name option))
 121                      (symbol-name '#:mysql)))
 122       (progn
 123         (warn "Unknown mysql option name ~A - ignoring.~%" option)
 124         nil)))
 125
 126 (defun set-mysql-options (mysql-ptr options)
 127   (flet ((lookup-option-type (option)
 128            (cdr (assoc option +mysql-option-parameter-map+))))
 129     (dolist (option options)
 130       (if (atom option)
 131           (let ((option-code (lookup-option-code option)))
 132             (when option-code
 133               (mysql-options mysql-ptr option-code uffi:+null-cstring-pointer+)))
 134           (destructuring-bind (name . value) option
 135             (let ((option-code (lookup-option-code name)))
 136               (when option-code
 137                 (case (lookup-option-type name)
 138                   (:none
 139                    (mysql-options mysql-ptr option-code uffi:+null-cstring-pointer+))
 140                   (:char-ptr
 141                    (if (stringp value)
 142                        (uffi:with-foreign-string (fs value)
 143                            (mysql-options mysql-ptr option-code fs))
 144                        (warn "Expecting string argument for mysql option ~A, got ~A ~
 145 - ignoring.~%"
 146                              name value)))
 147                   (:uint-ptr
 148                    (if (integerp value)
 149                        (uffi:with-foreign-object (fo :unsigned-int)
 150                          (setf (uffi:deref-pointer fo :unsigned-int) value)
 151                          (mysql-options mysql-ptr option-code fo))
 152                        (warn "Expecting integer argument for mysql option ~A, got ~A ~
 153 - ignoring.~%"
 154                              name value)))
 155                   (:boolean-ptr
 156                    (uffi:with-foreign-object (fo :byte)
 157                      (setf (uffi:deref-pointer fo :byte)
 158                            (if (or (zerop value) (null value))
 159                                0
 160                                1))
 161                      (mysql-options mysql-ptr option-code fo)))))))))))
 162
 163 (defmethod database-connect (connection-spec (database-type (eql :mysql)))
 164   (check-connection-spec connection-spec database-type
 165                          (host db user password &optional port options))
 166   (destructuring-bind (host db user password &optional port options) connection-spec
 167     (let ((mysql-ptr (mysql-init (uffi:make-null-pointer 'mysql-mysql)))
 168           (socket nil))
 169       (if (uffi:null-pointer-p mysql-ptr)
 170           (error 'sql-connection-error
 171                  :database-type database-type
 172                  :connection-spec connection-spec
 173                  :error-id (mysql-errno mysql-ptr)
 174                  :message (mysql-error-string mysql-ptr))
 175         (uffi:with-cstrings ((host-native host)
 176                             (user-native user)
 177                             (password-native password)
 178                             (db-native db)
 179                             (socket-native socket))
 180           (when options
 181             (set-mysql-options mysql-ptr options))
 182           (let ((error-occurred nil))
 183             (unwind-protect
 184                 (if (uffi:null-pointer-p
 185                      (mysql-real-connect
 186                       mysql-ptr host-native user-native password-native
 187                       db-native
 188                       (etypecase port
 189                         (null 0)
 190                         (integer port)
 191                         (string (parse-integer port)))
 192                       socket-native 0))
 193                     (progn
 194                       (setq error-occurred t)
 195                       (error 'sql-connection-error
 196                              :database-type database-type
 197                              :connection-spec connection-spec
 198                              :error-id (mysql-errno mysql-ptr)
 199                              :message (mysql-error-string mysql-ptr)))
 200                     (let* ((db
 201                             (make-instance 'mysql-database
 202                                            :name (database-name-from-spec connection-spec
 203                                                                           database-type)
 204                                            :database-type :mysql
 205                                            :connection-spec connection-spec
 206                                            :server-info (uffi:convert-from-cstring
 207                                                          (mysql:mysql-get-server-info mysql-ptr))
 208                                            :mysql-ptr mysql-ptr))
 209                            (cmd "SET SESSION sql_mode='ANSI'"))
 210                       (uffi:with-cstring (cmd-cs cmd)
 211                         (if (zerop (mysql-real-query mysql-ptr cmd-cs (uffi:foreign-encoded-octet-count
 212                                                                        cmd :encoding (encoding db))))
 213                             db
 214                             (progn
 215                               (warn "Error setting ANSI mode for MySQL.")
 216                               db)))))
 217               (when error-occurred (mysql-close mysql-ptr)))))))))
 218
 219
 220 (defmethod database-disconnect ((database mysql-database))
 221   (mysql-close (database-mysql-ptr database))
 222   (setf (database-mysql-ptr database) nil)
 223   t)
 224
 225 (defmethod database-execute-command (sql-expression (database mysql-database))
 226   (uffi:with-cstring (sql-native sql-expression)
 227     (let ((mysql-ptr (database-mysql-ptr database)))
 228       (declare (type mysql-mysql-ptr-def mysql-ptr))
 229       (if (zerop (mysql-real-query mysql-ptr sql-native
 230                                    (uffi:foreign-encoded-octet-count
 231                                     sql-expression :encoding (encoding database))))
 232           t
 233         (error 'sql-database-data-error
 234                :database database
 235                :expression sql-expression
 236                :error-id (mysql-errno mysql-ptr)
 237                :message (mysql-error-string mysql-ptr))))))
 238
 239
 240 (defmethod database-query (query-expression (database mysql-database)
 241                            result-types field-names)
 242   (declare (optimize (speed 3) (safety 0) (debug 0) (space 0)))
 243   (let ((mysql-ptr (database-mysql-ptr database)))
 244     (declare (type mysql-mysql-ptr-def mysql-ptr))
 245     (when (database-execute-command query-expression database)
 246       (let ((res-ptr (mysql-use-result mysql-ptr)))
 247         (declare (type mysql-mysql-res-ptr-def res-ptr))
 248         (if (and res-ptr (not (uffi:null-pointer-p res-ptr)))
 249             (unwind-protect
 250                  (let ((num-fields (mysql-num-fields res-ptr)))
 251                    (declare (fixnum num-fields))
 252                    (setq result-types (canonicalize-types
 253                                        result-types res-ptr))
 254                    (values
 255                      (loop for row = (mysql-fetch-row res-ptr)
 256                            for lengths = (mysql-fetch-lengths res-ptr)
 257                            until (uffi:null-pointer-p row)
 258                            collect
 259                         (do* ((rlist (make-list num-fields))
 260                               (i 0 (1+ i))
 261                               (pos rlist (cdr pos)))
 262                             ((= i num-fields) rlist)
 263                           (declare (fixnum i))
 264                           (setf (car pos)
 265                                 (convert-raw-field
 266                                  (uffi:deref-array row '(:array
 267                                                          (* :unsigned-char))
 268                                                    i)
 269                                  (nth i result-types)
 270                                  :length
 271                                  (uffi:deref-array lengths '(:array :unsigned-long) i)
 272                                  :encoding (encoding database)))))
 273                      (when field-names
 274                        (result-field-names res-ptr))))
 275               (mysql-free-result res-ptr))
 276             (unless (zerop (mysql-errno mysql-ptr))
 277               ;;from http://dev.mysql.com/doc/refman/5.0/en/mysql-field-count.html
 278               ;; if mysql_use_result or mysql_store_result return a null ptr,
 279               ;; we use a mysql_errno check to see if it had a problem or just
 280               ;; was a query without a result. If no error, just return nil.
 281               (error 'sql-database-data-error
 282                      :database database
 283                      :expression query-expression
 284                      :error-id (mysql-errno mysql-ptr)
 285                      :message (mysql-error-string mysql-ptr))))))))
 286
 287
 288 (defstruct mysql-result-set
 289   (res-ptr (uffi:make-null-pointer 'mysql-mysql-res) :type mysql-mysql-res-ptr-def)
 290   (types nil :type list)
 291   (num-fields 0 :type fixnum)
 292   (full-set nil :type boolean))
 293
 294
 295 (defmethod database-query-result-set ((query-expression string)
 296                                       (database mysql-database)
 297                                       &key full-set result-types)
 298   (let ((mysql-ptr (database-mysql-ptr database)))
 299     (declare (type mysql-mysql-ptr-def mysql-ptr))
 300     (when (database-execute-command query-expression database)
 301       (let ((res-ptr (if full-set
 302                          (mysql-store-result mysql-ptr)
 303                          (mysql-use-result mysql-ptr))))
 304         (declare (type mysql-mysql-res-ptr-def res-ptr))
 305         (if (not (uffi:null-pointer-p res-ptr))
 306             (let* ((num-fields (mysql-num-fields res-ptr))
 307                    (result-set (make-mysql-result-set
 308                                 :res-ptr res-ptr
 309                                 :num-fields num-fields
 310                                 :full-set full-set
 311                                 :types
 312                                 (canonicalize-types
 313                                  result-types res-ptr))))
 314               (if full-set
 315                   (values result-set
 316                           num-fields
 317                           (mysql-num-rows res-ptr))
 318                   (values result-set
 319                           num-fields)))
 320             (error 'sql-database-data-error
 321                    :database database
 322                    :expression query-expression
 323                    :error-id (mysql-errno mysql-ptr)
 324                    :message (mysql-error-string mysql-ptr))))
 325       )))
 326
 327 (defmethod database-dump-result-set (result-set (database mysql-database))
 328   (mysql-free-result (mysql-result-set-res-ptr result-set))
 329   t)
 330
 331
 332 (defmethod database-store-next-row (result-set (database mysql-database) list)
 333   (let* ((res-ptr (mysql-result-set-res-ptr result-set))
 334          (row (mysql-fetch-row res-ptr))
 335          (lengths (mysql-fetch-lengths res-ptr))
 336          (types (mysql-result-set-types result-set)))
 337     (declare (type mysql-mysql-res-ptr-def res-ptr)
 338              (type mysql-row-def row))
 339     (unless (uffi:null-pointer-p row)
 340       (loop for i from 0 below (mysql-result-set-num-fields result-set)
 341             for rest on list
 342             do
 343             (setf (car rest)
 344                   (convert-raw-field
 345                    (uffi:deref-array row '(:array (* :unsigned-char)) i)
 346                    (nth i types)
 347                    :length
 348                    (uffi:deref-array lengths '(:array :unsigned-long) i)
 349                    :encoding (encoding database))))
 350       list)))
 351
 352
 353 ;; Table and attribute introspection
 354
 355 (defmethod database-list-tables ((database mysql-database) &key (owner nil))
 356   (declare (ignore owner))
 357   (cond
 358    ((eql #\5 (char (database-server-info database) 0))
 359     (loop for (name type) in (database-query "SHOW FULL TABLES" database nil nil)
 360           when (and (string-equal type "base table")
 361                     (not (and (>= (length name) 11)
 362                               (string-equal (subseq name 0 11) "_CLSQL_SEQ_"))))
 363           collect name))
 364    (t
 365     (remove-if #'(lambda (s)
 366                    (and (>= (length s) 11)
 367                         (string-equal (subseq s 0 11) "_CLSQL_SEQ_")))
 368                (mapcar #'car (database-query "SHOW TABLES" database nil nil))))))
 369
 370 (defmethod database-list-views ((database mysql-database)
 371                                 &key (owner nil))
 372   (declare (ignore owner))
 373   (cond
 374    ((eql #\5 (char (database-server-info database) 0))
 375     (loop for (name type) in (database-query "SHOW FULL TABLES" database nil nil)
 376           when (string-equal type "view")
 377           collect name))
 378      (t
 379       nil)))
 380
 381 (defmethod database-list-indexes ((database mysql-database)
 382                                   &key (owner nil))
 383   (let ((result '()))
 384     (dolist (table (database-list-tables database :owner owner) result)
 385       (setq result
 386         (append (database-list-table-indexes table database :owner owner)
 387                 result)))))
 388
 389 (defmethod database-list-table-indexes (table (database mysql-database)
 390                                         &key (owner nil))
 391   (declare (ignore owner))
 392   (do ((results nil)
 393        (rows (database-query
 394               (format nil "SHOW INDEX FROM ~A" table)
 395               database nil nil)
 396              (cdr rows)))
 397       ((null rows) (nreverse results))
 398     (let ((col (nth 2 (car rows))))
 399       (unless (find col results :test #'string-equal)
 400         (push col results)))))
 401
 402 (defmethod database-list-attributes ((table string) (database mysql-database)
 403                                      &key (owner nil))
 404   (declare (ignore owner))
 405   (mapcar #'car
 406           (database-query
 407            (format nil "SHOW COLUMNS FROM ~A" table)
 408            database nil nil)))
 409
 410 (defmethod database-attribute-type (attribute (table string)
 411                                     (database mysql-database)
 412                                     &key (owner nil))
 413   (declare (ignore owner))
 414   (let ((row (car (database-query
 415                    (format nil
 416                            "SHOW COLUMNS FROM ~A LIKE '~A'" table attribute)
 417                    database nil nil))))
 418     (let* ((raw-type (second row))
 419            (null (third row))
 420            (start-length (position #\( raw-type))
 421            (type (if start-length
 422                      (subseq raw-type 0 start-length)
 423                      raw-type))
 424            (length (when start-length
 425                      (parse-integer (subseq raw-type (1+ start-length))
 426                                     :junk-allowed t))))
 427       (when type
 428         (values (ensure-keyword type) length nil (if (string-equal null "YES") 1 0))))))
 429
 430 ;;; Sequence functions
 431
 432 (defun %sequence-name-to-table (sequence-name)
 433   (concatenate 'string "_CLSQL_SEQ_" (sql-escape sequence-name)))
 434
 435 (defun %table-name-to-sequence-name (table-name)
 436   (and (>= (length table-name) 11)
 437        (string-equal (subseq table-name 0 11) "_CLSQL_SEQ_")
 438        (subseq table-name 11)))
 439
 440 (defmethod database-create-sequence (sequence-name
 441                                      (database mysql-database))
 442   (let ((table-name (%sequence-name-to-table sequence-name)))
 443     (database-execute-command
 444      (concatenate 'string "CREATE TABLE " table-name
 445                   " (id int NOT NULL PRIMARY KEY AUTO_INCREMENT)")
 446      database)
 447     (database-execute-command
 448      (concatenate 'string "INSERT INTO " table-name
 449                   " VALUES (-1)")
 450      database)))
 451
 452 (defmethod database-drop-sequence (sequence-name
 453                                    (database mysql-database))
 454   (database-execute-command
 455    (concatenate 'string "DROP TABLE " (%sequence-name-to-table sequence-name))
 456    database))
 457
 458 (defmethod database-list-sequences ((database mysql-database)
 459                                     &key (owner nil))
 460   (declare (ignore owner))
 461   (mapcan #'(lambda (s)
 462               (let ((sn (%table-name-to-sequence-name (car s))))
 463                 (and sn (list sn))))
 464           (database-query "SHOW TABLES" database nil nil)))
 465
 466 (defmethod database-set-sequence-position (sequence-name
 467                                            (position integer)
 468                                            (database mysql-database))
 469   (database-execute-command
 470    (format nil "UPDATE ~A SET id=~A" (%sequence-name-to-table sequence-name)
 471            position)
 472    database)
 473   (mysql:mysql-insert-id (clsql-mysql::database-mysql-ptr database)))
 474
 475 (defmethod database-sequence-next (sequence-name (database mysql-database))
 476   (without-interrupts
 477    (database-execute-command
 478     (concatenate 'string "UPDATE " (%sequence-name-to-table sequence-name)
 479                  " SET id=LAST_INSERT_ID(id+1)")
 480     database)
 481    (mysql:mysql-insert-id (clsql-mysql::database-mysql-ptr database))))
 482
 483 (defmethod database-sequence-last (sequence-name (database mysql-database))
 484   (without-interrupts
 485     (caar (database-query
 486            (concatenate 'string "SELECT id from "
 487                         (%sequence-name-to-table sequence-name))
 488            database :auto nil))))
 489
 490 (defmethod database-last-auto-increment-id ((database mysql-database) table column)
 491   (declare (ignore table column))
 492   (car (query "SELECT LAST_INSERT_ID();"
 493              :flatp t :field-names nil
 494              :database database)))
 495
 496 (defmethod database-create (connection-spec (type (eql :mysql)))
 497   (destructuring-bind (host name user password) connection-spec
 498     (let ((database (database-connect (list host "" user password)
 499                                       type)))
 500       (setf (slot-value database 'clsql-sys::state) :open)
 501       (unwind-protect
 502            (database-execute-command (format nil "create database ~A" name) database)
 503         (database-disconnect database)))))
 504
 505 (defmethod database-destroy (connection-spec (type (eql :mysql)))
 506   (destructuring-bind (host name user password) connection-spec
 507     (let ((database (database-connect (list host "" user password)
 508                                       type)))
 509       (setf (slot-value database 'clsql-sys::state) :open)
 510       (unwind-protect
 511           (database-execute-command (format nil "drop database ~A" name) database)
 512         (database-disconnect database)))))
 513
 514 (defmethod database-probe (connection-spec (type (eql :mysql)))
 515   (when (find (second connection-spec) (database-list connection-spec type)
 516               :test #'string-equal)
 517     t))
 518
 519 (defmethod database-list (connection-spec (type (eql :mysql)))
 520   (destructuring-bind (host name user password &optional port options) connection-spec
 521     (declare (ignore options))
 522     (let ((database (database-connect (list host (or name "mysql")
 523                                             user password port) type)))
 524       (unwind-protect
 525            (progn
 526              (setf (slot-value database 'clsql-sys::state) :open)
 527              (mapcar #'car (database-query "show databases" database :auto nil)))
 528         (progn
 529           (database-disconnect database)
 530           (setf (slot-value database 'clsql-sys::state) :closed))))))
 531
 532
 533 ;;; Prepared statements
 534
 535 (defclass mysql-stmt ()
 536   ((database :initarg :database :reader database)
 537    (stmt :initarg :stmt :accessor stmt)
 538    (input-bind :initarg :input-bind :reader input-bind)
 539    (output-bind :initarg :output-bind :reader output-bind)
 540    (types :initarg :types :reader types)
 541    (result-set :initarg :result-set :reader result-set)
 542    (num-fields :initarg :num-fields :reader num-fields)
 543    (field-names :initarg :field-names :accessor stmt-field-names)
 544    (length-ptr :initarg :length-ptr :reader length-ptr)
 545    (is-null-ptr :initarg :is-null-ptr :reader is-null-ptr)
 546    (result-types :initarg :result-types :reader result-types)))
 547
 548 (defun clsql-type->mysql-type (type)
 549   (cond
 550     ((in type :null) mysql-field-types#null)
 551     ((in type :int :integer) mysql-field-types#long)
 552     ((in type :short) mysql-field-types#short)
 553     ((in type :bigint) mysql-field-types#longlong)
 554     ((in type :float :double :number) mysql-field-types#double)
 555     ((and (consp type) (in (car type) :char :string :varchar)) mysql-field-types#var-string)
 556     ((or (eq type :blob) (and (consp type) (in (car type) :blob))) mysql-field-types#var-string)
 557     (t
 558        (error 'sql-user-error
 559               :message
 560               (format nil "Unknown clsql type ~A." type)))))
 561
 562 #+mysql-client-v4.1
 563 (defmethod database-prepare (sql-stmt types (database mysql-database) result-types field-names)
 564   (let* ((mysql-ptr (database-mysql-ptr database))
 565          (stmt (mysql-stmt-init mysql-ptr)))
 566     (when (uffi:null-pointer-p stmt)
 567       (error 'sql-database-error
 568              :error-id (mysql-errno mysql-ptr)
 569              :message (mysql-error-string mysql-ptr)))
 570
 571     (uffi:with-cstring (native-query sql-stmt)
 572       (unless (zerop (mysql-stmt-prepare stmt native-query (uffi:foreign-encoded-octet-count
 573                                                             sql-stmt :encoding (encoding database))))
 574         (mysql-stmt-close stmt)
 575         (error 'sql-database-error
 576                :error-id (mysql-errno mysql-ptr)
 577                :message (mysql-error-string mysql-ptr))))
 578
 579     (unless (= (mysql-stmt-param-count stmt) (length types))
 580       (mysql-stmt-close stmt)
 581       (error 'sql-database-error
 582              :message
 583              (format nil "Mysql param count (~D) does not match number of types (~D)"
 584                      (mysql-stmt-param-count stmt) (length types))))
 585
 586     (let ((rs (mysql-stmt-result-metadata stmt)))
 587       (when (uffi:null-pointer-p rs)
 588         (warn "mysql_stmt_result_metadata returned NULL")
 589         #+nil
 590         (mysql-stmt-close stmt)
 591         #+nil
 592         (error 'sql-database-error
 593                :message "mysql_stmt_result_metadata returned NULL"))
 594
 595       (let ((input-bind (uffi:allocate-foreign-object 'mysql-bind (length types)))
 596             (mysql-types (mapcar 'clsql-type->mysql-type types))
 597             field-vec num-fields is-null-ptr output-bind length-ptr)
 598
 599         (print 'a)
 600         (dotimes (i (length types))
 601           (let* ((binding (uffi:deref-array input-bind '(:array mysql-bind) i)))
 602             (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer-type)
 603               (nth i mysql-types))
 604             (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer-length) 0)))
 605
 606         (print 'b)
 607         (unless (uffi:null-pointer-p rs)
 608           (setq field-vec (mysql-fetch-fields rs)
 609                 num-fields (mysql-num-fields rs)
 610                 is-null-ptr (uffi:allocate-foreign-object :byte num-fields)
 611                 output-bind (uffi:allocate-foreign-object 'mysql-bind num-fields)
 612                 length-ptr (uffi:allocate-foreign-object :unsigned-long num-fields))
 613           (dotimes (i num-fields)
 614             (declare (fixnum i))
 615             (let* ((field (uffi:deref-array field-vec '(:array mysql-field) i))
 616                    (type (uffi:get-slot-value field 'mysql-field 'type))
 617                    (binding (uffi:deref-array output-bind '(:array mysql-bind) i)))
 618               (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer-type) type)
 619
 620               (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer-length) 0)
 621               #+need-to-allocate-foreign-object-for-this
 622               (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::is-null)
 623                 (+ i (uffi:pointer-address is-null-ptr)))
 624               #+need-to-allocate-foreign-object-for-this
 625               (setf (uffi:get-slot-value binding 'mysql-bind 'length)
 626                 (+ (* i 8) (uffi:pointer-address length-ptr)))
 627
 628               (case type
 629                 ((#.mysql-field-types#var-string #.mysql-field-types#string
 630                   #.mysql-field-types#tiny-blob #.mysql-field-types#blob
 631                   #.mysql-field-types#medium-blob #.mysql-field-types#long-blob)
 632                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer-length) 1024)
 633                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
 634                    (uffi:allocate-foreign-object :unsigned-char 1024)))
 635                 (#.mysql-field-types#tiny
 636                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
 637                    (uffi:allocate-foreign-object :byte)))
 638                 (#.mysql-field-types#short
 639                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
 640                    (uffi:allocate-foreign-object :short)))
 641                 (#.mysql-field-types#long
 642                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
 643                    ;; segfaults if supply :int on amd64
 644                    (uffi:allocate-foreign-object :long)))
 645                 #+64bit
 646                 (#.mysql-field-types#longlong
 647                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
 648                    (uffi:allocate-foreign-object :long)))
 649                 (#.mysql-field-types#float
 650                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
 651                    (uffi:allocate-foreign-object :float)))
 652                 (#.mysql-field-types#double
 653                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
 654                    (uffi:allocate-foreign-object :double)))
 655                 ((#.mysql-field-types#time #.mysql-field-types#date
 656                   #.mysql-field-types#datetime #.mysql-field-types#timestamp)
 657                  (uffi:allocate-foreign-object 'mysql-time))
 658                 (t
 659                  (error "mysql type ~D not supported." type)))))
 660
 661           (unless (zerop (mysql-stmt-bind-result stmt output-bind))
 662             (mysql-stmt-close stmt)
 663             (error 'sql-database-error
 664                    :error-id (mysql-stmt-errno stmt)
 665                    :message  (uffi:convert-from-cstring
 666                               (mysql-stmt-error stmt)))))
 667
 668         (make-instance 'mysql-stmt
 669           :database database
 670           :stmt stmt
 671           :num-fields num-fields
 672           :input-bind input-bind
 673           :output-bind output-bind
 674           :result-set rs
 675           :result-types result-types
 676           :length-ptr length-ptr
 677           :is-null-ptr is-null-ptr
 678           :types mysql-types
 679           :field-names field-names)))))
 680
 681 #+mysql-client-v4.1
 682 (defmethod database-bind-parameter ((stmt mysql-stmt) position value)
 683   ;; FIXME: will need to allocate bind structure. This should probably be
 684   ;; done in C since the API is not mature and may change
 685   (let ((binding (uffi:deref-array (input-bind stmt) '(:array mysql-bind) (1- position)))
 686         (type (nth (1- position) (types stmt))))
 687     (setf (uffi:get-slot-value binding 'mysql-bind 'length) 0)
 688     (cond
 689      ((null value)
 690       (when (is-null-ptr stmt)
 691         (setf (uffi:deref-array (is-null-ptr stmt) '(:array :byte) (1- position)) 1)))
 692      (t
 693       (when (is-null-ptr stmt)
 694         (setf (uffi:deref-array (is-null-ptr stmt) '(:array :byte) (1- position)) 0))
 695       (case type
 696         (#.mysql-field-types#long
 697          (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer) value))
 698         (t
 699          (warn "Unknown input bind type ~D." type))
 700         )))))
 701
 702 #+mysql-client-v4.1
 703 (defmethod database-run-prepared ((stmt mysql-stmt))
 704   (print 'a1)
 705   (when (input-bind stmt)
 706     (unless (zerop (mysql-stmt-bind-param (stmt stmt) (input-bind stmt)))
 707       (error 'sql-database-error
 708              :error-id (mysql-stmt-errno (stmt stmt))
 709              :message  (uffi:convert-from-cstring
 710                         (mysql-stmt-error (stmt stmt))))))
 711   (print 'a2)
 712   (unless (zerop (mysql-stmt-execute (stmt stmt)))
 713     (error 'sql-database-error
 714            :error-id (mysql-stmt-errno (stmt stmt))
 715            :message  (uffi:convert-from-cstring
 716                       (mysql-stmt-error (stmt stmt)))))
 717   (print 'a3)
 718   (unless (zerop (mysql-stmt-store-result (stmt stmt)))
 719     (error 'sql-database-error
 720            :error-id (mysql-stmt-errno (stmt stmt))
 721            :message  (uffi:convert-from-cstring
 722                       (mysql-stmt-error (stmt stmt)))))
 723   (database-fetch-prepared-rows stmt))
 724
 725 #+mysql-client-v4.1
 726 (defun database-fetch-prepared-rows (stmt)
 727   (do ((rc (mysql-stmt-fetch (stmt stmt)) (mysql-stmt-fetch (stmt stmt)))
 728        (num-fields (num-fields stmt))
 729        (rows '()))
 730       ((not (zerop rc)) (nreverse rows))
 731     (push
 732      (loop for i from 0 below num-fields
 733            collect
 734            (let ((is-null
 735                   (not (zerop (uffi:ensure-char-integer
 736                                (uffi:deref-array (is-null-ptr stmt) '(:array :byte) i))))))
 737              (unless is-null
 738                (let* ((bind (uffi:deref-array (output-bind stmt) '(:array mysql-bind) i))
 739                       (type (uffi:get-slot-value bind 'mysql-bind 'mysql::buffer-type))
 740                       (buffer (uffi:get-slot-value bind 'mysql-bind 'mysql::buffer)))
 741                  (case type
 742                    ((#.mysql-field-types#var-string #.mysql-field-types#string
 743                      #.mysql-field-types#tiny-blob #.mysql-field-types#blob
 744                      #.mysql-field-types#medium-blob #.mysql-field-types#long-blob)
 745                     (uffi:convert-from-foreign-string buffer :encoding (encoding (database stmt))))
 746                    (#.mysql-field-types#tiny
 747                     (uffi:ensure-char-integer
 748                      (uffi:deref-pointer buffer :byte)))
 749                    (#.mysql-field-types#short
 750                     (uffi:deref-pointer buffer :short))
 751                    (#.mysql-field-types#long
 752                     (uffi:deref-pointer buffer :int))
 753                    #+64bit
 754                    (#.mysql-field-types#longlong
 755                      (uffi:deref-pointer buffer :long))
 756                    (#.mysql-field-types#float
 757                     (uffi:deref-pointer buffer :float))
 758                    (#.mysql-field-types#double
 759                     (uffi:deref-pointer buffer :double))
 760                    ((#.mysql-field-types#time #.mysql-field-types#date
 761                                               #.mysql-field-types#datetime #.mysql-field-types#timestamp)
 762                     (let ((year (uffi:get-slot-value buffer 'mysql-time 'mysql::year))
 763                           (month (uffi:get-slot-value buffer 'mysql-time 'mysql::month))
 764                           (day (uffi:get-slot-value buffer 'mysql-time 'mysql::day))
 765                           (hour (uffi:get-slot-value buffer 'mysql-time 'mysql::hour))
 766                           (minute (uffi:get-slot-value buffer 'mysql-time 'mysql::minute))
 767                           (second (uffi:get-slot-value buffer 'mysql-time 'mysql::second)))
 768                       (db-timestring
 769                        (make-time :year year :month month :day day :hour hour
 770                                   :minute minute :second second))))
 771                    (t
 772                     (list type)))))))
 773      rows)))
 774
 775
 776
 777
 778 #+mysql-client-v4.1
 779 (defmethod database-free-prepared ((stmt mysql-stmt))
 780   (with-slots (stmt) stmt
 781     (mysql-stmt-close stmt))
 782   )
 783
 784
 785 ;;; Database capabilities
 786
 787 (defmethod db-type-use-column-on-drop-index? ((db-type (eql :mysql)))
 788   t)
 789
 790 (defmethod db-type-has-views? ((db-type (eql :mysql)))
 791   #+mysql-client-v5 t
 792   #-mysql-client-v5 nil)
 793
 794 (defmethod db-type-has-subqueries? ((db-type (eql :mysql)))
 795   #+(or mysql-client-v4.1 mysql-client-v5) t
 796   #-(or mysql-client-v4.1 mysql-client-v5) nil)
 797
 798 (defmethod db-type-has-boolean-where? ((db-type (eql :mysql)))
 799   #+(or mysql-client-v4.1 mysql-client-v5) t
 800   #-(or mysql-client-v4.1 mysql-client-v5) nil)
 801
 802 (defmethod db-type-has-union? ((db-type (eql :mysql)))
 803   (not (eql (schar mysql::*mysql-client-info* 0) #\3)))
 804
 805 (defmethod db-type-transaction-capable? ((db-type (eql :mysql)) database)
 806   (let ((tuple (car (database-query "SHOW VARIABLES LIKE 'HAVE_INNODB'" database :auto nil))))
 807     (and tuple (string-equal "YES" (second tuple)))))
 808
 809 (defmethod db-type-has-prepared-stmt? ((db-type (eql :mysql)))
 810   #+(or mysql-client-v4.1 mysql-client-v5) t
 811   #-(or mysql-client-v4.1 mysql-client-v5) nil)
 812
 813 (defmethod db-type-has-auto-increment? ((db-type (eql :mysql)))
 814   t)
 815
 816 (when (clsql-sys:database-type-library-loaded :mysql)
 817   (clsql-sys:initialize-database-type :database-type :mysql))